This work is licensed under a Creative Commons Attribution 4.0 International License.

We recommend for new users of CADET to follow the CADET-Workshop

This repository is maintained to serve as a documentation of the CADET-Interface (using CADET-Python).

For more information, see also:

• Website (including documentation): https://cadet.github.io
• Forum: https://forum.cadet-web.de
• Source: https://github.com/cadet/cadet-core
• Bug reports: https://github.com/cadet/cadet-core

Download the tutorials

To run the tutorials locally, 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. We recommend creating a dedicated environment for CADET.

The easiest way to download the tutorials is to clone this repository. For this purpuse, make sure, git is installed.

From a git bash run

git clone https://github.com/cadet/CADET-Python-Tutorial

Then, from the Anaconda Prompt, cd into the directory and install all the requirements by running the following command:

conda env create -f ./environment.yml

This will create a new conda environment called cadet. To activate it, run:

conda activate cadet

Getting started

Fire up a jupyter-lab from Anaconda Prompt and navigate to the location of this repository using the file manager on the left. Then, start by following the instructions in getting_started.ipynb. It includes a check that everything is installed correctly.

In case you are new to Python and jupyter, we also included a small tutorial (00_Introduction_Python) which covers the necessary basics for the tutorials.

Fixing potential problems.

• If you get the following error The code execution cannot proceed because VCRUNTIME140_1.dll was not found. Reinstalling the program may fix this problem., please visit https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads and install the latest Microsoft Visual C++ Redistributable.
• Some of the notebooks include interactive graphs. To enable them, please open an Anaconda prompt and run:
• For JupyterLab 2.0+

  jupyter labextension install @jupyter-widgets/jupyterlab-manager
  jupyter lab clean
  jupyter lab build
  

• For JupyterLab 3.0+: install ipympl