The Geodynamic World Builder

The Geodynamic World Builder: A planetary structure creator for the geosciences - Published in JOSS (2024)

https://github.com/geodynamicworldbuilder/worldbuilder

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 13 DOI reference(s) in README and JOSS metadata
  • Academic publication links
  • Committers with academic emails
    6 of 23 committers (26.1%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords from Contributors

mesh
Last synced: 6 months ago · JSON representation ·

Repository

World Builder: An initial conditions generator for geodynamic modeling

Basic Info
  • Host: GitHub
  • Owner: GeodynamicWorldBuilder
  • License: lgpl-2.1
  • Language: C++
  • Default Branch: main
  • Homepage:
  • Size: 19.8 MB
Statistics
  • Stars: 32
  • Watchers: 7
  • Forks: 42
  • Open Issues: 80
  • Releases: 7
Created over 7 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Authors

README.md

Contributors Documentation actions AppVeyor Build status Coverage Status codecov Matrix space Mastodon Follow

Geodynamic World Builder Logo

The Geodynamic World Builder (GWB)

What is the Geodynamic World Builder?

The Geodynamic World Builder (GWB) is an open source code library intended to set up initial conditions for computational geodynamic models and/or visualize complex 3d tectonic settings in both Cartesian and Spherical geometries. The inputs for the JSON-style parameter file are not mathematical, but rather a structured nested list describing tectonic features, e.g., a continental, an oceanic or a subducting plate. Each of these tectonic features can be assigned a specific temperature profile (e.g., plate model) or composition label (e.g., uniform). For each point in space, the GWB can return the composition and/or temperature. It is written in C++, but can be used in almost any language through its C and Fortran wrappers. Various examples of 2D and 3D subduction settings are presented.

For more information see the GWB site, see the automatically generated extensive online User Manual or the automatically generated code documentation.

Frequently Asked Questions (FAQ)

What are the minimum requirements to compile the library and tools?

Currently, GWB requires only a C++14 compiler and CMake version higher than 3.5 to compile the library tools. Note that for some optional features (such as certain wrappers and unity build) a higher version of CMake and other dependencies may be needed (e.g., a Fortran compiler to compile the Fortran wrapper).

What do I do when I have a question or want to request a feature?

If you have a question about the code and you can not find the answer easily in the documentation or the question is not already raised as an issue, please let us know by opening an issue on github. This is also the preferred method for asking for new features for GWB.

I found a mistake in the documentation or code, what should I do?

Please do not keep it to yourself and let us know. Others will also profit from mistakes being found and fixed. Even if it is just a typo in the documentation feel free to raise an issue or, even better, make a pull request to fix the issue.

Is there a way to ask a quick question or chat with the developers or other users?

We are now also experimenting with matrix chat (#gwb:matrix.org). Matrix is an open source distributed chat protocol (a description of how to communicate). The matrix is not limited to one client, but using the Element client is generally recommended. Element can be used as a desktop, mobile or web application. Since the main developer is already present on matrix, a special space has been created for the World Builder allowing the option for multiple rooms. You can join the main room here. This is the easiest way since you can just open it in your browser. If you want to join the whole space in any client, use this link: https://matrix.to/#/!vhukRUGUINnZOIutoQ:matrix.org.

Feel free to join!

How to cite?

The developers of the Geodynamic World Builder request that you cite the following publication:

Fraters, M., Billen, M., Gassmöller, R., Saxena, A., Heister, T., Li, H., Douglas, D., Dannberg J., Bangerth W. and Wang, Y.: The Geodynamic World Builder: A planetary structure creator for the geosciences, Journal of Open Source Software, https://doi.org/10.21105/joss.06671, 2024.

Fraters, M., Thieulot, C., van den Berg, A., and Spakman, W.: The Geodynamic World Builder: a solution for complex initial conditions in numerical modelling, Solid Earth, https://doi.org/10.5194/se-10-1785-2019, 2019.

And cite the specific version of the software used. The current release can be cited as:

Menno Fraters and others. August 2024. The Geodynamic World Builder v1.0.0. Zenodo. https://doi.org/10.5281/zenodo.13352667.

How can I follow the progress of this project?

There are multiple ways in which you can follow this project: 1. Watch the repository on github. This will give you an update of what is happening in the repository. This happens automatically and you can set it up to notify you for different kinds of events. 2. Follow the World Builder Mastodon account. This is a manually updated feed which updates when there are new releases or major new features merged into the main branch. More general news related to the project may also be posted. 3. Subscribe to the Mastodon RSS feed: https://social.mfraters.net/@world_builder.rss. This will show exactly the same information as the Mastodon account, but you can use any RSS reader. 4. Visit the World Builder website. Besides all kinds of useful information and links, it also contains a RSS feed viewer for the World Builder Mastodon account. 5. Join the main GWB Matrix chat room or the whole GWB Matrix space!

Developers of the GWB

The development of the Geodynamic World Builderis currently lead by Menno Fraters.

The following people currently serve as GWB developers -- people who have and are providing substantial technical contributions to the Geodynamic World Builder:

  • Juliane Dannberg (GEOMAR Helmholtz Centre for Ocean Research, Germany)
  • Daniel Douglas (New Mexico Tech, USA)
  • Menno Fraters (Geoforschungszentrum Potsdam, Germany)
  • Rene Gassmoeller (GEOMAR Helmholtz Centre for Ocean Research, Germany)
  • Timo Heister (Clemson University, USA)
  • Arushi Saxena (UC Davis, USA)

Owner

  • Name: GeodynamicWorldBuilder
  • Login: GeodynamicWorldBuilder
  • Kind: organization

JOSS Publication

The Geodynamic World Builder: A planetary structure creator for the geosciences
Published
September 04, 2024
Volume 9, Issue 101, Page 6671
Authors
Menno R. t. Fraters ORCID
GFZ German Research Centre for Geosciences, Potsdam, Germany
Magali I. Billen ORCID
UC Davis, USA
Rene Gassmöller ORCID
GEOMAR Helmholtz-Zentrum für Ozeanforschung, Kiel, Germany, Universiy of Florida, USA
Arushi Saxena ORCID
UC Davis, USA, Clemson University, USA
Timo Heister ORCID
Clemson University, USA
Haoyuan Li ORCID
UC Davis, USA
Daniel Douglas ORCID
New Mexico Tech, USA
Juliane Dannberg ORCID
GEOMAR Helmholtz-Zentrum für Ozeanforschung, Kiel, Germany, Universiy of Florida, USA
Wolfgang Bangerth ORCID
Colorado State University, USA
Yijun Wang ORCID
University of Oslo, Norway
Editor
Hauke Schulz ORCID
Tags
CPP Python Geodynamics Earth science Tectonics Seismology

Citation (CITATION)

@article{GWB_2024_JOSS,
title = {The Geodynamic World Builder: A planetary structure creator for the geosciences},
author = {Fraters, M. and Billen, M., and Gassmöller, R. and Saxena, A. and Heister, T. and Li, H., and Douglas, D., and Dannberg J., and Bangerth W. and Wang, Y.},
doi = {10.21105/joss.06671},
url = {https://doi.org/10.21105/joss.06671},
year = {2024},
publisher = {The Open Journal},
pages = {6671},
journal = {Journal of Open Source Software}
}

@Article{se-10-1785-2019,
AUTHOR = {Fraters, M. and Thieulot, C. and van den Berg, A. and Spakman, W.},
TITLE = {The Geodynamic World Builder: a solution for complex initial conditions in numerical modeling},
JOURNAL = {Solid Earth},
VOLUME = {10},
YEAR = {2019},
NUMBER = {5},
PAGES = {1785\-\-1807},
URL = {https://se.copernicus.org/articles/10/1785/2019/},
DOI = {10.5194/se-10-1785-2019}
}

@misc{gwb-doi-v1.0.0,
  title        = {{The Geodynamic World Builder} v1.0.0 [software]},
  author       = {Menno Fraters and
                  others},
  month        = aug,
  year         = 2024,
  DOI          = {10.5281/zenodo.13352667},
  URL          = {https://doi.org/10.5281/zenodo.13352667},
}

@misc{gwb-doi-v0.6.0,
  title        = {{The Geodynamic World Builder} v0.6.0 [software]},
  author       = {Menno Fraters and
                  others},
  month        = mar,
  year         = 2024,
  DOI          = {10.5281/zenodo.10794862},
  URL          = {https://doi.org/10.5281/zenodo.10794862},
}

@misc{gwb-doi-v0.5.0,
  title        = {{The Geodynamic World Builder} v0.5.0 [software]},
  author       = {Menno Fraters and
                  others},
  month        = jun,
  year         = 2023,
  DOI          = {10.5281/zenodo.7998525},
  URL          = {https://doi.org/10.5281/zenodo.7998525},
}

@misc{gwb-doi-v0.4.0,
  title        = {{The Geodynamic World Builder} v0.4.0 [software]},
  author       = {Menno Fraters and
                  others},
  month        = jun,
  year         = 2021,
  DOI          = {10.5281/zenodo.5014808},
  URL          = {https://doi.org/10.5281/zenodo.5014808},
}

GitHub Events

Total
  • Issues event: 24
  • Watch event: 7
  • Delete event: 9
  • Issue comment event: 81
  • Push event: 51
  • Pull request review comment event: 66
  • Pull request review event: 94
  • Pull request event: 113
  • Fork event: 11
  • Create event: 9
Last Year
  • Issues event: 24
  • Watch event: 7
  • Delete event: 9
  • Issue comment event: 81
  • Push event: 51
  • Pull request review comment event: 66
  • Pull request review event: 94
  • Pull request event: 113
  • Fork event: 11
  • Create event: 9

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 1,644
  • Total Committers: 23
  • Avg Commits per committer: 71.478
  • Development Distribution Score (DDS): 0.237
Past Year
  • Commits: 123
  • Committers: 14
  • Avg Commits per committer: 8.786
  • Development Distribution Score (DDS): 0.528
Top Committers
Name Email Commits
MFraters m****s@o****m 1,254
Lorraine Hwang l****g@u****u 62
Rene Gassmoeller r****r@m****g 50
danieldouglas92 d****s@s****u 39
Juliane Dannberg j****g@g****m 38
Timo Heister t****r@g****m 36
Magali Billen m****n@u****u 30
Wolfgang Bangerth b****h@c****u 29
Arushi Saxena s****4@g****m 27
Wang-yijun y****g@g****m 19
Haoyuan Li h****i@u****u 12
Alan Yu a****u@o****m 9
dependabot[bot] 4****] 6
cmills1095 c****5@g****m 6
Arushi -****d 5
anne-glerum a****m@u****l 5
Minerallo m****2@g****m 4
Nathalie Redick n****k@g****m 3
Oliver Henke-Seemann o****n@f****e 3
SabatinoSantangelo 1****o 3
Derek Neuharth d****h@g****m 2
cedrict c****t@u****l 1
kristofporkolab 4****b 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 23
  • Total pull requests: 149
  • Average time to close issues: 3 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 8
  • Total pull request authors: 18
  • Average comments per issue: 1.13
  • Average comments per pull request: 1.24
  • Merged pull requests: 100
  • Bot issues: 0
  • Bot pull requests: 16
Past Year
  • Issues: 16
  • Pull requests: 126
  • Average time to close issues: 8 days
  • Average time to close pull requests: 2 days
  • Issue authors: 8
  • Pull request authors: 15
  • Average comments per issue: 0.88
  • Average comments per pull request: 0.99
  • Merged pull requests: 80
  • Bot issues: 0
  • Bot pull requests: 16
Top Authors
Issue Authors
  • MFraters (21)
  • lhy11009 (5)
  • danieldouglas92 (5)
  • tjhei (4)
  • Minerallo (4)
  • gassmoeller (2)
  • anne-glerum (2)
  • alarshi (2)
  • gavindejong (1)
  • 3Faker3 (1)
  • keithmagali (1)
  • Wang-yijun (1)
  • mibillen (1)
  • gogo2464 (1)
  • ZonglinGuo (1)
Pull Request Authors
  • MFraters (109)
  • ljhwang (50)
  • gassmoeller (39)
  • danieldouglas92 (35)
  • tjhei (24)
  • alarshi (21)
  • dependabot[bot] (16)
  • jdannberg (12)
  • alanjyu (9)
  • SabatinoSantangelo (6)
  • Djneu (6)
  • olihen (6)
  • Wang-yijun (5)
  • lhy11009 (5)
  • anne-glerum (4)
Top Labels
Issue Labels
hackathon-2024 (11) medium project (4) small project (3) documentation enhancement (2) testing enhancement (2) input/help wanted (2) ready to merge (1) hackathon-2025 (1) add/change user functionality (1) add/change code functionality (1) bug (1)
Pull Request Labels
ready to merge (75) dependencies (16) testing enhancement (9) github_actions (2) add/change code functionality (1) add/change user functionality (1) bug (1)

Dependencies

doc/requirements.txt pypi
  • myst-parser *
  • sphinx-copybutton *
  • sphinx-design *
  • sphinx-inline-tabs *
  • sphinx_book_theme *
  • sphinxcontrib-bibtex *
.github/workflows/benchmarks.yml actions
  • actions-rs/toolchain v1 composite
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
  • jwlawson/actions-setup-cmake v1.9 composite
.github/workflows/post_benchmark_results.yml actions
  • actions/github-script v3.1.0 composite
  • peter-evans/create-or-update-comment v1 composite
  • peter-evans/find-comment v1 composite
.github/workflows/test.yml actions
  • actions/checkout v2 composite
  • coverallsapp/github-action master composite
  • ilammy/msvc-dev-cmd v1 composite
  • jwlawson/actions-setup-cmake v1.13 composite