diff --git a/CITATION.cff b/CITATION.cff index a52e10850..5ed73c20e 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -53,4 +53,4 @@ url: 'https://helmholtz.software/software/eclm' repository: 'https://hpscterrsys.github.io/eCLM' keywords: - 'land surface model, Earth system model, Fortran, HPC' -license: MIT +license: BSD-3-Clause diff --git a/LICENSE b/LICENSE index 269d207ac..b53807613 100644 --- a/LICENSE +++ b/LICENSE @@ -1,37 +1,29 @@ +BSD-3-Clause License + 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. -Developed by: Centre for High-Performance Scientific Computing in Terrestrial Systems (HPSC TerrSys) - https://www.hpsc-terrsys.de/en - - University Corporation for Atmospheric Research - National Center for Atmospheric Research - https://www2.cesm.ucar.edu/working-groups/sewg +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this +list of conditions and the following disclaimer. -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the "Software"), -to deal with the Software without restriction, including without limitation -the rights to use, copy, modify, merge, publish, distribute, sublicense, -and/or sell copies of the Software, and to permit persons to whom -the Software is furnished to do so, subject to the following conditions: +2. Redistributions in binary form must reproduce the above copyright notice, +this list of conditions and the following disclaimer in the documentation and/or +other materials provided with the distribution. - - Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimers. - - Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimers in the documentation - and/or other materials provided with the distribution. - - Neither the names of [UCAR, HPSC TerrSys], - nor the names of its contributors may be used to endorse or promote - products derived from this Software without specific prior written permission. +3. Neither the name of the copyright holder nor the names of its contributors +may be used to endorse or promote products derived from this software without +specific prior written permission. -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 2dc71b02e..42945f630 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![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) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17967419.svg)](https://doi.org/10.5281/zenodo.17967419) 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. @@ -17,6 +18,20 @@ Feel free to post your questions and problems via the [issue tracker]. We also w For general inquiries, leave us a message on our [eCLM Matrix channel]. +## Citing + +If you use this software, please cite: + +```bibtex +@software{eclm, + author = {Rigor, Paul and Poll, Stefan and González-Nicolás, Ana and Keller, Johannes and van Hulten, Marco and Caviedes-Voullieme, Daniel and Hendricks-Franssen, Harrie-Jan and Goergen, Klaus and Kollet, Stefan}, + title = {enCore Community Land Model (eCLM)}, + year = {2025}, + url = {https://github.com/HPSCTerrSys/eCLM}, + doi = {10.5281/ZENODO.17967419} +} +``` + [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 diff --git a/docs/INDEX.md b/docs/INDEX.md index 846cee2d3..c94bf8021 100755 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -46,3 +46,16 @@ Each time step the model solves the surface energy balance, water balance, and c Configuration of the CLM subgrid hierarchy. Box in upper right shows hypothetical subgrid distribution for a single grid cell. Note that the Crop land unit is only used when the model is run with the crop model active. Abbreviations: TBD – Tall Building District; HD – High Density; MD – Medium Density, G – Glacier, L – Lake, U – Urban, C – Crop, V – Vegetated, PFT – Plant Functional Type, Irr – Irrigated, UIrr – Unirrigated. Red arrows indicate allowed land unit transitions. Purple arrows indicate allowed patch-level transitions. From CLM5 Technical Note. ``` +## Citing + +If you use this software, please cite: + +```bibtex +@software{eclm, + author = {Rigor, Paul and Poll, Stefan and González-Nicolás, Ana and Keller, Johannes and van Hulten, Marco and Caviedes-Voullieme, Daniel and Hendricks-Franssen, Harrie-Jan and Goergen, Klaus and Kollet, Stefan}, + title = {enCore Community Land Model (eCLM)}, + year = {2025}, + url = {https://github.com/HPSCTerrSys/eCLM}, + doi = {10.5281/ZENODO.17967419} +} +```