Skip to content

Commit

Permalink
release: 8.0b2
Browse files Browse the repository at this point in the history
* update installation instructions *not* to use the meta package
* cylc/cylc-admin#130
* update installation instructions
* document instaling the cylc-rose package
  • Loading branch information
oliver-sanders committed Aug 5, 2021
1 parent 8e83ab0 commit fd03b25
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 41 deletions.
16 changes: 8 additions & 8 deletions src/7-to-8/cheat-sheet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -227,16 +227,16 @@ Generate a visualisation for a workflow without running it:
.. code-block:: bash

#!/usr/bin/env bash

set -eu

SUITE="$1"
FMT="$2"

TMP=dotfile

cylc graph --reference "$SUITE" 2>/dev/null > "$TMP.ref"

sed \
-e 's/node "\(.*\)" "\(.*\)"/"\1" [label="\2"]/' \
-e 's/edge "\(.*\)" "\(.*\)"/"\1" -> "\2"/' \
Expand All @@ -246,12 +246,12 @@ Generate a visualisation for a workflow without running it:
-e '/^stop$/d' \
"$TMP.ref" \
> "$TMP.dot"

dot \
"$TMP.dot" \
-T$FMT \
-o "$TMP.$FMT"

rm "$TMP.ref" "$TMP.dot"
echo "$TMP.$FMT"

Expand All @@ -270,7 +270,7 @@ Run a :ref:`rose:Rose Stem` test suite.
# install and start
rose stem
- ::

# install
rose stem

Expand Down
2 changes: 1 addition & 1 deletion src/7-to-8/major-changes/cylc-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Cylc Rose

.. seealso::

:ref:`cylc-rose` plugin documentation, which includes examples of how
:ref:`Cylc Rose` plugin documentation, which includes examples of how
to install a Cylc workflow with a Rose suite configuration with ``cylc install``.

.. TODO link to rose stem doc once it's done
Expand Down
76 changes: 46 additions & 30 deletions src/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,64 +10,75 @@ Installation
It has a fully functional Python 3 workflow service and CLI that can run
existing Cylc workflows.

**BUT:**
**But** it is not production-ready yet.

- It is not production-ready yet
Use the latest Cylc 7.9 (Python 2.7) or 7.8 (Python 2.6) release
for production systems.

Use the latest Cylc 7.9 (Python 2.7) or 7.8 (Python 2.6) release
for production systems.

- Do not use it where security is a concern
- The UI includes a prototype "tree view" with no control capability
- we are working on other views, and controls
- Data update in the UI is via polling at 5 second intervals, and monolithic
- future releases will use WebSockets and incremental update
Quick Installation
------------------

Cylc runs on Unix-like operating systems including Mac OS though at
present Cylc only tested on Linux.
Cylc runs on Unix systems including Linux and Mac OS.

.. highlight:: sub

Quick Installation
------------------
.. list-table::
:class: grid-table

Via Conda (recommended):
* - .. rubric:: Via Conda (recommeneded):
- .. rubric:: Via Pip (+npm):

.. code-block:: console
* - ::

# install cylc with the browser-GUI
$ conda install cylc
$ conda install cylc-flow

Via pip:
# install the browser-GUI (optional)
$ conda install cylc-uiserver

.. note::
# install Rose support (optional)
$ conda install cylc-rose

We recommend using a virtual environment.
- ::

.. note::
$ pip install cylc-flow

# install the browser-GUI (optional)
# (requires nodejs & npm)
$ pip install cylc-uiserver
$ npm install configurable-http-proxy

# install Rose support (optional)
$ pip install cylc-rose

* -
-
.. note::

Requires Python 3.7+

.. note::

Requires Python 3.7
We recommend using a virtual environment.

.. code-block:: console

# install the "core" cylc package
$ pip install cylc-flow
.. highlight:: bash

# install the browser-GUI
$ pip install cylc-uiserver

.. _non-python-requirements:

Non-Python Requirements
-----------------------

.. _configurable-http-proxy: https://anaconda.org/conda-forge/configurable-http-proxy

The following dependencies are not installed by Conda or pip:
These dependencies are not installed by Conda or pip:

* ``bash``
* GNU `coreutils`_
* ``mail`` (for automated email functionality)
* ``mail`` (optional: for automated email functionality)

The following dependencies are installed by Conda but not by pip:
These dependencies are installed by Conda but not by pip (you can use npm):

* `configurable-http-proxy`_

Expand Down Expand Up @@ -126,6 +137,8 @@ Cylc is split into a number of packages providing different functionality:
Provides the scheduler "kernel" of Cylc along with the command-line.
`Cylc UI Server`_
Provides the "Cylc Hub" and the browser-based "Cylc GUI".
:ref:`Cylc Rose`
Provides support for :ref:`Rose` suite configurations in Cylc workflows.

Installation Types
^^^^^^^^^^^^^^^^^^
Expand All @@ -150,11 +163,14 @@ Recommended Installation

User Machines
* `Cylc Flow`_
* :ref:`Cylc Rose` (if using :ref:`Rose`)
Cylc Servers
* `Cylc Flow`_
* :ref:`Cylc Rose` (if using :ref:`Rose`)
* `Cylc UI Server`_
Job Hosts:
* `Cylc Flow`_
* :ref:`Rose` (if running Rose applications on the job host)

.. _managing environments:

Expand Down
2 changes: 1 addition & 1 deletion src/plugins/cylc-rose.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _cylc-rose:
.. _Cylc Rose:

Cylc Rose
=========
Expand Down
2 changes: 1 addition & 1 deletion src/user-guide/installing-workflows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ directory.
- A new ``install`` directory in the workflow's log directory, with a
time-stamped install log file containing information about the installation.

Cylc plugins (such as :ref:`cylc-rose`) may generate additional files.
Cylc plugins (such as :ref:`Cylc Rose`) may generate additional files.


.. _Reinstalling a Workflow:
Expand Down

0 comments on commit fd03b25

Please sign in to comment.