Extended the installation description #3958

MHBalsmeier · 2021-01-26T09:19:55Z

🚀 Pull Request

Description

As mentioned in Issue 3949, installation of Iris on Ubuntu was very difficult. I described an easy way to install Iris on Ubuntu without conda in the installation file in the documentation.

As mentioned in Issue 3949, installation of Iris on Ubuntu was very difficult. I described an easy way to install Iris on Ubuntu without conda here.

MHBalsmeier · 2021-01-26T09:42:55Z

Just signed this CLA.

MHBalsmeier · 2021-01-26T09:56:22Z

Maybe someone can help me with why these tests fail?

tkknight · 2021-01-26T10:15:54Z

The two doc tasks have failed as there are some warnings in the build. The build flag to promote warnings to errors is enabled, this ensures the documentation does not degrade over time.

I think the warnings seem to be:

/tmp/cirrus-ci-build/docs/iris/src/developers_guide/contributing_code_formatting.rst:25: WARNING: undefined label: installing_from_source
/tmp/cirrus-ci-build/docs/iris/src/developers_guide/contributing_running_tests.rst:8: WARNING: undefined label: installing_from_source
/tmp/cirrus-ci-build/docs/iris/src/whatsnew/3.0.rst:262: WARNING: undefined label: installing_from_source

(see this on cirrus: https://cirrus-ci.com/task/6044147754729472?command=tests#L593)

I think you may have renamed the existing label _installing_from_source to be _installing_from_source_with_conda, meaning the existing references to the old label are now flagging an error.

I suggest you rename the label back, or correct the references in the above three files.

HTH.

_installing_from_source_with_conda -> _installing_from_source because tests failed

MHBalsmeier · 2021-01-26T11:39:17Z

Don't know what went wrong now. Is it because of this:

(line 245) broken https://www.unidata.ucar.edu/software/udunits/udunits-current/doc/udunits/udunits2.html - 404 Client Error: Not Found for url: https://www.unidata.ucar.edu/software/udunits/udunits-current/doc/udunits/udunits2.html

maybe?

trexfeathers · 2021-01-26T11:41:09Z

The change in #3942 is due to be merged back into master branch in the next couple of days, which will fix the link check failure. I suggest waiting for this mergeback and then rebasing your branch onto master once that happens.

trexfeathers · 2021-01-26T14:30:51Z

... alternatively you could just cherry pick the relevant commit (83d1b72) onto your branch as soon as you like:

git cherry-pick 83d1b72

* update links * added s to http

tkknight · 2021-01-26T15:29:39Z

The changes render html ok. I would suggest that the new lines added are limited to 80 chars in length as it makes reading the source .rst files much easier. The only exceptions are when you embed commands, so the sudo and pip3 commands are ok on a single line.

I hope that makes sense. We should be get to get this approved and then merged.

MHBalsmeier · 2021-01-26T15:43:20Z

The commit I did from the command line (c557a20) screwed it up I think. CLA-checker refuses to accept it now.
I had the wrong email address in git config. I am not sure if I can fix this now.

trexfeathers · 2021-01-26T16:09:42Z

I am not sure if I can fix this now.

Re-do those commits using a rebase or reset, then push -f to apply those changes to this PR?

MHBalsmeier · 2021-01-26T17:53:54Z

Should be okay now.

bjlittle · 2021-01-26T18:54:55Z

@MHBalsmeier Awesome! Thanks for taking the time to contribute this PR - it's really appreciated 😀

As an aside, I'm soon to push the iris 3.0.0 release to PyPI. It would be great if you could test a pip install given your installation on ubuntu.

Fancy confirming whether the install of 3.0.0 works from PyPI?

bjlittle · 2021-01-26T19:00:59Z

@MHBalsmeier Also, could you make an entry for your PR in the docs/iris/src/whatsnew/latest.rst?

We're keen to recognise your valued contribution 👍

bjlittle · 2021-01-26T22:11:07Z

docs/iris/src/installing.rst

+Finally, Iris and its Python dependencies can be installed with the following
+command::
+
+ pip3 install astropy tqdm oktopus bs4 setuptools nc_time_axis cython cfunits cf-units cf-python pandas stratify pyugrid scitools-pyke black imagehash nose asv scitools-iris


@MHBalsmeier You seem to have quite a few extra dependencies and optional dependencies mixed in here... would it be possible to strip this example back to it's essential bare minimum?

I'm guessing that this is the package dependency requirements for your specific area of research/work.

The following appear to extra dependencies for your particular needs:

astropy

tqdm

oktopus

bs4

cython

cf-python

asv

The following appear to be optional dependencies of iris, but not strictly necessary:

nc_time_axis

pandas

stratify

pyugrid

black

imagehash

nose

I'm also assuming that cfunits isn't a necessary dependency for cf-units? (cfunits is a similar package as our SciTools cf-units, which is maintained by David Hassell from Reading University)

So, I guess my question is, could this actually boil down to simply:

> pip3 install setuptools cf-units scitools-pyke scitools-iris

Although, I'm guessing (off the top of my head) that cython is necessary for cf-units? If that's the case then we have:

> pip3 install setuptools cython cf-units scitools-pyke scitools-iris

Is it possible for you to confirm this?

bjlittle · 2021-01-26T22:12:39Z

@MHBalsmeier BTW I've just uploaded scitools-iris 3.0.0 to PyPI... fancy giving it a try? 😄

MHBalsmeier · 2021-01-27T01:03:49Z

The way I have it now works with v3.0.0. cftime would throw an error if not included explicitly with a version number due to a dependency conflict.

bjlittle

@MHBalsmeier Awesome work! Thank you! 💯 🎉 🍻

LGTM... @trexfeathers I'll leave you review and merge when your happy 👍

…Tools#3940.

* master: remove explicit URLs for core dev names from latest.rst (SciTools#3973) document that iris.coords.Coord is an ABC (SciTools#3971) reorganise docs common links + add core devs (SciTools#3972) Docs whatsnew add dropdowns to the template (SciTools#3969) Docs whatsnew enumerated lists (SciTools#3970) Merge back v3p0p1 (SciTools#3966) Captilise installation heading - align SciTools#3958 content with SciTools#3940. (SciTools#3963) Merge back v3p0p0 (SciTools#3960) Extended the installation description (SciTools#3958)

* master: (23 commits) Added text to state the Python version used to build the docs. (SciTools#3989) add nox session conda list (SciTools#3990) Add abstract cube summary (SciTools#3987) automate docs discovery of iris and python versions (SciTools#3981) corrected syntax (SciTools#3980) core dev whatsnew entry (SciTools#3978) moved docs dir and updated references to it (SciTools#3975) Fix test_incompatible_dimensions test (SciTools#3977) remove explicit URLs for core dev names from latest.rst (SciTools#3973) document that iris.coords.Coord is an ABC (SciTools#3971) reorganise docs common links + add core devs (SciTools#3972) Docs whatsnew add dropdowns to the template (SciTools#3969) Docs whatsnew enumerated lists (SciTools#3970) Merge back v3p0p1 (SciTools#3966) Captilise installation heading - align SciTools#3958 content with SciTools#3940. (SciTools#3963) Merge back v3p0p0 (SciTools#3960) Extended the installation description (SciTools#3958) Put cube data on the x axis if plotting just a cube against a vertical or y coordinate (SciTools#3906) remove stock_mdi_arrays.npz (SciTools#3913) Gallery: update seasonal ensemble example (SciTools#3933) ...

Extended the installation description

34e06c9

As mentioned in Issue 3949, installation of Iris on Ubuntu was very difficult. I described an easy way to install Iris on Ubuntu without conda here.

SciTools-assistant added the Blocked: CLA needed See https://scitools.org.uk. Submit the form at: https://scitools.org.uk/cla/v4/form label Jan 26, 2021

Renamed a label.

daa6490

_installing_from_source_with_conda -> _installing_from_source because tests failed

SciTools-assistant removed the Blocked: CLA needed See https://scitools.org.uk. Submit the form at: https://scitools.org.uk/cla/v4/form label Jan 26, 2021

Formatting of code improved.

9672f48

update links (#3942)

dee1f3c

* update links * added s to http

Reset.

d82f4e4

bjlittle added New: Pull Request Type: Documentation labels Jan 26, 2021

bjlittle reviewed Jan 26, 2021

View reviewed changes

MHBalsmeier added 2 commits January 27, 2021 01:15

Simplified installation and modified latest.rst.

3b85f06

Included missing link in latest.rst.

96911c1

bjlittle approved these changes Jan 27, 2021

View reviewed changes

trexfeathers merged commit e7eced5 into SciTools:master Jan 27, 2021

bjlittle mentioned this pull request Jan 27, 2021

Installing Iris without Conda on Ubuntu is VERY difficult. #3949

Closed

trexfeathers mentioned this pull request Jan 27, 2021

Merge back v3p0p0 #3960

Merged

trexfeathers added a commit to trexfeathers/iris that referenced this pull request Jan 27, 2021

Captilise installation heading - align SciTools#3958 content with Sci…

844dcef

…Tools#3940.

trexfeathers mentioned this pull request Jan 27, 2021

Capitilise installation heading #3963

Merged

rcomer pushed a commit that referenced this pull request Jan 27, 2021

Captilise installation heading - align #3958 content with #3940. (#3963)

f0d72f7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extended the installation description #3958

Extended the installation description #3958

MHBalsmeier commented Jan 26, 2021

MHBalsmeier commented Jan 26, 2021

MHBalsmeier commented Jan 26, 2021

tkknight commented Jan 26, 2021

MHBalsmeier commented Jan 26, 2021

trexfeathers commented Jan 26, 2021

trexfeathers commented Jan 26, 2021

tkknight commented Jan 26, 2021

MHBalsmeier commented Jan 26, 2021 •

edited

Loading

trexfeathers commented Jan 26, 2021

MHBalsmeier commented Jan 26, 2021

bjlittle commented Jan 26, 2021

bjlittle commented Jan 26, 2021

bjlittle Jan 26, 2021

bjlittle commented Jan 26, 2021

MHBalsmeier commented Jan 27, 2021

bjlittle left a comment

Extended the installation description #3958

Extended the installation description #3958

Conversation

MHBalsmeier commented Jan 26, 2021

🚀 Pull Request

Description

MHBalsmeier commented Jan 26, 2021

MHBalsmeier commented Jan 26, 2021

tkknight commented Jan 26, 2021

MHBalsmeier commented Jan 26, 2021

trexfeathers commented Jan 26, 2021

trexfeathers commented Jan 26, 2021

tkknight commented Jan 26, 2021

MHBalsmeier commented Jan 26, 2021 • edited Loading

trexfeathers commented Jan 26, 2021

MHBalsmeier commented Jan 26, 2021

bjlittle commented Jan 26, 2021

bjlittle commented Jan 26, 2021

bjlittle Jan 26, 2021

Choose a reason for hiding this comment

bjlittle commented Jan 26, 2021

MHBalsmeier commented Jan 27, 2021

bjlittle left a comment

Choose a reason for hiding this comment

MHBalsmeier commented Jan 26, 2021 •

edited

Loading