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

Update installation docs #793

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Update installation docs #793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions src/dictionaries/proper_nouns
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@ IDL
Jinja
jinja
Jupyter
libmamba
loadleveler
lsf
Micromamba
moab
Moab
Nano
Expand Down
24 changes: 16 additions & 8 deletions src/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,19 @@ Cylc runs on Unix-like systems including Linux and Mac OS.
Via Conda (recommended)
^^^^^^^^^^^^^^^^^^^^^^^

.. note::
.. admonition:: Supported Python versions

* cylc-flow supports Python 3.8+.
* cylc-uiserver currently only supports Python 3.8-3.9.

We recommend using the fast Mamba environment solver to install Cylc.
Mamba can be used as `a drop-in replacement for the conda command
<https://mamba.readthedocs.io/en/latest/index.html>`_,
or as `a conda command plugin
.. tip::

We recommend using Mamba to install Cylc.
Mamba (or Micromamba) can be used as
`a faster, drop-in replacement for the conda command
<https://mamba.readthedocs.io/en/latest/index.html>`_.
If using Conda, make sure to use the libmamba-solver by updating to
Conda 23.10 or using the `conda-libmamba-solver plugin for conda
<https://conda.github.io/conda-libmamba-solver/getting-started/>`_.
The classic conda environment solver may be too slow for a complex package
like Cylc.
Expand All @@ -39,9 +46,10 @@ Via Conda (recommended)
Via Pip (+npm)
^^^^^^^^^^^^^^

.. note::
.. admonition:: Supported Python versions

Requires Python 3.7 - 3.9
* cylc-flow supports Python 3.7+.
* cylc-uiserver currently only supports Python 3.8-3.9.

.. important::

Expand Down Expand Up @@ -139,7 +147,7 @@ your ``$PATH``, follow the instructions in the ``brew install`` output.

.. warning::

For Mac OS Versions 10.15.0 (Catalina) and higher SSH is disabled by
For Mac OS Versions 10.15.0 (Catalina) and higher, SSH is disabled by
default. The ability to SSH into your Mac OS box may be required for
certain Cylc installations.

Expand Down
Loading