From bae40285530634d768741b8312e9e236e8f9041d Mon Sep 17 00:00:00 2001 From: kvrigor Date: Wed, 22 Jul 2026 09:04:30 +0200 Subject: [PATCH 01/12] Added CITATION, CONTRIBUTING; updated README --- CITATION.cff | 56 +++++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 28 +++++++++++++++++++++++++ README.md | 16 +++++++------- 3 files changed, 92 insertions(+), 8 deletions(-) create mode 100644 CITATION.cff create mode 100644 CONTRIBUTING.md diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000000..a52e10850f --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,56 @@ +# This CITATION.cff file was generated with cffinit. +# Visit https://bit.ly/cffinit to generate yours today! + +cff-version: 1.2.0 +title: enCore Community Land Model (eCLM) +message: >- + If you use this software, please cite it using the + metadata from this file. +type: software +authors: + - given-names: Paul + family-names: Rigor + orcid: 'https://orcid.org/0009-0003-5256-9215' + - given-names: Stefan + family-names: Poll + orcid: 'https://orcid.org/0000-0003-2527-0747' + - given-names: Marco + family-names: van Hulten + orcid: 'https://orcid.org/0000-0002-3045-4949' + - given-names: Ana + family-names: González-Nicolás + orcid: 'https://orcid.org/0000-0003-2869-8255' + - given-names: Johannes + family-names: Keller + orcid: 'https://orcid.org/0000-0003-0813-7493' + - 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.5281/zenodo.17967419 + description: >- + Developing the enCore community land model (eCLM): + adapting community land model version 5 (CLM5) to fit + into modular earth system simulation platforms + - type: swh + value: 'swh:1:dir:a429f9a169583bbe59562895161cb8b799b9d94d' + description: Software Heritage ID + - type: url + value: 'https://helmholtz.software/software/eclm' + description: Helmholtz Research Software Directory +repository-code: 'https://github.com/HPSCTerrSys/eCLM' +url: 'https://helmholtz.software/software/eclm' +repository: 'https://hpscterrsys.github.io/eCLM' +keywords: + - 'land surface model, Earth system model, Fortran, HPC' +license: MIT diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..b94a9107eb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +This repository contains open source software developed and maintained by [HPSC TerrSys]. + +Contributions to this project are welcome. There are two ways to contribute: + +1. **Asking questions or reporting problems via the [issue tracker]**. You can browse through open issues to give you ideas on how they are typically written. We appreciate a well-written issue that follows this 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 #1) and go through the standard [Github pull request] process, which is explained below in brief: + a. [Fork] this repo and then [clone] it to your local PC. + b. [Create a branch]. This branch will contain your proposed fixes/features. + c. Make changes on your branch, [commit], and then [`git push` your changes]. Keep doing this until you're satisfied with your changes and ready to share your ideas/results. + d. [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. + e. Mark your PR as "Ready" to start the review process. Then try to resolve the comments raised by the maintainers. + g. Changes will be accepted if it (1) passes all automated tests and (2) at least one maintainer approved the PR. + h. **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) +[issue tracker]: https://github.com/HPSCTerrSys/eCLM/issues +[Github pull requests]: 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 +[`git push` your changes]: 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/eCLM/pull/101 diff --git a/README.md b/README.md index 3af2d8e249..6aaa35b680 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # eCLM -[![CI](https://github.com/HPSCTerrSys/eCLM/actions/workflows/build_and_run_eCLM.yml/badge.svg)](https://github.com/HPSCTerrSys/eCLM/actions/workflows/build_and_run_eCLM.yml) -[![docs](https://github.com/HPSCTerrSys/eCLM/actions/workflows/docs.yml/badge.svg)](https://github.com/HPSCTerrSys/eCLM/actions/workflows/docs.yml) +[![helmholtz rsd](https://img.shields.io/badge/helmholtz.software-eclm-00a3e3](https://helmholtz.software/software/eclm) [![latest tag](https://badgen.net/github/tag/HPSCTerrSys/eCLM)](https://github.com/HPSCTerrSys/eCLM/tags) eCLM is based from [Community Land Model 5.0 (CLM5.0)]. It has the same modelling capabilities as CLM5 but with a more simplified infrastructure for build and namelist generation. The build system is handled entirely by CMake and namelists are generated through a small set of Python scripts. Only Fortran source codes necessary for a functional land model simulation were imported from CLM5. Unlike CLM5, there are no built-in batch scripts in eCLM. It is up to system maintainers or users to craft their own workflows by combining the basic tools in this repo plus the native tools in their respective platforms. -> [!WARNING] -> eCLM is still experimental and being extensively tested. Use it at your own risk! - -## Usage - -Please check the documentation at https://hpscterrsys.github.io/eCLM +- **Documentation**: https://hpscterrsys.github.io/eCLM +- **Contributions**: Mainly via [issues] and [pull requests]. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. +- **Contact**: You can send your general inquiries on our [eCLM Matrix channel]. [Community Land Model 5.0 (CLM5.0)]: https://github.com/ESCOMP/CTSM/tree/release-clm5.0 +[issues]: https://github.com/HPSCTerrSys/eCLM/issues +[pull requests]: https://github.com/HPSCTerrSys/eCLM/pulls +[CONTRIBUTING.md]: CONTRIBUTING.md +[eCLM Matrix channel]: https://matrix.to/#/!UooUiDWmcOwQXoktJt:fz-juelich.de?via=fz-juelich.de&via=matrix.org) From 7ade58cdfdb8ae6b15af4472b8e4d62a5bd1d7db Mon Sep 17 00:00:00 2001 From: kvrigor Date: Wed, 22 Jul 2026 09:10:55 +0200 Subject: [PATCH 02/12] Fixed Markdown links --- CONTRIBUTING.md | 20 ++++++++++---------- README.md | 6 ++++-- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b94a9107eb..8905a6fa19 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,19 +3,19 @@ This repository contains open source software developed and maintained by [HPSC Contributions to this project are welcome. There are two ways to contribute: 1. **Asking questions or reporting problems via the [issue tracker]**. You can browse through open issues to give you ideas on how they are typically written. We appreciate a well-written issue that follows this 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) + - [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 #1) and go through the standard [Github pull request] process, which is explained below in brief: - a. [Fork] this repo and then [clone] it to your local PC. - b. [Create a branch]. This branch will contain your proposed fixes/features. - c. Make changes on your branch, [commit], and then [`git push` your changes]. Keep doing this until you're satisfied with your changes and ready to share your ideas/results. - d. [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. - e. Mark your PR as "Ready" to start the review process. Then try to resolve the comments raised by the maintainers. - g. Changes will be accepted if it (1) passes all automated tests and (2) at least one maintainer approved the PR. - h. **Optional**: Attach experimental results in the PR discussion (see [example here]). Well-documented PRs are highly appreciated and are more likely to get accepted. + a. [Fork] this repo and then [clone] it to your local PC. + b. [Create a branch]. This branch will contain your proposed fixes/features. + c. Make changes on your branch, [commit], and then [`git push` your changes]. Keep doing this until you're satisfied with your changes and ready to share your ideas/results. + d. [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. + e. Mark your PR as "Ready" to start the review process. Then try to resolve the comments raised by the maintainers. + g. Changes will be accepted if it (1) passes all automated tests and (2) at least one maintainer approved the PR. + h. **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) +[HPSC TerrSys]: https://github.com/HPSCTerrSys?view_as=public [issue tracker]: https://github.com/HPSCTerrSys/eCLM/issues [Github pull requests]: 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 diff --git a/README.md b/README.md index 6aaa35b680..12fc3c9ef7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # eCLM -[![helmholtz rsd](https://img.shields.io/badge/helmholtz.software-eclm-00a3e3](https://helmholtz.software/software/eclm) +[![helmholtz rsd](https://img.shields.io/badge/helmholtz.software-eclm-00a3e3)](https://helmholtz.software/software/eclm) [![latest tag](https://badgen.net/github/tag/HPSCTerrSys/eCLM)](https://github.com/HPSCTerrSys/eCLM/tags) eCLM is based from [Community Land Model 5.0 (CLM5.0)]. It has the same modelling capabilities as CLM5 but with a more simplified infrastructure for build and namelist generation. The build system is handled entirely by CMake and namelists are generated through a small set of Python scripts. Only Fortran source codes necessary for a functional land model simulation were imported from CLM5. Unlike CLM5, there are no built-in batch scripts in eCLM. It is up to system maintainers or users to craft their own workflows by combining the basic tools in this repo plus the native tools in their respective platforms. +## More info + - **Documentation**: https://hpscterrsys.github.io/eCLM - **Contributions**: Mainly via [issues] and [pull requests]. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. - **Contact**: You can send your general inquiries on our [eCLM Matrix channel]. @@ -15,4 +17,4 @@ Unlike CLM5, there are no built-in batch scripts in eCLM. It is up to system mai [issues]: https://github.com/HPSCTerrSys/eCLM/issues [pull requests]: https://github.com/HPSCTerrSys/eCLM/pulls [CONTRIBUTING.md]: CONTRIBUTING.md -[eCLM Matrix channel]: https://matrix.to/#/!UooUiDWmcOwQXoktJt:fz-juelich.de?via=fz-juelich.de&via=matrix.org) +[eCLM Matrix channel]: https://matrix.to/#/!UooUiDWmcOwQXoktJt:fz-juelich.de?via=fz-juelich.de&via=matrix.org From 9e0eb9ef25db7ad27c5b8f1ded0ff5a4abe18500 Mon Sep 17 00:00:00 2001 From: kvrigor Date: Wed, 22 Jul 2026 09:21:44 +0200 Subject: [PATCH 03/12] More Markdown rendering fixup --- CONTRIBUTING.md | 14 +++++++------- README.md | 16 ++++++++++------ 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8905a6fa19..39fc12389d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,13 +7,13 @@ Contributions to this project are welcome. There are two ways to contribute: - [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 #1) and go through the standard [Github pull request] process, which is explained below in brief: - a. [Fork] this repo and then [clone] it to your local PC. - b. [Create a branch]. This branch will contain your proposed fixes/features. - c. Make changes on your branch, [commit], and then [`git push` your changes]. Keep doing this until you're satisfied with your changes and ready to share your ideas/results. - d. [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. - e. Mark your PR as "Ready" to start the review process. Then try to resolve the comments raised by the maintainers. - g. Changes will be accepted if it (1) passes all automated tests and (2) at least one maintainer approved the PR. - h. **Optional**: Attach experimental results in the PR discussion (see [example here]). Well-documented PRs are highly appreciated and are more likely to get accepted. + 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, [commit], and then [`git push` your changes]. Keep doing this until you're satisfied with your changes and ready to share your ideas/results. + 4. [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. Then try to resolve the comments raised by the maintainers. + 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 [issue tracker]: https://github.com/HPSCTerrSys/eCLM/issues diff --git a/README.md b/README.md index 12fc3c9ef7..5b391c5920 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,18 @@ eCLM is based from [Community Land Model 5.0 (CLM5.0)]. It has the same modellin Unlike CLM5, there are no built-in batch scripts in eCLM. It is up to system maintainers or users to craft their own workflows by combining the basic tools in this repo plus the native tools in their respective platforms. -## More info +## Documentation -- **Documentation**: https://hpscterrsys.github.io/eCLM -- **Contributions**: Mainly via [issues] and [pull requests]. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. -- **Contact**: You can send your general inquiries on our [eCLM Matrix channel]. +Head over to https://hpscterrsys.github.io/eCLM + +## Contributing + +Feel free to post your questions and problems via the [issue tracker]. [Pull requests] are also welcome. Before opening an issue or submit a pull request, please take the time to view our [contributing guidelines]. + +For general inquiries, you can leave us a message on our [eCLM Matrix channel]. [Community Land Model 5.0 (CLM5.0)]: https://github.com/ESCOMP/CTSM/tree/release-clm5.0 -[issues]: https://github.com/HPSCTerrSys/eCLM/issues +[issue tracker]: https://github.com/HPSCTerrSys/eCLM/issues [pull requests]: https://github.com/HPSCTerrSys/eCLM/pulls -[CONTRIBUTING.md]: CONTRIBUTING.md +[contributing guidelines]: CONTRIBUTING.md [eCLM Matrix channel]: https://matrix.to/#/!UooUiDWmcOwQXoktJt:fz-juelich.de?via=fz-juelich.de&via=matrix.org From 402e6cd97e694b4d6e4e72801bcd4a93cf9f4b70 Mon Sep 17 00:00:00 2001 From: kvrigor Date: Wed, 22 Jul 2026 09:32:36 +0200 Subject: [PATCH 04/12] More editorial fixes --- CONTRIBUTING.md | 16 ++++++++-------- README.md | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39fc12389d..5f04dd2830 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,28 +1,28 @@ This repository contains open source software developed and maintained by [HPSC TerrSys]. -Contributions to this project are welcome. There are two ways to contribute: +Contributions are welcome! There are two main ways to contribute: -1. **Asking questions or reporting problems via the [issue tracker]**. You can browse through open issues to give you ideas on how they are typically written. We appreciate a well-written issue that follows this guidelines: +- **Asking questions or reporting problems via the [issue tracker]**. Browse through open issues to get ideas on how we typically document our issues. We appreciate well-written issues that follow this 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 #1) and go through the standard [Github pull request] process, which is explained below in brief: +- **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, [commit], and then [`git push` your changes]. Keep doing this until you're satisfied with your changes and ready to share your ideas/results. + 3. Make changes on your branch, [commit], and then [`git push`] your changes. Keep doing this until you're satisfied and ready to share your ideas/results. 4. [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. Then try to resolve the comments raised by the maintainers. - 6. Changes will be accepted if it (1) passes all automated tests and (2) at least one maintainer approved the PR. + 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 [issue tracker]: https://github.com/HPSCTerrSys/eCLM/issues -[Github pull requests]: https://docs.github.com/en/pull-requests/reference/pull-requests +[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 -[`git push` your changes]: https://github.com/git-guides/git-push +[`git 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/eCLM/pull/101 diff --git a/README.md b/README.md index 5b391c5920..2a415d597d 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,12 @@ Head over to https://hpscterrsys.github.io/eCLM ## Contributing -Feel free to post your questions and problems via the [issue tracker]. [Pull requests] are also welcome. Before opening an issue or submit a pull request, please take the time to view our [contributing guidelines]. +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, you can leave us a message on our [eCLM Matrix channel]. [Community Land Model 5.0 (CLM5.0)]: https://github.com/ESCOMP/CTSM/tree/release-clm5.0 [issue tracker]: https://github.com/HPSCTerrSys/eCLM/issues [pull requests]: https://github.com/HPSCTerrSys/eCLM/pulls -[contributing guidelines]: CONTRIBUTING.md +[contribution guidelines]: CONTRIBUTING.md [eCLM Matrix channel]: https://matrix.to/#/!UooUiDWmcOwQXoktJt:fz-juelich.de?via=fz-juelich.de&via=matrix.org From 9b924c7effcd3e3dda8d528e69e1ab94df4e8dab Mon Sep 17 00:00:00 2001 From: kvrigor Date: Wed, 22 Jul 2026 09:38:57 +0200 Subject: [PATCH 05/12] Minor editorial fixes --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f04dd2830..99045b9d62 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,11 +2,11 @@ This repository contains open source software developed and maintained by [HPSC Contributions are welcome! There are two main ways to contribute: -- **Asking questions or reporting problems via the [issue tracker]**. Browse through open issues to get ideas on how we typically document our issues. We appreciate well-written issues that follow this guidelines: +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 this 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) -- **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: +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, [commit], and then [`git push`] your changes. Keep doing this until you're satisfied and ready to share your ideas/results. diff --git a/README.md b/README.md index 2a415d597d..2dc71b02e0 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ Unlike CLM5, there are no built-in batch scripts in eCLM. It is up to system mai ## Documentation -Head over to https://hpscterrsys.github.io/eCLM +Check our online docs at https://hpscterrsys.github.io/eCLM ## 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, you can leave us a message on our [eCLM Matrix channel]. +For general inquiries, leave us a message on our [eCLM Matrix channel]. [Community Land Model 5.0 (CLM5.0)]: https://github.com/ESCOMP/CTSM/tree/release-clm5.0 [issue tracker]: https://github.com/HPSCTerrSys/eCLM/issues From 91df9a89205157367a39384a155f19b52a480997 Mon Sep 17 00:00:00 2001 From: kvrigor Date: Wed, 22 Jul 2026 12:59:50 +0200 Subject: [PATCH 06/12] Refine step 3 & 4 of contribution guide --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99045b9d62..1d0308c731 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,8 +9,8 @@ Contributions are welcome! There are two main ways to contribute: 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, [commit], and then [`git push`] your changes. Keep doing this until you're satisfied and ready to share your ideas/results. - 4. [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. + 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. @@ -21,8 +21,8 @@ Contributions are welcome! There are two main ways to contribute: [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 -[`git push`]: https://github.com/git-guides/git-push +[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/eCLM/pull/101 From 02fa79b65da65e73dcccb460ae25832af855a8d9 Mon Sep 17 00:00:00 2001 From: kvrigor Date: Wed, 22 Jul 2026 13:07:33 +0200 Subject: [PATCH 07/12] Added software quality indicator CI Copied from https://github.com/EVERSE-ResearchSoftware/resqui-github-action#basic-usage --- .github/workflows/resqui.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/workflows/resqui.yml diff --git a/.github/workflows/resqui.yml b/.github/workflows/resqui.yml new file mode 100644 index 0000000000..45a9affe05 --- /dev/null +++ b/.github/workflows/resqui.yml @@ -0,0 +1,18 @@ +name: Run Resqui CI + +on: + push: + +jobs: + run-resqui: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Run resqui action + uses: EVERSE-ResearchSoftware/resqui-github-action@main + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + config: "configurations/basic.json" From 3cdef0db44ed4976a5e88244d50976982c506921 Mon Sep 17 00:00:00 2001 From: kvrigor Date: Wed, 22 Jul 2026 13:10:47 +0200 Subject: [PATCH 08/12] resqui: Don't upload to DashVerse yet --- .github/workflows/resqui.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/resqui.yml b/.github/workflows/resqui.yml index 45a9affe05..1560329a89 100644 --- a/.github/workflows/resqui.yml +++ b/.github/workflows/resqui.yml @@ -15,4 +15,3 @@ jobs: uses: EVERSE-ResearchSoftware/resqui-github-action@main with: github_token: ${{ secrets.GITHUB_TOKEN }} - config: "configurations/basic.json" From b8e8cc8ab3d7040a0bbaec1d0bbc65e8b751809e Mon Sep 17 00:00:00 2001 From: kvrigor Date: Wed, 22 Jul 2026 13:52:22 +0200 Subject: [PATCH 09/12] Removed resqui This CI task is slow. Also it's not clear how the FAIR results could be published. --- .github/workflows/resqui.yml | 17 ----------------- 1 file changed, 17 deletions(-) delete mode 100644 .github/workflows/resqui.yml diff --git a/.github/workflows/resqui.yml b/.github/workflows/resqui.yml deleted file mode 100644 index 1560329a89..0000000000 --- a/.github/workflows/resqui.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Run Resqui CI - -on: - push: - -jobs: - run-resqui: - runs-on: ubuntu-latest - - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - - name: Run resqui action - uses: EVERSE-ResearchSoftware/resqui-github-action@main - with: - github_token: ${{ secrets.GITHUB_TOKEN }} From 3045f021ab22b9eb6d3c1afaf86edc6c6624b468 Mon Sep 17 00:00:00 2001 From: Paul Rigor Date: Thu, 23 Jul 2026 16:34:57 +0200 Subject: [PATCH 10/12] Update LICENSE to 2026 --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 1ae8a06718..269d207ac1 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2020-2025, Centre for High-Performance Scientific Computing in Terrestrial Systems (HPSC TerrSys) +Copyright (c) 2020-2026, Centre for High-Performance Scientific Computing in Terrestrial Systems (HPSC TerrSys) Copyright (c) 2005-2018, University Corporation for Atmospheric Research (UCAR) All rights reserved. From 4fbc097023ed67c416818346a7a834f154b088ae Mon Sep 17 00:00:00 2001 From: kvrigor Date: Fri, 24 Jul 2026 13:47:53 +0200 Subject: [PATCH 11/12] Linked to Contributor Covenant 3.0 Code of Conduct good suggestion by @s-poll --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d0308c731..fc7d3bd289 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ This repository contains open source software developed and maintained by [HPSC TerrSys]. -Contributions are welcome! There are two main ways to contribute: +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 this guidelines: - [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) @@ -16,6 +16,7 @@ Contributions are welcome! There are two main ways to contribute: 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/eCLM/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 From ab29a1d55617b648676d9b502ab9355ad52cd009 Mon Sep 17 00:00:00 2001 From: kvrigor Date: Fri, 24 Jul 2026 13:51:43 +0200 Subject: [PATCH 12/12] this -> these --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc7d3bd289..3dfaf1ec1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ This repository contains open source software developed and maintained by [HPSC 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 this guidelines: +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)