Update Euler Guide #986
Update Euler Guide #986
Conversation
There was a problem hiding this comment.
Thanks Emanuel, these instructions are super useful!
I have used the "Climada installation in a virtual environment" and "Run a Jupyter Notebook on Euler" instructions myself, and they work well for me. I have added a few comments which could increase the clarity of the instructions for some users.
I have not implemented the other sections of this tutorial myself, but the instructions seem sufficiently clear for me.
doc/guide/Guide_Euler.ipynb
Outdated
| "envname=climada_env\n", | ||
| "\n", | ||
| "# create environment\n", | ||
| "python -m venv --system-site-packages ~/venv/$envname\n", |
There was a problem hiding this comment.
| "python -m venv --system-site-packages ~/venv/$envname\n", | |
| "python -m venv --system-site-packages ./venv/$envname\n", |
There was a problem hiding this comment.
~ would direct back to the home directory, which we want to avoid here, right?
There was a problem hiding this comment.
Hm. Valid question. Not necessarily. the environemnt will contain about 80000 files and occupy about 600M. That is quite suitable for the home directory. For other parts of the file system that's less convenient. The project folder would be an option, but then we have to provide guidance on how to organize virtual environments there.
On the other hand, . is a dangerous folder. Once you logged out you may never find it again (;
There was a problem hiding this comment.
I am not against installing in the home folder if that works, just above it says "As a general rule: use /cluster/project for installation" so I think the intructions should be consistent between the text and the code
doc/guide/Guide_Euler.ipynb
Outdated
| "\n", | ||
| "should output something like this:\n", | ||
| "# acitvate it\n", | ||
| ". ~/venv/$envname/bin/activate\n", |
There was a problem hiding this comment.
| ". ~/venv/$envname/bin/activate\n", | |
| ". ./venv/$envname/bin/activate\n", |
| "\n", | ||
| "There are two options. Either install from the downloaded repository (option A), or use a particular released version (option B).\n", | ||
| "\n", | ||
| "#### option A\n", |
There was a problem hiding this comment.
Here I would explicitly add the lines to clone the git repository, otherwise it is not clear that the user still has to do that:
git clone https://github.com/CLIMADA-project/climada_python.git
cd /cluster/project/climate/$USER/climada_python
git checkout develop
| "python -c 'import climada; print(climada.__file__)'\n", | ||
| "module unload proj\n", | ||
| "\n", | ||
| "EOF\n", |
There was a problem hiding this comment.
Potentially add something to the effect of "If you encounter a No such directory error when running the lines above, run mkdir -p /cluster/home/shuelsen/.config/euler/jupyterhub/ and try rerunning the lines above"
| "```\n", | ||
| "envname=climada_env\n", | ||
| "\n", | ||
| "# create environment\n", |
There was a problem hiding this comment.
| "# create environment\n", | |
| "# navigate to your project directory\n", | |
| "cd /cluster/project/climate/$USER\n", | |
| "# create environment\n", |
There was a problem hiding this comment.
actually one doesn't need to be there 🤷
doc/guide/Guide_Euler.ipynb
Outdated
| @@ -45,7 +45,7 @@ | |||
| "metadata": {}, | |||
| "source": [ | |||
| "\n", | |||
| "## Pre-installed version of Climada\n", | |||
| "## Climada installation in a virtual environment\n", | |||
| "\n", | |||
| "Climada is pre-installed and available in the default pip environment of Euler." | |||
There was a problem hiding this comment.
I thought this is no longer the case with the new Euler set up? If not, best remove. If it is, best add a clarification under which circumstances users should use the default installation and when to follow the instructions below.
Co-authored-by: Sarah Hülsen <[email protected]>
Co-authored-by: Sarah Hülsen <[email protected]>
Co-authored-by: Sarah Hülsen <[email protected]>
Co-authored-by: Sarah Hülsen <[email protected]>
|
🙌 many thanks for the review @sarah-hlsn |
Changes proposed in this PR:
PR Author Checklist
develop)PR Reviewer Checklist