Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cadet/cadet-python-tutorial
Interactive tutorials and documentation for file based Python interface.
https://github.com/cadet/cadet-python-tutorial
Last synced: 19 days ago
JSON representation
Interactive tutorials and documentation for file based Python interface.
- Host: GitHub
- URL: https://github.com/cadet/cadet-python-tutorial
- Owner: cadet
- License: other
- Created: 2019-09-24T07:18:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-13T10:30:05.000Z (about 1 month ago)
- Last Synced: 2024-11-30T12:47:53.769Z (25 days ago)
- Language: Jupyter Notebook
- Homepage:
- Size: 104 MB
- Stars: 12
- Watchers: 10
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![CC BY NC SA 4.0][cc-by-nc-sa-shield]][cc-by-nc-sa]
This work is licensed under a
[Creative Commons Attribution 4.0 International License][cc-by-nc-sa].
[![CC BY 4.0][cc-by-nc-sa-image]][cc-by-nc-sa]
[cc-by-nc-sa]: https://creativecommons.org/licenses/by-nc-sa/4.0/
[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png
[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY%20NC%20SA%204.0-lightgrey.svg
# We recommend for new users of CADET to follow the [CADET-Workshop](https://github.com/cadet/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](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 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](https://git-scm.com/downloads) 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`