diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..0a90955 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,50 @@ +cff-version: 1.2.0 +title: Terrestrial Systems Modelling Platform v2 (TSMP2) +message: >- + If you use this software, please cite it using the + metadata from this file. +type: software +authors: + - given-names: Stefan + family-names: Poll + orcid: 'https://orcid.org/0000-0003-2527-0747' + - given-names: Paul + family-names: Rigor + orcid: 'https://orcid.org/0009-0003-5256-9215' + - given-names: Johannes + family-names: Keller + orcid: 'https://orcid.org/0000-0003-0813-7493' + - given-names: Ana + family-names: González-Nicolás + orcid: 'https://orcid.org/0000-0003-2869-8255' + - given-names: Marco + family-names: van Hulten + orcid: 'https://orcid.org/0000-0002-3045-4949' + - given-names: Daniel + family-names: Caviedes-Voullieme + orcid: 'https://orcid.org/0000-0001-7871-7544' + - given-names: Harrie-Jan + family-names: Hendricks-Franssen + orcid: 'https://orcid.org/0000-0002-0004-8114' + - given-names: Klaus + family-names: Goergen + orcid: 'https://orcid.org/0000-0002-4208-3444' + - given-names: Stefan + family-names: Kollet + orcid: 'https://orcid.org/0000-0003-0095-1554' +identifiers: + - type: doi + value: 10.5194/egusphere-2025-5468 + description: The new TSMP2 coupled Earth system model + - type: swh + value: 'swh:1:dir:de483517587dba81b26968db6391a49459b8a811' + description: Software Heritage ID + - type: url + value: 'https://helmholtz.software/software/tsmp2' + description: Helmholtz Research Software Directory +repository-code: 'https://github.com/HPSCTerrSys/TSMP2' +url: 'https://helmholtz.software/software/tsmp2' +repository: 'https://hpscterrsys.github.io/TSMP2' +keywords: + - 'regional Earth system model, Fortran, HPC' +license: MIT diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b369a49 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +This repository contains open source software developed and maintained by [HPSC TerrSys]. + +Contributions are welcome! First and foremost, contributions are subject to the [Contributor Code of Conduct] and we do our best to adhere to them. If that sounds reasonable to you, you can start contributing in two ways: + +1. **Asking questions or reporting problems via the [issue tracker]**. Browse through open issues to get ideas on how they are typically written up. We appreciate well-written issues that follow these guidelines: + - [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) + - [How to Ask Questions the Smart Way](https://www.catb.org/esr/faqs/smart-questions.html#beprecise) + +2. **Modify the documentation or code**. Proposed changes must be linked to an open issue (see previous item) and go through the standard [Github pull request] process, which is explained below in brief: + 1. [Fork] this repo and then [clone] it to your local PC. + 2. [Create a branch]. This branch will contain your proposed fixes/features. + 3. Make changes on your branch, and then regularly [commit] and [push] changes. Also, write good `git commit` messages: a good one answers the question "what is the most interesting aspect of this commit?" in as few words as possible. + 4. When you're ready to share your fixes/new feature, [create a pull request (PR)]. Mark it as a [draft] if you intend to keep working on it; a draft PR is also a good time to get early feedback from your work. + 5. Mark your PR as _Ready_ to start the review process. Wait for the maintainers to provide comments, and then address their review comments as they come. + 6. Changes will be accepted if it **(1)** passes all automated tests and **(2)** at least one maintainer approved the PR. + 7. **Optional**: Attach experimental results in the PR discussion (see [example here]). Well-documented PRs are highly appreciated and are more likely to get accepted. + +[HPSC TerrSys]: https://github.com/HPSCTerrSys?view_as=public +[Contributor Code of Conduct]: https://www.contributor-covenant.org/version/3/0/code_of_conduct +[issue tracker]: https://github.com/HPSCTerrSys/tsmp2/issues +[Github pull request]: https://docs.github.com/en/pull-requests/reference/pull-requests +[Fork]: https://docs.github.com/en/pull-requests/how-tos/work-with-forks/fork-a-repo?versionId=free-pro-team%40latest&productId=pull-requests&restPage=reference%2Cpull-requests&search-overlay-input=branch&search-overlay-ask-ai=true#forking-a-repository +[clone]: https://docs.github.com/en/pull-requests/how-tos/work-with-forks/fork-a-repo?versionId=free-pro-team%40latest&productId=pull-requests&restPage=reference%2Cpull-requests&search-overlay-input=branch&search-overlay-ask-ai=true#cloning-your-forked-repository +[Create a branch]: https://docs.github.com/en/pull-requests/how-tos/commit-changes/managing-branches-within-your-repository#creating-a-branch +[commit]: https://github.com/git-guides/git-commit +[push]: https://github.com/git-guides/git-push +[Create a pull request (PR)]: https://docs.github.com/en/pull-requests/how-tos/create-pull-requests/creating-a-pull-request-from-a-fork +[draft]: https://docs.github.com/en/pull-requests/reference/pull-requests#draft-pull-requests +[example here]: https://github.com/HPSCTerrSys/TSMP2/pull/61 diff --git a/LICENSE.txt b/LICENSE.txt index 258a3ee..574fb22 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ MIT License -Copyright 2023-2024 by the TSMP2 Team (see the CONTRIBUTORS.txt file) +Copyright 2023-2026 by the TSMP2 Team (see the CONTRIBUTORS.txt file) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/README.md b/README.md index 3b3b521..8bd7adb 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,45 @@ # Terrestrial Systems Modeling Platform v2 (TSMP2) -[![docs](https://github.com/HPSCTerrSys/TSMP2/actions/workflows/docs.yml/badge.svg)](https://github.com/HPSCTerrSys/TSMP2/actions/workflows/docs.yml) -[![build](https://github.com/HPSCTerrSys/TSMP2/actions/workflows/CI.yml/badge.svg)](https://github.com/HPSCTerrSys/TSMP2/actions/workflows/CI.yml) -[![doi](https://img.shields.io/badge/rsd-tsmp2-00a3e3)](https://helmholtz.software/software/tsmp2) +[![helmholtz rsd](https://img.shields.io/badge/helmholtz.software-tsmp2-00a3e3)](https://helmholtz.software/software/tsmp2) +[![doi](https://img.shields.io/badge/doi-preprint-00a3e3)](https://doi.org/10.5194/egusphere-2025-5468) ## Introduction -The Terrestrial System Modeling Platform v2 (TSMP2, https://www.terrsysmp.org) is an open source scale-consistent, highly modular, massively parallel regional Earth system model. TSMP essentially consists of an interface which couples dedicated versions of the ICOsahedral Nonhydrostatic ([ICON](https://www.icon-model.org/)) atmospheric model in NWP or climate mode, the encore Community Land Model ([eCLM](https://hpscterrsys.github.io/eCLM)), and the hydrologic model [ParFlow](https://www.parflow.org) through the [OASIS3](https://oasis.cerfacs.fr/en/)-[MCT](https://www.mcs.anl.gov/research/projects/mct/) coupler. +The [Terrestrial System Modeling Platform v2 (TSMP2)] is an open source scale-consistent, highly modular, massively parallel regional Earth system model. TSMP2 essentially consists of an interface which couples dedicated versions of the ICOsahedral Nonhydrostatic ([ICON]) atmospheric model in NWP or climate mode, the encore Community Land Model ([eCLM]), and the hydrologic model [ParFlow] through the [OASIS3-MCT] coupler. -TSMP allows for a physically-based representation of transport processes of mass, energy and momentum and interactions between the different compartments of the geo-ecosystem across scales, explicitly reproducing feedbacks in the hydrological cycle from the groundwater into the atmosphere. +TSMP2 allows for a physically-based representation of transport processes of mass, energy and momentum and interactions between the different compartments of the geo-ecosystem across scales, explicitly reproducing feedbacks in the hydrological cycle from the groundwater into the atmosphere. -TSMP-PDAF describes the build commands of TSMP that can introduce data -assimilation for an ensemble of TSMP simulations using the Parallel - Data Assimilation Framework -([PDAF](https://pdaf.awi.de/trac/wiki)). For more information, see the -[documentation of TSMP-PDAF](https://hpscterrsys.github.io/pdaf). +TSMP2-PDAF describes the build commands of TSMP2 that can introduce data assimilation for an ensemble of TSMP2 simulations using the Parallel Data Assimilation Framework ([PDAF]). For more information, see the [TSMP-PDAF] documentation. -TSMP development has been driven by groups within the [Center for High-Performance Scientific Computing in Terrestrial Systems](http://www.hpsc-terrsys.de) (HPSC-TerrSys). +TSMP2 development has been driven by groups within the [Center for High-Performance Scientific Computing in Terrestrial Systems] (HPSC-TerrSys). ## Quickstart -Please see [quickstart section](./docs/users_guide/building_TSMP2/Quickstart.md) for guided steps on how the model can be build. +Please see [quickstart section] for guided steps on how the model can be build. ## Usage / Documentation Please check the documentation at https://hpscterrsys.github.io/TSMP2 -## License -TSMP is open source software and is licensed under the [MIT-License](https://github.com/HPSCTerrSys/TSMP2/blob/master/LICENSE.txt). +## Contributing + +Feel free to post your questions and problems via the [issue tracker]. We also welcome [pull requests]. Before opening an issue or a pull request, please review our **[contribution guidelines]**. +For general inquiries, leave us a message on our [TSMP2 Matrix channel]. + +## License +TSMP2 is open source software and is licensed under the [MIT-License](https://github.com/HPSCTerrSys/TSMP2/blob/master/LICENSE.txt). + +[Terrestrial System Modeling Platform v2 (TSMP2)]: https://www.terrsysmp.org +[ICON]: https://www.icon-model.org +[eCLM]: https://github.com/HPSCTerrSys/eCLM +[ParFlow]: https://www.parflow.org +[OASIS3-MCT]: https://oasis.cerfacs.fr/en/home +[PDAF]: https://pdaf.awi.de/trac/wiki +[TSMP-PDAF]: https://hpscterrsys.github.io/pdaf +[Center for High-Performance Scientific Computing in Terrestrial Systems]: http://www.hpsc-terrsys.de +[quickstart section]: ./docs/users_guide/building_TSMP2/Quickstart.md +[issue tracker]: https://github.com/HPSCTerrSys/TSMP2/issues +[pull requests]: https://github.com/HPSCTerrSys/TSMP2/pulls +[contribution guidelines]: CONTRIBUTING.md +[TSMP2 Matrix channel]: https://matrix.to/#/!PIarBDtnbrOJHXiixi:fz-juelich.de?via=fz-juelich.de&via=matrix.org