Skip to content

Commit

Permalink
Update installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MetRonnie committed Jan 9, 2025
1 parent 1c21e27 commit d8510f6
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions src/installation.rst
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

0 comments on commit d8510f6

Please sign in to comment.