Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Combine installation from source instructions and add common issues #1971

Merged
merged 5 commits into from Jan 27, 2021

Conversation

bouweandela
Copy link
Member

@bouweandela bouweandela commented Jan 11, 2021

Description

Combine installation from source instructions from two different sections and add a list of common installation issues and their solutions.


Before you get started

Checklist

It is the responsibility of the author to make sure the PR is ready to review. The icons indicate whether the item will be subject to the πŸ›  Technical or πŸ§ͺ Scientific review.


Do not run ``conda update --update-all`` in the ``esmvaltool``
environment since that will update some packages that are pinned to
specific versions for the correct functionality of the tool.
Copy link
Contributor

Choose a reason for hiding this comment

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

nice!! very nicely summarized and I really like the possible problems (Troubleshooting) bit, was this in before? I think we should add the case when conda is unable to retrieve a certain package because of a 500/501/504 issue (network or remote server problem) - this is more and more frequent these days for some reason, and a retry usually solves the issue. On a different topic, I can't see the bit about Julia no more - have I missed it or is it missing? I think it's important we explicitly say how to symlink the executable to the envs/esmvaltool/bin location - it's not fully and user-friendly described on the Julia website πŸ‘

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we should add the case when conda is unable to retrieve a certain package because of a 500/501/504 issue (network or remote server problem) - this is more and more frequent these days for some reason, and a retry usually solves the issue.

Sounds good, would you be willing to make a pull request to add that to the section with common problems after this one is merged?

I can't see the bit about Julia no more - have I missed it or is it missing? I think it's important we explicitly say how to symlink the executable to the envs/esmvaltool/bin location - it's not fully and user-friendly described on the Julia website

Indeed I removed it, but we have a really nice command by command description in the tutorial: https://esmvalgroup.github.io/ESMValTool_Tutorial/02-installation/index.html and the tutorial is mentioned at the top of this document for those who would like more detail. Do you think that could work?

Copy link
Contributor

Choose a reason for hiding this comment

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

point 1: absolutely! Let's merge this then I'll do that.
point 2: I think it's best we have complete instructions here, even if a much nicer and user-friendly set of instructions is on the tutorial; the documentation is usually the first point of entry and if users get stuck coz something is missing from it a good fraction of them would either ask (the UX group or us needing to spend extra time) or they simply give up πŸ‘

Copy link
Member Author

Choose a reason for hiding this comment

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

OK, I added a lot more instructions, could you have another look please?

Copy link
Contributor

Choose a reason for hiding this comment

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

doing it now πŸ‘

Copy link
Contributor

Choose a reason for hiding this comment

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

very cool - let me open an issue about adding more troubleshooting info after this is merged

Copy link
Member

@nielsdrost nielsdrost left a comment

Choose a reason for hiding this comment

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

Nice, looks good to me, thanks @bouweandela!

@@ -363,7 +399,7 @@ Software installation

Once all prerequisites are fulfilled, ESMValTool can be installed by running
the following commands in the directory containing the ESMValTool source code
(called ESMValTool if you did not choose a different name):
(called ``ESMValTool`` if you did not choose a different name):

.. code-block:: bash

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps add a line on what the "-e" is for. Or, perhaps use "--editable" for a bit more of a hint.

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed the option and added extra information

and then install ESMValCore in development mode

.. code-block:: bash

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps add a line on what the "-e" is for. Or, perhaps use "--editable" for a bit more of a hint.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

@valeriupredoi valeriupredoi 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, cheers muchly, Bouwe! I have never tested that Gillian Anderson jill thingie but I trust you tested and it works well 😁


Do not run ``conda update --update-all`` in the ``esmvaltool``
environment since that will update some packages that are pinned to
specific versions for the correct functionality of the tool.
Copy link
Contributor

Choose a reason for hiding this comment

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

very cool - let me open an issue about adding more troubleshooting info after this is merged

@bouweandela
Copy link
Member Author

@nielsdrost Does it look good now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Merge installation from source instructions
3 participants