conda builds

.github/workflows/conda-build-test.yml

@@ -0,0 +1,42 @@
+name: conda builds
+
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/conda-build-test.yml'
+      - 'src/reference/environments/*.ya?ml'
+  schedule:
+    - cron: '17 22 * * 6'
+  workflow_dispatch:
+
+jobs:
+  test_conda_install:
+    runs-on: ubuntu-18.04
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        case: [basic, gui, rose, live-basic, live-full]
+        python: [3.7, 3.8, 3.9]
+    steps:
+      # - name: install conda
+      #   run: |
+      #     wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
+      #     chmod +x Miniconda3-latest-Linux-x86_64.sh
+      #     bash Miniconda3-latest-Linux-x86_64.sh -y
+
+      - name: checkout cylc-doc
+        uses: actions/checkout@v2
+
+      - name: build conda env ${{matrix.case}}
+        run: |
+          # Done like this so that we test all versions of python,
+          # and offer users examples of basic with all three versions
+          # but don't have to have three env.yml files for each case.
+          if [[ -f src/reference/environments/${{matrix.case}}-${{matrix.python}}.yml ]]; then
+            conda env create -f \
+              src/reference/environments/${{matrix.case}}-${{matrix.python}}.yml
+          else
+            conda env create -f \
+              src/reference/environments/${{matrix.case}}.yml \
+              python==${{matrix.python}}
+          fi

src/reference/environments/basic-3.7.yml

@@ -0,0 +1,8 @@
+name: cylc-8-basic-python-3.7
+# Cylc 8 without GUI installed from Conda Repos.
+channels:
+  - conda-forge
+dependencies:
+  - python=3.7
+  - cylc-flow=8.*
+  - pip

src/reference/environments/basic-3.8.yml

@@ -0,0 +1,8 @@
+name: cylc-8-basic-python-3.8
+# Cylc 8 without GUI installed from Conda Repos.
+channels:
+  - conda-forge
+dependencies:
+  - python=3.8
+  - cylc-flow=8.*
+  - pip

src/reference/environments/basic-3.9.yml

@@ -0,0 +1,8 @@
+name: cylc-8-basic-python-3.9
+# Cylc 8 without GUI installed from Conda Repos.
+channels:
+  - conda-forge
+dependencies:
+  - python=3.9
+  - cylc-flow=8.*
+  - pip

src/reference/environments/example_envs.rst

@@ -0,0 +1,76 @@
+Example Environments
+====================
+
+A set of possible installations of Cylc:
+
+.. csv-table::
+   :header-rows:1
+
+   environment, cylc, cylc uiserver, rose, install latest from github
+   `Cylc 8 basic`_, ✔️, , ,
+   `Cylc 8 with UI Server`_, ✔️,✔️, ,
+   `Cylc 8 with Rose`_, ✔️,✔️,✔️,
+   :ref:`Cylc 8 basic live from github <liveFromGH>`, ✔️, , ,✔️
+   :ref:`Cylc 8 with rose and GUI live from github <liveFromGH>`,✔️,✔️,✔️,✔️
+
+Example installation commands:
+
+.. code-block:: bash
+
+   conda env create -f path/to/env.yml --name "name of env"
+
+   # ..or if you haven't specified a python version in the enviroment file:
+   conda env create -f path/to/env.yml --name "name of env" python==<version>
+
+
+Cylc 8 basic
+------------
+
+In this case we are collecting the core workflow engine.
+
+Also demonstrates using different versions of Python.
+
+.. literalinclude:: basic-3.7.yml
+   :language: YAML
+
+
+.. literalinclude:: basic-3.8.yml
+   :language: YAML
+
+
+.. literalinclude:: basic-3.9.yml
+   :language: YAML
+
+Cylc 8 with UI Server
+---------------------
+
+Create an enviroment containing the workflow engine and the GUI components
+from releases available on conda-forge.
+
+.. literalinclude:: gui.yml
+   :language: YAML
+
+Cylc 8 with Rose
+----------------
+
+In addition to the GUI components also add the Cylc-Rose plugin, and the
+Rose configuration management system.
+
+.. literalinclude:: rose.yml
+   :language: YAML
+
+.. _liveFromGH:
+
+Cylc 8 live from github
+-----------------------
+
+In this case the ``enviroment.yml`` file will create a new enviroment and
+download the latest development version of Cylc from github. One could
+add ``@branch``, ``@hash`` or ``@tag`` to the end of the URL to specify a
+particular version.
+
+.. literalinclude:: live-basic.yml
+   :language: YAML
+
+.. literalinclude:: live-full.yml
+   :language: YAML

src/reference/environments/gui.yml

@@ -0,0 +1,6 @@
+name: cylc-8-with-gui
+# Cylc 8 and the GUI installed from Conda
+channels:
+  - conda-forge
+dependencies:
+  - cylc

src/reference/environments/live-basic.yml

@@ -0,0 +1,9 @@
+name: cylc-8-live-basic
+# Cylc 8 without GUI installed from the default GitHub branch.
+channels:
+  - conda-forge
+dependencies:
+  - python=3.9
+  - pip
+  - pip:
+    - git+https://github.com/cylc/cylc-flow.git

src/reference/environments/live-full.yml

@@ -0,0 +1,12 @@
+name: cylc-8-live-with-rose
+# Cylc 8, the UI and UI server, Cylc Rose and Metomi Rose
+channels:
+  - conda-forge
+dependencies:
+  - python=3.9
+  - pip
+  - pip:
+    - git+https://github.com/cylc/cylc-flow.git
+    - git+https://github.com/cylc/cylc-uiserver.git
+    - git+https://github.com/metomi/rose.git
+    - git+https://github.com/cylc/cylc-rose.git

src/reference/environments/rose.yml

@@ -0,0 +1,10 @@
+name: cylc-8-with-rose
+# Cylc 8, the UI server, Cylc Rose and Metomi Rose
+channels:
+  - conda-forge
+dependencies:
+  - cylc
+  - cylc-rose
+  - cylc-ui
+  - cylc-uiserver
+  - metomi-rose

src/reference/index.rst

@@ -7,4 +7,5 @@ Reference
 
    config/index
    api/index
+   environments/example_envs.rst
    dev-history-major-changes