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.

Sign up for GitHub

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

added optimal install instructions for install from conda #1675

Closed
wants to merge 2 commits into from
Closed

added optimal install instructions for install from conda #1675

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cc5831
added optimal install instructions from conda
valeriupredoi Jun 9, 2020
04e4522
fixed doc bad syntax
valeriupredoi Jun 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion doc/sphinx/source/quickstart/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,29 @@ In order to install the Conda package, you will need both conda and Julia
pre-installed, this is because Julia cannot be installed from conda.
For a minimal conda installation go to https://conda.io/miniconda.html.
Installation instructions for Julia can be found on the
`Julia download page <https://julialang.org/downloads/>`_.
`Julia download page <https://julialang.org/downloads/>`_. To install and link Julia
follow these steps:

* First get and extract Julia (here we get Julia 1.0.3):

.. code-block:: bash

wget https://julialang-s3.julialang.org/bin/linux/x64/1.0/julia-1.0.3-linux-x86_64.tar.gz
tar xfz julia-*-linux-x86_64.tar.gz

* Then link the executable to your miniconda ``bin`` where all other executables are:

.. code-block:: bash

ln -s $(pwd)/julia-*/bin/julia $(home)/miniconda3/bin/julia
Copy link
Contributor

Choose a reason for hiding this comment

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

This holds for the base environment, shouldn't this be: miniconda3/envs/esmvaltool/bin/ or another env?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no, you don't need to create an environment when installing directly from conda, it's just like installing any other software package by typing just one command (well, three commands in our case) 🍺

Copy link
Member

Choose a reason for hiding this comment

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

There is no need to try to link julia to the conda environment: so long as the julia executable can be found in one of the directories listed in PATH things should work fine

Copy link
Member

Choose a reason for hiding this comment

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

I think it would be better to just point users to the site with the julia installation instructions: https://julialang.org/downloads/platform/ or https://julialang.org/downloads/platform/#linux_and_freebsd if we want to be specific. If these instructions change, ours will become outdated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no, if those change we change the documentation too; man, a lot of the users prefer copy-paste instructions and going to see another set of instructions is already tedious for them 🍺

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is no need to try to link julia to the conda environment: so long as the julia executable can be found in one of the directories listed in PATH things should work fine

correct! change that line if you think it's better to append to $PATH, man, up to you


With Julia now installed we can go ahead and install first ``esmvalcore`` (it is needed
by ESMValTool and its installation in advance of ``esmvaltool`` helps ``conda`` solve the
environment much faster):
Comment on lines +45 to +46
Copy link
Member

Choose a reason for hiding this comment

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

While this works at the moment (see ESMValGroup/ESMValCore#660) this is usually not the most reliable way to install the package. There have been several occasions where conda failed to install esmvaltool into existing environments, because it was incompatible with the packages already installed and didn't know how to resolve that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

that is not cool at all on conda's part because it should supersede those dependencies that are already installed from installing esmvalcore gah


.. code-block:: bash

conda install -c conda-forge -c esmvalgroup esmvalcore

Once you have installed the above prerequisites, you can install ESMValTool by running:

Expand Down