Documentation update

Author: foxBMS

.gitlab-ci.yml

@@ -24,7 +24,7 @@ devel_env:
   stage: init_ci
   script:
     - $nr_of_occurrences = (Get-ChildItem -Include *.md,*.rst -Recurse -Exclude .\git,.\build| Select-String -pattern "$CondaEnvironmentName" -AllMatches).matches.count
-    - if ($nr_of_occurrences -ne 4) { Throw "devel env name does not match the docs"}
+    - if ($nr_of_occurrences -ne 6) { Throw "devel env name does not match the docs"}
 
 initialize_python_deps: # make sure we have an up-to-date conda and pip available
   stage: init_ci

.vscode/cspell.json

@@ -28,6 +28,8 @@
         "Foerderung",
         "Forschung",
         "IISB",
+        "Jülich",
+        "BMBF",
         // rst and sphinx
         "automodule",
         "genindex",

docs/acknowledgment.rst

@@ -0,0 +1,15 @@
+Acknowledgment
+==============
+
+.. |logo_fkz| image:: ./_static/bmbf.png
+
++-------------------------------------+------------------------------------+
+| This work was financially supported | |logo_fkz|                         |
+| by the Federal Ministry of          |                                    |
+| Education Research within the       |                                    |
+| projects FKZ: 03XP0338C ("SimBAS"). |                                    |
+| The project is cared by Project     |                                    |
+| Management Jülich.                  |                                    |
+| The responsibility for this         |                                    |
+| publication rests with the authors. |                                    |
++-------------------------------------+------------------------------------+

docs/development/changelog.rst

@@ -7,6 +7,16 @@ The format is based on
 `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
 and this project adheres to `Calendar Versioning <https://calver.org/>`_.
 
+[2024.03.0] 2024-03-26
+----------------------
+
+Added
+^^^^^
+
+- Additionally to the `README.md` also state the acknowledgement in the
+  documentation itself.
+- Add documentation on how to build the `BaSD` Python package.
+
 [2024.01.1] 2024-01-22
 ----------------------
 

docs/development/dev-installation.rst

@@ -37,3 +37,24 @@ For Development
       $ code .
       $ cd src # testing needs to be run in source directory
       $ python -m basd design -r ../tests/requirements/Example-system.json --database ../tests/cells
+
+Packaging
++++++++++
+
+   .. code-block:: console
+
+      $ # user: activate any conda base environment
+      $ conda activate basd-devel-env-11
+      $ cd path/to/repo
+      $ flit build
+
+Documentation Build
++++++++++++++++++++
+
+   .. code-block:: console
+
+      $ # user: activate any conda base environment
+      $ conda activate basd-devel-env-11
+      $ cd path/to/repo
+      $ cd docs
+      $ make html

docs/index.rst

@@ -24,10 +24,25 @@ system configurations.
 
 The following documentation describes how to use and extend |basd|.
 
+.. |logo_fkz| image:: ./_static/bmbf.png
+
 .. note::
 
    |basd| is licensed under the :ref:`MIT license <LICENSE>`.
 
+.. note::
+
+   +-------------------------------------+------------------------------------+
+   | This work was financially supported | |logo_fkz|                         |
+   | by the Federal Ministry of          |                                    |
+   | Education Research within the       |                                    |
+   | projects FKZ: 03XP0338C ("SimBAS"). |                                    |
+   | The project is cared by Project     |                                    |
+   | Management Jülich.                  |                                    |
+   | The responsibility for this         |                                    |
+   | publication rests with the authors. |                                    |
+   +-------------------------------------+------------------------------------+
+
 .. toctree::
    :maxdepth: 1
    :caption: User Guide
@@ -70,6 +85,7 @@ The following documentation describes how to use and extend |basd|.
    license.rst
    GitHub <https://github.com/foxBMS/BaSD>
    Documentation <https://basd.readthedocs.io>
+   acknowledgment.rst
 
 Indices and tables
 

src/basd/utils/basd_version.py

@@ -33,6 +33,6 @@
 
 """Defines the BaSD version number"""
 
-_version = "2024.01.1"  #: BaSD version number: YYYY.MM.PATCH
+_version = "2024.03.0"  #: BaSD version number: YYYY.MM.PATCH
 
 __version__ = _version