Update install instructions #644
Conversation
doc/guide/install.rst
Outdated
| These instructions will install the most recent stable version of CLIMADA without cloning its repository. | ||
|
|
||
| #. Download the Anaconda environment specifications for CLIMADA: :download:`env_climada.yml </../requirements/env_climada.yml>`. | ||
| You can also find it online in the `CLIMADA GitHub repository <https://github.com/CLIMADA-project/climada_python/blob/main/requirements/env_climada.yml>`_. |
There was a problem hiding this comment.
| You can also find it online in the `CLIMADA GitHub repository <https://github.com/CLIMADA-project/climada_python/blob/main/requirements/env_climada.yml>`_. |
In discussions about the previous versions the (very) simple instructions we somehow agreed that within this section, we don't want the user to make any decision at all. Along with this and since it the alternative has no real benefit, I'd omit it.
There was a problem hiding this comment.
Alright! I just realize that I should add to this that users need to download the file into the workspace directory
doc/guide/install.rst
Outdated
|
|
||
| These instructions will install the most recent stable version of CLIMADA without cloning its repository. | ||
|
|
||
| #. Download the Anaconda environment specifications for CLIMADA: :download:`env_climada.yml </../requirements/env_climada.yml>`. |
There was a problem hiding this comment.
I kind of liked the download by command line instruction using curl of the previous Step by Step version. Provides a base for scripting such things (or put differently: allows a coach to give a single instruction: copy and paste all gray lines one by one and run them).
There was a problem hiding this comment.
I see. I am a bit hesitant because I do not like instructing people to "mindlessly" copy-paste command line instructions, as they can be quite harmful. The other thing I was thinking about is the availability of curl. Can we safely assume that it is available in all setups we encourage? Or do Linux users first have to apt install curl?
There was a problem hiding this comment.
Actually the availability was the argument for using curl and not wget: curl is available on Windows and macOS.
I assume the availability on Linux depends on the distribution. But I guess the number of Linux users that don't have curl installed is neglectable. 🧐
There was a problem hiding this comment.
Then I'll use the curl instruction and add to the prerequisites that Linux users have to install curl, python and git 😁
Co-authored-by: Emanuel Schmid <51439563+emanuel-schmid@users.noreply.github.com>
|
🙌 many thanks! |
Changes proposed in this PR:
PR Author Checklist
develop)[ ] Tests updatedPR Reviewer Checklist