diff --git a/AUTHORS.md b/AUTHORS.md index 1649f267a54cc221d9ee804859b5ad0955f05655..04216e274ccb39524ccf15d318e73903198d590e 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -10,6 +10,7 @@ The FINAM project was created by the following people. - Jeisson Javier Leal Rojas (E-mail: <jeisson-javier.leal-rojas@ufz.de>) - Matthias Kelbling (E-mail: <matthias.kelbling@ufz.de>) +- Martin Lange (E-mail: <martin.lange@ufz.de>) ## Supervisors diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c3cd019eee57372088ce8a86ce193e714d518dd..da58af50c0e1e11b572e5c666179dc7e01477de3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ # Changelog -## [unpublished] +## [v0.1.0] 2023-12 + +* initial release of the FINAM-mHM component + + +[unpublished]: https://git.ufz.de/FINAM/finam-mhm/-/compare/v0.1.0...main +[v0.1.0]: https://git.ufz.de/FINAM/finam-mhm/-/commits/v0.1.0 diff --git a/LICENSE.md b/LICENSE.md index cf849b21f48c6c77bb2ff53baac985a32716f018..7cabe60b0af98772c65fba292db9cf6feb3f8301 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # SOFTWARE LICENCE -FINAM-mHM is a open-source FINAM component for mHM. +FINAM-mHM is an open-source FINAM component for mHM. ## Copyright Notice diff --git a/README.md b/README.md index 33a221a9548bcf5c279b2e671f262c41c95f8d56..82c5087ae911138be40727e7ab2997499181ebb8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,23 @@ -# FINAM mHM module +# FINAM-mHM component -FINAM wrapper for mHM: https://git.ufz.de/mhm/mhm +FINAM component for mHM: https://git.ufz.de/mhm/mhm ## Installation ```shell -$ pip install git+https://git.ufz.de/FINAM/finam-mhm.git +$ pip install finam-mhm ``` +## Resources + +* FINAM-mHM [documentation](https://finam.pages.ufz.de/finam-mhm/) +* FINAM-mHM [source code](https://git.ufz.de/FINAM/finam-mhm) + +* FINAM [homepage](https://finam.pages.ufz.de) +* FINAM [documentation](https://finam.pages.ufz.de/finam/) +* FINAM [source code](https://git.ufz.de/FINAM/finam) +* FINAM [GitLab group](https://git.ufz.de/FINAM), containing further related projects + ## License -LGPLv3 (c) 2005-2023 CHS-Developers +LGPLv3 (c) 2023 CHS-Developers diff --git a/docs/source/about/authors.rst b/docs/source/about/authors.rst new file mode 100644 index 0000000000000000000000000000000000000000..5a49250e51bf004c1d6fbacb9d96dd1eeb2bd9ff --- /dev/null +++ b/docs/source/about/authors.rst @@ -0,0 +1,2 @@ +.. include:: ../../../AUTHORS.md + :parser: myst_parser.sphinx_ diff --git a/docs/source/about/changelog.rst b/docs/source/about/changelog.rst new file mode 100644 index 0000000000000000000000000000000000000000..792d3a2f16be6fc87b2a2a36246e67a559b93dbf --- /dev/null +++ b/docs/source/about/changelog.rst @@ -0,0 +1,2 @@ +.. include:: ../../../CHANGELOG.md + :parser: myst_parser.sphinx_ diff --git a/docs/source/about/index.rst b/docs/source/about/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..a036c6430b42ffbe5a4967f07d046e57e455b6a5 --- /dev/null +++ b/docs/source/about/index.rst @@ -0,0 +1,18 @@ +===== +About +===== + +Here you find further information about licensing, the developers team and the changelog of FINAM. + +.. toctree:: + :hidden: + :maxdepth: 1 + + self + +.. toctree:: + :maxdepth: 1 + + changelog + license + authors diff --git a/docs/source/about/license.rst b/docs/source/about/license.rst new file mode 100644 index 0000000000000000000000000000000000000000..d58509caded1d6186e82dfac1be7fe4d808408b3 --- /dev/null +++ b/docs/source/about/license.rst @@ -0,0 +1,2 @@ +.. include:: ../../../LICENSE.md + :parser: myst_parser.sphinx_ diff --git a/docs/source/conf.py b/docs/source/conf.py index 0e3ef6781af96a681150b8ff7400b2f08e83b6af..f7bac21df07598ce16523e8ee2234b6f9006f574 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -58,6 +58,7 @@ author = "mHM Developers" # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ + "myst_parser", "sphinx_design", "sphinx.ext.autodoc", "sphinx.ext.autosummary", diff --git a/docs/source/index.rst b/docs/source/index.rst index 7399d9ff3bf8268925ff1b00d3f806c38a6366c7..e94c189ee63f657a00d892a4bf04ec34a089113c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,6 +4,12 @@ FINAM mHM ========= +.. toctree:: + :hidden: + :maxdepth: 1 + + self + mHM component for the `FINAM <https://finam.pages.ufz.de/>`_ model coupling framework. Quickstart @@ -13,7 +19,7 @@ Installation: .. code-block:: bash - pip install git+https://git.ufz.de/FINAM/finam-mhm.git + pip install finam-mhm For available components, see the :doc:`api`. @@ -29,12 +35,21 @@ API References Information about the API of finam-mhm. .. toctree:: - :hidden: :maxdepth: 1 - self + api + +About +----- + +Further information about licensing, the developers team and the changelog of FINAM-mHM. .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - api + about/index + +License +------- + +LGPLv3, Copyright © 2023, the FINAM developers from Helmholtz-Zentrum für Umweltforschung GmbH - UFZ. All rights reserved. diff --git a/pyproject.toml b/pyproject.toml index 17e61d55c347da944ae052f94111040722eca110..30402f90bad2271869c46d452b8b49c56c7a1bcf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -30,6 +30,7 @@ classifiers = [ "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "Topic :: Scientific/Engineering", "Topic :: Software Development", "Topic :: Utilities", @@ -37,7 +38,7 @@ classifiers = [ dependencies = [ "numpy>=1.17.0", "mhm>=5.13.1", - "finam", # TODO: add v0.5 before release + "finam>=0.5.1", "f90nml", ]