From a454522a50d828bc483718f416fd5b7c7636b912 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Schm=C3=B6lder?= Date: Wed, 27 Oct 2021 19:47:43 +0200 Subject: [PATCH] Updated installation instructions --- README.rst | 17 +++++++++++---- doc/getting_started/installation.rst | 31 ++++++++++------------------ doc/index.rst | 14 +++++++++++++ 3 files changed, 38 insertions(+), 24 deletions(-) diff --git a/README.rst b/README.rst index 3dd537dc4..87ee683d9 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. + +Optionally, use `mamba `_ which uses a faster dependency solver than ``conda``. + +``mamba install -c conda-forge cadet`` + +`Additional information `_ and a `tutorial `_ are available to guide you through the installation and the first steps of using CADET. -Download the `latest release `_ for your platform. -`Additional information `_ and a `tutorial `_ are available to guide you through the installation and the first steps of using CADET. Ongoing Development ------------------- diff --git a/doc/getting_started/installation.rst b/doc/getting_started/installation.rst index 69ab0c1f1..97df25899 100644 --- a/doc/getting_started/installation.rst +++ b/doc/getting_started/installation.rst @@ -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 `_ 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 `_. + +Optionally, use `mamba `_ which uses a faster dependency solver than ``conda``. + +``mamba install -c conda-forge cadet`` Install from source ^^^^^^^^^^^^^^^^^^^ @@ -45,31 +50,17 @@ For this purpose, we recommend installing `Anaconda ` 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 `_ 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 `_ for parameter estimation, run: .. code-block:: bash - conda install -c immudzen cadetmatch + pip install cadetmatch Install CADET-MI diff --git a/doc/index.rst b/doc/index.rst index d8f479ee7..b80a07780 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 `_. + +Optionally, use `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 `. + Ongoing Development -------------------