Esmvaltool: Update installation guide

[mattiarighi]

Once namelist_perfmetrics_CMIP5.yml is finalized and tested (see also milestone), several users will start working to port their namelist to the new ESMValTool version.

It would be good to update the installation guide by then, also in view of these various related issues: #6, #68, #70, #166, #200 and #204.

[jvegasbsc]

I am writing a draft

[mattiarighi]

Great! Thank you!

[jvegasbsc]

Just some thing I want to check with you:

• I have moved part of the old installation guide to the introduction of the user guide, in particular the parts talking about licenses and contribution to the tool

• I say that we currently support python 2.7+ and 3.6+, but encourage users to use 3 because support for 2 will be discontinued in the future

• Three ways of installation: docker, conda and from source code. I need help with the docker part. Conda is a placeholder just telling that we will publish ESMVal in conda-forge in the future. I will update it when the package is ready

• I have added a section about testing installation in the source code part. This includes a command for running the automated tests that do not require any data to be available in the machine. I think we don have such a command now, but this will be a nice enhancement

[valeriupredoi]

Hey guys, on this topic, I want to get hold of a Mac and test the
installation on osx, there were serious problems at the Utrecht workshop
for a few with mac's

On 5 Feb 2018 10:25 am, "Javier Vegas-Regidor" [e-mail]
wrote:

Just some thing I want to check with you:

-

I have moved part of the old installation guide to the introduction of
the user guide, in particular the parts talking about licenses and
contribution to the tool
-

I say that we currently support python 2.7+ and 3.6+, but encourage
users to use 3 because support for 2 will be discontinued in the future
-

Three ways of installation: docker, conda and from source code. I need
help with the docker part. Conda is a placeholder just telling that we will
publish ESMVal in conda-forge in the future. I will update it when the
package is ready
-

I have added a section about testing installation in the source code
part. This includes a command for running the automated tests that do not
require any data to be available in the machine. I think we don have such a
command now, but this will be a nice enhancement

—
You are receiving this because you were assigned.
Reply to this email directly, view it on GitHub
https://github.com/ESMValGroup/ESMValTool/issues/214#issuecomment-363042613,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AbpCo2m_218-tymdcgdg6Ccd9TH6oCDYks5tRtcPgaJpZM4R1_ja
.

[bouweandela]

@jvegasbsc The command to run tests (without data) is python setup.py test.

[jvegasbsc]

@jvegasbsc The command to run tests (without data) is python setup.py test.

Thanks!

[mattiarighi]

•I have moved part of the old installation guide to the introduction of the user guide, in particular the parts talking about licenses and contribution to the tool

@axel-lauer is this OK?

[axel-lauer]

It seems you are working with an outdated version of the user guide. In particular the installation section has changed. It would therefore make sense to synchronize the already diverging documenations before continuing. Not sure what the best approach would be, though.

[jvegasbsc]

It seems you are working with an outdated version of the user guide.

In which branch is the most actual version of the user guide? I will merge it and then start from it

[bouweandela]

@jvegasbsc Maybe you can use the nightly build scripts in #221 as inspiration, though of course once we have a release, installing esmvaltool should be as easy as conda install esmvaltool.

[jvegasbsc]

First draft is ready, and available at http://esmvaltool.readthedocs.io/en/refactoring_user_guide/

I left empty the docker part, because I never used docker and prefer that some of you with more experience detail it.

The conda installation part is just telling that the final version will be available through conda but that is unlikely that any of the pre-release versions will be.

[mattiarighi]

Can you open a PR of the user-guide branch?
This will allow everybody to comment and suggest changes.

[jvegasbsc]

Done. Pull request #275 created