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

Jump to bottom

add OSX installation instructions to docs #2115

Merged
merged 5 commits into from Apr 14, 2021
Merged

add OSX installation instructions to docs #2115

merged 5 commits into from Apr 14, 2021

Conversation

bvreede
Copy link
Contributor

@bvreede bvreede commented Apr 12, 2021 •
edited by stefsmeets

This PR updates the installation instructions to explicitly include ESMValTool installation recommendations for MacOSX. As there is no support for NCL, Julia, and R on OSX, we recommend OSX users to either install only the Python diagnostics, or make use of the Docker container.

Docs: https://esmvaltool--2115.org.readthedocs.build/en/2115/quickstart/installation.html#installation-on-macosx

@stefsmeets stefsmeets self-requested a review April 12, 2021 12:56
@bvreede bvreede marked this pull request as ready for review April 12, 2021 15:13
@bvreede bvreede mentioned this pull request Apr 12, 2021
Merged
stefsmeets
stefsmeets suggested changes Apr 13, 2021
View reviewed changes
Copy link
Contributor

@stefsmeets stefsmeets left a comment

Choose a reason for hiding this comment

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

Looks good to me, just a small change from my side!

For the tests you updated, we needed to install libomp and use environment_osx.yml. Is that not necessary here?

doc/sphinx/source/quickstart/installation.rst Outdated Show resolved Hide resolved
@bvreede @stefsmeets
Update doc/sphinx/source/quickstart/installation.rst
d4744d2 
Co-authored-by: Stef Smeets <stefsmeets@users.noreply.github.com>
@stefsmeets stefsmeets self-requested a review April 13, 2021 07:36
stefsmeets
stefsmeets approved these changes Apr 13, 2021
View reviewed changes
Copy link
Contributor

@stefsmeets stefsmeets left a comment

Choose a reason for hiding this comment

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

👍

@bvreede
Copy link
Contributor Author

bvreede commented Apr 13, 2021

Thanks for the review, @stefsmeets!

In installing only esmvaltool-python, the R and NCL dependencies that were the culprit in the environment.yml file do not get installed so there is no problem there. Libomp may end up being required, but only when using diag_scripts/mlr/models/gbr_xgboost.py, and as the error message is very informative on what to do if libomp is needed but not installed (see the discussion at #2110) the user would be clearly instructed if and when this applies.

@nielsdrost nielsdrost merged commit 9a723d9 into master Apr 14, 2021
@nielsdrost nielsdrost deleted the osx_docs branch April 14, 2021 17:46
@nielsdrost
Copy link
Member

Thanks @bvreede and @stefsmeets!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stefsmeets stefsmeets stefsmeets approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@bvreede @nielsdrost @stefsmeets