Skip to content

Added troubleshooting for installing cf next to Jupyter and conda #884

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

Merged
merged 3 commits into from
Aug 8, 2025
Merged

Added troubleshooting for installing cf next to Jupyter and conda #884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82b3913
Added troubleshooting for installing cf next to Jupyter and conda
ThatDesert Aug 5, 2025
ce5df2e
Update docs/source/installation.rst
ThatDesert Aug 8, 2025
371590b
Update contributing.rst
ThatDesert Aug 8, 2025
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
1 change: 1 addition & 0 deletions docs/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ ideas, code, and documentation to the cf library:
* Mark Rhodes-Smith
* Matt Brown
* Michael Decker
* Oliver Kotla
* Sadie Bartholomew
* Thibault Hallouin
* Tim Bradshaw
Expand Down
19 changes: 19 additions & 0 deletions docs/source/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,25 @@ Note that :ref:`some environment variables might also need setting
<UNIDATA-UDUNITS-2-library>` in order for the Udunits library to work
properly, although the defaults are usually sufficient.

.. _Jupyter Notebooks:

Jupyter Notebooks
^^^^^^^^^^^^^^^^^

You may want to work with cf via a Jupyter Notebook within a ``conda`` environment.

A `known issue <https://github.com/NCAS-CMS/cf-python/issues/883/>`_ exists for Python 3.12 only when one wants to install the optional dependency ESMPy. Namely, the stricter dependencies of the Jupyter library clash with those of cf (namely ``zlib`` required by ESMPy) and installation fails.

A proven workaround is to install Jupyter *before* installing cf, like so:

.. code-block:: console
:caption: *Install with conda alongside Jupyter.*

$ conda install jupyter
$ conda install -c conda-forge cf-python cf-plot udunits2
$ conda install -c conda-forge "esmpy>=8.7.0"


----

.. _Source:
Expand Down