Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Referencing #581

Merged
merged 2 commits into from
Feb 16, 2024
Merged

Referencing #581

merged 2 commits into from
Feb 16, 2024

Conversation

ljhwang
Copy link
Contributor

@ljhwang ljhwang commented Feb 14, 2024

This changes to the title of the section to Referencing to better describe the contents of this section. Two section headers were added for Citation and Data Availability.

Data Availability is patterned after the ASPECT project so hopefully no ASPECt'isms have cropped in.

Please feel free to modify.

Copy link

codecov bot commented Feb 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8fe8ca7) 93.55% compared to head (afa44df) 93.55%.
Report is 4 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #581   +/-   ##
=======================================
  Coverage   93.55%   93.55%           
=======================================
  Files          92       92           
  Lines        6346     6346           
=======================================
  Hits         5937     5937           
  Misses        409      409           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8fe8ca7...afa44df. Read the comment docs.

Copy link

Benchmark Main Feature Difference (99.9% CI)
Slab interpolation simple none 1.024 ± 0.007 (s=432) 1.024 ± 0.005 (s=450) -0.2% .. +0.1%
Slab interpolation curved simple none 1.032 ± 0.004 (s=447) 1.035 ± 0.003 (s=426) +0.2% .. +0.3%
Spherical slab interpolation simple none 1.265 ± 0.005 (s=361) 1.265 ± 0.005 (s=353) -0.1% .. +0.1%
Slab interpolation simple curved CMS 1.099 ± 0.003 (s=406) 1.098 ± 0.003 (s=416) -0.1% .. +0.0%
Spherical slab interpolation simple CMS 1.863 ± 0.009 (s=240) 1.860 ± 0.004 (s=246) -0.3% .. -0.1%
Spherical fault interpolation simple none 1.275 ± 0.006 (s=373) 1.274 ± 0.004 (s=336) -0.1% .. +0.0%
Cartesian min max surface 2.378 ± 0.020 (s=179) 2.379 ± 0.016 (s=202) -0.3% .. +0.3%
Spherical min max surface 7.351 ± 0.021 (s=59) 7.356 ± 0.034 (s=66) -0.2% .. +0.3%

@@ -1,7 +1,8 @@
(part:user_manual:chap:introduction:sec:citing_the_world_builder)=
Citing the World Builder
Referencing the World Builder
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you make the "===" line the same length?

## Data Availability
We strongly recommend making your data available for reproducibilty and replicability. Consider depositing your data e.g., code and .wb, in an approved repository, which will assign an identifier (e.g., a DOI) and enable citation of your data. For visualization of your model, we strongly recommend also including your grid (.grid), paraview state file (.pvsm), and image (e.g., .png) files. See [geodynamics.org software publishing guidance](https://geodynamics.org/software/software-bp/software-publishing).
Then add the following to your data availability statement:
```
Copy link
Contributor

@tjhei tjhei Feb 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be a code block? Wouldn't a block quote be more appropriate?

@tjhei
Copy link
Contributor

tjhei commented Feb 16, 2024

merging with Lorraine's promise to follow up with a PR to fix the two issues.

@tjhei tjhei merged commit 43ef04d into GeodynamicWorldBuilder:main Feb 16, 2024
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants