Skip to content

Commit

Permalink
Updated installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
schmoelder committed Oct 27, 2021
1 parent 6f9bbf1 commit a454522
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 24 deletions.
17 changes: 13 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,20 @@ CADET
- **Demo:** https://www.cadet-web.de
- **Newsletter:** https://cadet-web.de/newsletter/

Download and Installation
-------------------------
Installation
------------
CADET can be installed via conda from the ``conda-forge`` channel.

``conda install -c conda-forge cadet``

This requires a working `conda installation <https://docs.anaconda.com/anaconda/install/index.html>`_.

Optionally, use `mamba <https://github.com/mamba-org/mamba>`_ which uses a faster dependency solver than ``conda``.

``mamba install -c conda-forge cadet``

`Additional information <https://cadet.github.io/getting_started/installation>`_ and a `tutorial <https://cadet.github.io/getting_started/tutorials/breakthrough>`_ are available to guide you through the installation and the first steps of using CADET.

Download the `latest release <https://github.com/modsim/cadet/releases>`_ for your platform.
`Additional information <https://cadet.github.io/master/getting_started/installation>`_ and a `tutorial <https://cadet.github.io/master/getting_started/tutorials/breakthrough>`_ are available to guide you through the installation and the first steps of using CADET.

Ongoing Development
-------------------
Expand Down
31 changes: 11 additions & 20 deletions doc/getting_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,19 @@ Install CADET core simulator
----------------------------

The core simulator can be compiled from source, or you can download pre-built binaries.
At the moment, only pre-built binaries for MS Windows are provided.
If you want to extend or modify CADET (e.g., add a custom binding model), you will need to build CADET from source.

Install pre-built binaries
^^^^^^^^^^^^^^^^^^^^^^^^^^
- Download the latest `release <https://github.com/modsim/CADET/releases>`_ for your platform (currently only binaries for windows are provided).
- Unzip the archive to your destination directory
CADET can be installed via conda from the ``conda-forge channel``.

``conda install -c conda-forge cadet``

This requires a working `conda installation <https://docs.anaconda.com/anaconda/install/index.html>`_.

Optionally, use `mamba <https://github.com/mamba-org/mamba>`_ which uses a faster dependency solver than ``conda``.

``mamba install -c conda-forge cadet``

Install from source
^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -45,31 +50,17 @@ For this purpose, we recommend installing `Anaconda <https://www.anaconda.com/>`
Anaconda is a high-performance scientific distribution of Python that includes many common packages needed for scientific and engineering work.
Download the installer from their `website <https://www.anaconda.com/>`_ and run it for the local user.

Before installing ``CADET-Python``, open an `Anaconda Shell` and and install these additional packages:

.. code-block:: bash
conda install numpy scipy matplotlib gitpython jupyterlab ipywidgets
conda install -c conda-forge jupyter_contrib_nbextensions jupyter_nbextensions_configurator
Moreover, we need to allow some additional channels for installing ``CADET-Python``:

.. code-block:: bash
conda config --add channels anaconda-fusion
conda config --add channels conda-forge
Then, to install ``CADET-Python`` run:
To install ``CADET-Python``, open an `Anaconda Shell` and execute:

.. code-block:: bash
conda install -c immudzen cadet-python
pip install cadet-python
If you would also like to use `CADET-Match <https://github.com/modsim/CADET-Match>`_ for parameter estimation, run:

.. code-block:: bash
conda install -c immudzen cadetmatch
pip install cadetmatch
Install CADET-MI
Expand Down
14 changes: 14 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,20 @@ Features
* Works on Windows, Linux, and Mac OS X


Installation
------------
CADET can be installed via conda from the ``conda-forge`` channel.

``conda install -c conda-forge cadet``

This requires a working `conda installation <https://docs.anaconda.com/anaconda/install/index.html>`_.

Optionally, use `mamba <https://github.com/mamba-org/mamba>`_ which uses a faster dependency solver than ``conda``.

``mamba install -c conda-forge cadet``

For more information on how to install and build CADET, see :ref:`here <installation>`.

Ongoing Development
-------------------

Expand Down

0 comments on commit a454522

Please sign in to comment.