prepare v0.1

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
 

CHANGELOG.md

 # 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

LICENSE.md

 # SOFTWARE LICENCE
 
-FINAM-mHM is a open-source FINAM component for mHM.
+FINAM-mHM is an open-source FINAM component for mHM.
 
 ## Copyright Notice
 

README.md

-# 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

docs/source/about/authors.rst

+.. include:: ../../../AUTHORS.md
+   :parser: myst_parser.sphinx_

docs/source/about/changelog.rst

+.. include:: ../../../CHANGELOG.md
+   :parser: myst_parser.sphinx_

docs/source/about/index.rst

+=====
+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

docs/source/about/license.rst

+.. include:: ../../../LICENSE.md
+   :parser: myst_parser.sphinx_

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",

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.

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",
 ]