[docu] Add guidelines chapter + add missing algorithms to inheritance diagram

Author: MartinPontius

CONTRIBUTING.md

@@ -1,3 +1,3 @@
-Contributions are always welcome. Before creating [Pull Requests](https://github.com/52North/WeatherRoutingTool/pulls) or commenting [Issues](https://github.com/52North/WeatherRoutingTool/issues) please carefully read the [Contributing](https://52north.github.io/WeatherRoutingTool/source/contributing.html) section in our documentation.
+Contributions are always welcome. Before creating [Pull Requests](https://github.com/52North/WeatherRoutingTool/pulls) or commenting [Issues](https://github.com/52North/WeatherRoutingTool/issues) please carefully read the [Contributing](https://52north.github.io/WeatherRoutingTool/source/guidelines/contribution_guidelines.html) section in our documentation.
 
 Please do not ask if you can work on an issue. Just re-read our documentation and remember that contributions are welcome! Also be aware that we do not assign issues to contributors we have not worked with yet. If this applies to you please do not ask to be assigned. 

docs/index.rst

@@ -18,7 +18,7 @@ Welcome to the documentation of the 52°North Weather Routing Tool (WRT)!
    source/sequence_diagrams
    source/api-documentation/index
    source/conventions
-   source/contributing
+   source/guidelines/index
    source/references
 
 Indices and tables

docs/source/contributing.rst …/source/guidelines/coding_guidelines.rstdocs/source/contributing.rst renamed to docs/source/guidelines/coding_guidelines.rst docs/source/contributing.rst renamed to docs/source/guidelines/coding_guidelines.rst

@@ -1,16 +1,4 @@
-.. _contributing:
-
-Contribution Guidelines
-=======================
-
-Before getting involved please carefully read our `documentation for Open Source Software contributions <https://52north.org/software/contribute/>`_.
-Be aware that we can only consider pull requests of authors who consider 52North's `CLA guidelines <https://52north.org/software/licensing/cla-guidelines/>`_ and, in particular, fill the 52North Contributor License Agreement.
-
-General remarks
----------------
-
-- Please do not ask if you can work on an issue. Contributions are welcome. Remember to read the `CLA guidelines <https://52north.org/software/licensing/cla-guidelines/>`_.
-- Be aware that we do not assign issues to contributors we have not worked with yet. If this applies to you please do not ask to be assigned.
+.. _coding_guidelines:
 
 Coding Guidelines
 =================

docs/source/guidelines/contribution_guidelines.rst

@@ -0,0 +1,14 @@
+.. _contribution_guidelines:
+
+
+Contribution Guidelines
+=======================
+
+Before getting involved please carefully read our `documentation for Open Source Software contributions <https://52north.org/software/contribute/>`_.
+Be aware that we can only consider pull requests of authors who consider 52North's `CLA guidelines <https://52north.org/software/licensing/cla-guidelines/>`_ and, in particular, fill the 52North Contributor License Agreement.
+
+General remarks
+---------------
+
+- Please do not ask if you can work on an issue. Contributions are welcome. Remember to read the `CLA guidelines <https://52north.org/software/licensing/cla-guidelines/>`_.
+- Be aware that we do not assign issues to contributors we have not worked with yet. If this applies to you please do not ask to be assigned.

docs/source/guidelines/index.rst

@@ -0,0 +1,13 @@
+.. guidelines:
+
+Guidelines
+==========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   contribution_guidelines
+   coding_guidelines
+   software_profiling
+   tests

docs/source/guidelines/software_profiling.rst

@@ -0,0 +1,37 @@
+.. _software_profiling:
+
+
+Software profiling
+==================
+
+
+Runtime monitoring
+------------------
+
+The runtime can be analyzed using `cProfile <https://docs.python.org/3/library/profile.html#module-cProfile>`_ from Python's standard library.
+
+To do this add the following code lines in `execute_routing.py <https://github.com/52North/WeatherRoutingTool/blob/main/WeatherRoutingTool/execute_routing.py>`_:
+
+.. code-block:: python
+
+    import cProfile
+
+    def execute_routing(config, ship_config):
+        prof = cProfile.Profile()
+        prof.enable()
+
+        ...
+
+        prof.disable()
+        prof.dump_stats('wrt_run.prof')
+
+The result can be visualized using `snakeviz <https://jiffyclub.github.io/snakeviz/>`_:
+
+.. code-block:: shell
+
+    snakeviz wrt_run.prof
+
+Memory monitoring
+-----------------
+
+TBD

docs/source/guidelines/tests.rst

@@ -0,0 +1,17 @@
+.. _tests:
+
+
+Tests
+=====
+
+Install test dependencies:
+
+.. code-block:: shell
+
+    pip install -r requirements.test.txt
+
+Run tests with pytest:
+
+.. code-block:: shell
+
+    pytest tests/

docs/source/inheritance_diagrams.rst

@@ -10,6 +10,8 @@ Algorithm Classes
 The routing algorithms follow a clear inheritance pattern with ``RoutingAlg`` as the base class:
 
 .. inheritance-diagram::
+   WeatherRoutingTool.algorithms.dijkstra
+   WeatherRoutingTool.algorithms.gcrslider
    WeatherRoutingTool.algorithms.genetic
    WeatherRoutingTool.algorithms.isobased
    WeatherRoutingTool.algorithms.isochrone