Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 2.1 KB

SETUP.md

File metadata and controls

67 lines (51 loc) · 2.1 KB

Setting up

Install requirements

WARNING

You should really make a new environment for this because all package versions are pinned, and you don't want to mess up your production environment. This hopefully avoids situations like 'Help, it doesn't work with my 2-year-old setup!'

Pick either conda or pip:

Conda

conda env create -f conda-scicat-workshop.yml
conda activate scicat-workshop

Pip

  • Make an environment with the environment-making tool of your choice (we need Python >= 3.8).
  • Activate the environment.
  • Then
python -m pip install -r pip-scicat-workshop.txt

SSH

Omit this step if your SSH is already set up like this.

For the time being, we have to use SSH to access the fileserver. To make this work smoothly,

Host login.esss.dk
    HostName login.esss.dk
    User <your-username>
    IdentityFile <private-key-file>

IdentityFile is optional in case your agent is not set up correctly. But the rest is important.

You may choose a different host name. You'll just have to use that in the tutorial notebook instead of the default login.esss.dk.

Prepare slides

To be able to prepare the slides, you need to create the conda environment scicat-workshop-prep, using the following commands:

conda env create -f conda-scicat-workshop-prep.yml
conda activate scicat-workshop-prep

Than you open the scicat-workshop.ipynb and save it once you are done modifiying it. You will be able to create the slides in html format with the following command:

jupyter dejavu scicat_workshop.ipynb --to slides --no-prompt --TagRemovePreprocessor.remove_input_tags={\"to_remove\"}

If you are interested in creating a pdf from the same notebook, you can run the following command:

jupyter dejavu scicat_workshop.ipynb --to pdf --no-prompt --TagRemovePreprocessor.remove_input_tags={\"to_remove\"}