https://github.com/cadet/cadet-python-tutorial
Interactive tutorials and documentation for file based Python interface.
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
4 of 7 committers (57.1%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.6%) to scientific vocabulary
Keywords from Contributors
Repository
Interactive tutorials and documentation for file based Python interface.
Basic Info
Statistics
- Stars: 11
- Watchers: 9
- Forks: 8
- Open Issues: 3
- Releases: 1
Metadata Files
README.md
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
Owner
- Name: CADET
- Login: cadet
- Kind: organization
- Email: cadet@fz-juelich.de
- Website: cadet.github.io
- Repositories: 1
- Profile: https://github.com/cadet
GitHub Events
Total
- Watch event: 4
- Delete event: 2
- Push event: 4
- Pull request event: 4
- Fork event: 1
- Create event: 2
Last Year
- Watch event: 4
- Delete event: 2
- Push event: 4
- Pull request event: 4
- Fork event: 1
- Create event: 2
Committers
Last synced: 12 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Johannes Schmölder | j****r@f****e | 52 |
| William Heymann | w****n@c****u | 36 |
| Johannes Schmölder | j****r@f****e | 7 |
| Jan Breuer | j****r@g****e | 5 |
| Jayghosh Rao | j****r@g****m | 3 |
| Jayghosh Rao | j****o@f****e | 2 |
| r.jaepel | r****l@f****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 12 months ago
All Time
- Total issues: 3
- Total pull requests: 4
- Average time to close issues: 10 days
- Average time to close pull requests: 15 days
- Total issue authors: 3
- Total pull request authors: 3
- Average comments per issue: 1.0
- Average comments per pull request: 0.25
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 1 minute
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jbiffl (1)
- jayghoshter (1)
- ronald-jaepel (1)
Pull Request Authors
- jbreue16 (4)
- ronald-jaepel (1)
- creadicted (1)