Skip to content

Commit 0cc51c0

Browse files
hannahlanzrathjbreue16
authored andcommitted
Update documentation landing page (#376)
Add information about CADET platform to landing page
1 parent c823463 commit 0cc51c0

File tree

3 files changed

+20
-6
lines changed

3 files changed

+20
-6
lines changed

doc/getting_started/installation_frontend.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,11 @@ To install ``CADET-Python``, open an `conda shell` and execute:
2727
.. code-block:: bash
2828
2929
pip install CADET-Python
30+
31+
32+
Additional Resources
33+
^^^^^^^^^^^^^^^^^^^^
34+
35+
- `CADET-Process documentation <https://cadet-process.readthedocs.io/>`_
36+
- `CADET-Process Workshop <https://github.com/cadet/CADET-Workshop>`_
37+
- `CADET-Python Tutorial <https://github.com/cadet/CADET-Python-Tutorial>`_

doc/getting_started/introduction.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,3 @@ CADET-Core developers who might want to test their extensions of the simulator s
2222
:maxdepth: 1
2323

2424
/../developer_guide/cadet_python
25-
26-
27-
.. figure:: tutorials/_images/cadet_architecture_overview.png
28-
29-
30-
Relations between CADET-Core, CADET-Python, and CADET-Process.

doc/index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,18 @@ Features
4545
* Flexible and extensible through modular design
4646
* Works on Windows, Linux, and Mac OS X
4747

48+
CADET Platform
49+
--------------
50+
51+
CADET-Core is part of `CADET <https://github.com/cadet>`_, a collective platform of software repositories that provide tools for biotechnology process modeling.
52+
CADET-Core can be used as a standalone simulator by interfacing via HDF5 files. Alternatively, CADET-Python provides a wrapper around an HDF5 file reader and writer, simplifying model configuration.
53+
Furthermore, it is the interface for CADET-Process, an universal and user-friendly tool for biotechnology process modeling and evaluation.
54+
55+
For more information on the different packages of the CADET platform, see :ref:`here <getting_started>`.
56+
57+
.. figure:: getting_started/tutorials/_images/cadet_architecture_overview.png
58+
59+
Relations between CADET-Core, CADET-Python, and CADET-Process.
4860

4961
Installation
5062
------------

0 commit comments

Comments
 (0)