Skip to content

Update install instructions#644

Merged
emanuel-schmid merged 11 commits intodevelopfrom
update-install-instructions
Feb 16, 2023
Merged

Update install instructions#644
emanuel-schmid merged 11 commits intodevelopfrom
update-install-instructions

Conversation

@peanutfun
Copy link
Copy Markdown
Member

@peanutfun peanutfun commented Feb 6, 2023

Changes proposed in this PR:

  • Merge and consolidate install instructions

PR Author Checklist

PR Reviewer Checklist

Copy link
Copy Markdown
Collaborator

@emanuel-schmid emanuel-schmid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 Very nice, great improvement!

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>`_.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright! I just realize that I should add to this that users need to download the file into the workspace directory


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>`.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. 🧐

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then I'll use the curl instruction and add to the prerequisites that Linux users have to install curl, python and git 😁

@emanuel-schmid emanuel-schmid merged commit 5d35778 into develop Feb 16, 2023
@emanuel-schmid
Copy link
Copy Markdown
Collaborator

🙌 many thanks!

@emanuel-schmid emanuel-schmid deleted the update-install-instructions branch February 16, 2023 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants