Merge branch 'improve-documentation' into 'dev'

Many additions to the documentation

See merge request !50

docs/source/about.rst

+About plotID
+==================================
+
+plotID is developed at the Institut Fluidsystemtechnik within nfdi4ing at the Technische Universität Darmstadt.
+
+Acknowledgements
+---------------
+
+The authors would like to thank the Federal Government and the Heads of Government of the Länder, as well as the Joint Science Conference (GWK), for their funding and support within the framework of the NFDI4Ing consortium. Funded by the German Research Foundation (DFG) - project number 442146713.
\ No newline at end of file

docs/source/dependencies.rst

@@ -8,10 +8,10 @@ The plotID package depends on other software for its full funcionality. Since pl
 - `qrcode <https://github.com/lincolnloop/python-qrcode>`_: Creates QR codes from input data. qrcode is used to create the QR code which is printed on the plot in the end.
 - `numpy <https://numpy.org/doc/stable/>`_: Package for scientific computing. Right now it is only used to generate sample data in the examples. Since it is a dependency of matplotlib, it has to be installed anyway.
 
-Optional depedencies that are not necessary to run plotID but more to contribute to the code are the following:
+Optional dependencies that are not necessary to run plotID but more to contribute to the code quality are the following:
 
 - `coverage <https://coverage.readthedocs.io/en/6.5.0/#>`_: Program to measure the code coverage. It is used in the development of plotID to monitor the coverage of the code when the unit tests are run.
 - `sphinx <https://www.sphinx-doc.org/en/master/>`_: Program to build documentation. For example, this documentatio is generated with the help of sphinx.
 - `sphinx-autoapi <https://sphinx-autoapi.readthedocs.io/en/latest/>`_: Generates documentation files automatically from documentation inside the code. This has the advantage that code can be documented inside the code but can also be read in the documentation without having two places with the same content.
 - `sphinx-rtd-theme <https://sphinx-rtd-theme.readthedocs.io/en/stable/>`_: Readthedocs theme for nicer documentation style.
-- `myst-parser <https://myst-parser.readthedocs.io/en/latest/>`_: Extenstion for sphinx, e.g. to include markdown files in the documentation. That allows to include plotID's README.md in the documentation without storing it at two different places.
\ No newline at end of file
+- `myst-parser <https://myst-parser.readthedocs.io/en/latest/>`_: Extension for sphinx, e.g. to include markdown files in the documentation. That allows to include plotID's README.md in the documentation without storing it at two different places.

docs/source/index.rst

@@ -10,9 +10,11 @@ Welcome to plotID's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-    README <readme_link.rst>
-    Structure and architecture <structure.rst>
+    Overview <readme_link.rst>
+    Installation <installation.rst>
     Dependencies <dependencies.rst>
+    Structure and architecture <structure.rst>
+    About <about.rst>
 
 
 Indices and tables

docs/source/installation.rst

+Installation of plotID
+==================================
+
+For installation instructions, first have a look at the general :doc:`readme_link` or the `README.md <https://git.rwth-aachen.de/plotid/plotid_python/-/blob/main/README.md>`_ file. More detailed information about the installation process can then be found here.
+
+Wrong python version
+--------------------
+To install and run plotID a python version ≥ 3.10 is required. If your linux distribution is shipped with a python version < 3.10, you still can install a newer python version. Intalling python 3.10 on Debian or Ubuntu would look like this
+
+.. code:: bash
+
+    sudo apt install python3.10 python3.10-venv
+
+You can then create a virtual environment "venv" to run plotID inside it
+
+.. code:: bash
+
+    python3.10 -m venv venv
+
+Now activate the venv
+
+.. code:: bash
+
+    source venv/bin/activate
+
+The virtual environment now runs with python 3.10 and plotID can be installed the usual way as described in :doc:`Overview`.
+
+
+Installation on Windows via pip
+-------------------------------
+If you're trying
+
+.. code:: cmd
+
+    pip install .
+
+and following error is thrown
+
+.. code:: cmd
+
+    Fatal error in launcher: Unable to create process using '"...env\Scripts\python.exe"  "..\venv\Scripts\pip.exe" install .': The system cannot find the specified file.
+
+Try to forcefully reinstall pip
+
+.. code:: cmd
+
+    python -m pip install --upgrade --force pip
+
+Or use 
+
+.. code:: cmd
+
+    python -m pip install .
+
+instead.

docs/source/plotid.rst

-plotid package
-==============
-
-Submodules
-----------
-
-plotid.create\_id module
-------------------------
-
-.. automodule:: plotid.create_id
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-plotid.example module
----------------------
-
-.. automodule:: plotid.example
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-plotid.filecompare module
--------------------------
-
-.. automodule:: plotid.filecompare
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-plotid.hdf5\_external\_link module
-----------------------------------
-
-.. automodule:: plotid.hdf5_external_link
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-plotid.plotoptions module
--------------------------
-
-.. automodule:: plotid.plotoptions
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-plotid.publish module
----------------------
-
-.. automodule:: plotid.publish
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-plotid.save\_plot module
-------------------------
-
-.. automodule:: plotid.save_plot
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-plotid.tagplot module
----------------------
-
-.. automodule:: plotid.tagplot
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-plotid.tagplot\_matplotlib module
----------------------------------
-
-.. automodule:: plotid.tagplot_matplotlib
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: plotid
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/readme_link.rst

-Readme File
+Overview
+========
+
+README file
 -----------
 
 .. include:: ../../README.md