This repo contains five Jupyter notebooks in {MySt}NB Markdown format. They can be opend in Jupyter Notebook or Lab using the Jupytext extension. We use this format because
- Jupytext notebooks are great for version control
- MyST-flavoured can be integrated in a Sphinx homepage and treated like any other document
- clone the corpus:
git clone --recurse-submodules -j8 [email protected]:DCMLab/dcml_corpora.git - create new environment, make it visible to your Jupyter
- for conda do
conda create --name {name} python=3.10 - activate it and install
pip install ipykernel ipython kernel install --user --name={name}
- for conda do
- within the new environment, install requirements, e.g.
pip install -r requirements.txt - open up jupyter notebook or jupyter lab and open the
.md(documentation) - change the value
~/dcml_corporain the second cell to your local clone.
If the plots are not displayed and you are in JupyterLab, use this guide.