Skip to content
Snippets Groups Projects
Commit 4716eab8 authored by Ronald Jäpel's avatar Ronald Jäpel
Browse files

Expand documentation

parent 15c01952
No related branches found
No related tags found
No related merge requests found
...@@ -10,3 +10,6 @@ This tool aims to help track and version control: ...@@ -10,3 +10,6 @@ This tool aims to help track and version control:
and allow for easy sharing, integration, and reproduction of generated results. and allow for easy sharing, integration, and reproduction of generated results.
## Documentation
You can read the documentation [here](https://cadet-rdm.readthedocs.io).
\ No newline at end of file
...@@ -5,3 +5,38 @@ CADET-RDM can be installed using ...@@ -5,3 +5,38 @@ CADET-RDM can be installed using
```pip install cadet-rdm``` ```pip install cadet-rdm```
We *highly* recommend using an
[environment file](https://forum.cadet-web.de/t/a-guide-to-reproducible-python-environments-and-cadet-installations/766)
to install CADET-RDM.
For use with [mamba](https://github.com/conda-forge/miniforge#mambaforge) or
[conda](https://docs.conda.io/projects/miniconda/en/latest/), create a rdm_environment.yml like:
```yaml
name: rdm_example
channels:
- conda-forge
dependencies:
- python=3.11
- conda
- pip
- pip:
- cadet-rdm
```
and then run
```commandline
mamba env create -f rdm_environment.yml
```
For use with [pip](https://pypi.org/project/pip/), create a rdm_requirements.txt file like:
```
python==3.11
cadet-rdm>=0.0.15
```
```commandline
pip install -r rdm_requirements.txt
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment