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.

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 / fix installation instructions #2826

Open
wants to merge 1 commit into
base: 2.3.x
Choose a base branch
from
Open
Changes from all commits
Commits
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
79 changes: 50 additions & 29 deletions sphinx/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,66 +10,87 @@ Rose runs on Unix-like systems including Linux and MacOS.
Quick Installation
------------------

With ``conda`` (recommended)::
With ``conda`` / ``mamba`` (recommended)::

$ conda install metomi-rose
$ conda install -c conda-forge metomi-rose

With ``pip`` (you will need to ensure `Non Python Dependencies`_ are met)::
With ``pip``::

$ pip install metomi-rose

Installing With Cylc
^^^^^^^^^^^^^^^^^^^^
Optional dependencies
^^^^^^^^^^^^^^^^^^^^^

Rose does not require and is distributed independently of `Cylc`_.
Rose has optional dependencies that enable extra functionalities.

Run :ref:`command-rose-check-software` to see which optional
dependencies are satisfied you your installation.

Cylc
""""

`Cylc`_ is a workflow engine which supports Rose configurations.

To use Rose with Cylc you will need to install `Cylc Flow`_ and `Cylc Rose`_
into the same Python environment as Rose.

With ``conda`` (recommended)::
With ``conda`` / ``mamba`` (recommended)::

$ conda install cylc-flow cylc-rose
$ conda install -c conda-forge cylc-flow cylc-rose metomi-rose

With ``pip`` (you will need to ensure `Non Python Dependencies`_ are met)::
With ``pip``::

$ pip install cylc-flow cylc-rose
$ pip install cylc-flow cylc-rose metomi-rose

.. note::

`Cylc`_ is a distributed system, not all dependencies are required on all
platforms.

See the `Cylc`_ installation instructions for more information.
See the :ref:`Cylc installation instructions <cylc:installation>` for more
information.

.. TODO
Git
"""

This reference will pass once intersphinx has a more contemporary
version of cylc-doc to point at (see conf.py)
Some Rose commands can be configured to acquire files from Git repositories:

See the :ref:`Cylc installation instructions <cylc:installation>` for more
information.
* ``rose app-run``
* ``rose task-run``
* ``cylc install``

Non Python Dependencies
^^^^^^^^^^^^^^^^^^^^^^^
Ensure Git is installed to activate this support if required.

Subversion
""""""""""

The following packages are installed by ``conda`` but not by ``pip``:
Subversion & `FCM`_ are required for :ref:`Rosie <tutorial-rosie>`
and for installing files from Subversion using FCM keywords by:

* FCM
* ``rose app-run``
* ``rose task-run``
* ``cylc install``

The following dependencies are required for subversion support:

* `FCM`_
* Perl
* Python3
* Subversion

If installing via ``pip`` run :ref:`command-rose-check-software` to ensure
non-Python dependencies are satisfied.
Run :ref:`command-rose-check-software` to ensure all required dependencies are
installed.

.. note::
Graphviz
""""""""

Rose has some optional graphing functionalities which require GraphViz.

The Conda Forge ``metomi-rose`` package has this support enabled by default.

Subversion & FCM are required for installing files from Subversion using FCM
keywords by:
If installing via ``pip``, you will need to provide Graphviz, then install
Rose with the ``graph`` optional dependency::

+ ``rose app-run``
+ ``rose task-run``
+ ``cylc install``
$ pip install metomi-rose[graph]


Configuring Rose
Expand Down
Loading