conda builds

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

@@ -0,0 +1,33 @@
+name: conda builds
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+  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: 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/admin-guide/environments/${{matrix.case}}-${{matrix.python}}.yml ]]; then
+            conda env create -f \
+              src/admin-guide/environments/${{matrix.case}}-${{matrix.python}}.yml
+          else
+            conda env create -f \
+              src/admin-guide/environments/${{matrix.case}}.yml \
+              python==${{matrix.python}}
+          fi

src/admin-guide/environments/basic-3.7.yml

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

src/admin-guide/environments/basic-3.8.yml

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

src/admin-guide/environments/basic-3.9.yml

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

src/admin-guide/environments/example_envs.rst

@@ -0,0 +1,64 @@
+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`_, ✔️,✔️,✔️,
+   `Cylc 8 basic live from github`_, ✔️, , ,✔️
+   `Cylc 8 with rose and GUI live from github`_,✔️,✔️,✔️,✔️
+
+Example installation command:
+
+.. 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
+------------
+
+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
+---------------------
+
+.. literalinclude:: gui.yml
+   :language: YAML
+
+Cylc 8 with Rose
+----------------
+
+.. literalinclude:: rose.yml
+   :language: YAML
+
+Cylc 8 basic live from github
+-----------------------------
+
+.. literalinclude:: live-basic.yml
+   :language: YAML
+
+Cylc 8 with rose and GUI live from github
+-----------------------------------------
+
+.. literalinclude:: live-full.yml
+   :language: YAML

src/admin-guide/environments/gui.yml

@@ -0,0 +1,135 @@
+name: cylc-8-with-gui
+# Cylc 8 and the UI server installed from Conda
+channels:
+  - defaults
+  - conda-forge
+  - kinow
+dependencies:
+  - _libgcc_mutex=0.1=main
+  - _openmp_mutex=4.5=1_gnu
+  - aiofiles=0.5.0=py37_0
+  - alembic=1.6.4=pyhd3eb1b0_0
+  - aniso8601=7.0.0=py_0
+  - ansimarkup=1.5.0=pyh44b312d_0
+  - asn1crypto=1.4.0=py_0
+  - async_generator=1.10=py37h28b3542_0
+  - attrs=21.2.0=pyhd3eb1b0_0
+  - blas=1.0=mkl
+  - blinker=1.4=py37h06a4308_0
+  - brotli=1.0.9=he6710b0_2
+  - brotlipy=0.7.0=py37h27cfd23_1003
+  - ca-certificates=2021.7.5=h06a4308_1
+  - certifi=2021.5.30=py37h06a4308_0
+  - certipy=0.1.3=py_0
+  - cffi=1.14.0=py37h2e261b9_0
+  - charset-normalizer=2.0.4=pyhd3eb1b0_0
+  - click=8.0.1=pyhd3eb1b0_0
+  - colorama=0.4.4=pyhd3eb1b0_0
+  - configurable-http-proxy=4.2.3=node12_hac6e442_0
+  - cryptography=2.3.1=py37hc365091_0
+  - cycler=0.10.0=py37_0
+  - cylc=8.0b1=py37h89c1867_0
+  - cylc-flow=8.0b1=py37h89c1867_0
+  - cylc-ui=0.5.0=ha770c72_0
+  - cylc-uiserver=0.4.0=py37h89c1867_0
+  - empy=3.3.4=pyh9f0ad1d_1
+  - entrypoints=0.3=py37_0
+  - fonttools=4.25.0=pyhd3eb1b0_0
+  - freetype=2.10.4=h5ab3b9f_0
+  - graphene=2.1.9=pyhd8ed1ab_0
+  - graphene-tornado=2.6.1=py_0
+  - graphql-core=2.3.2=pyh9f0ad1d_0
+  - graphql-relay=2.0.1=py_0
+  - graphql-ws=0.3.1=pyh9f0ad1d_1
+  - greenlet=1.1.1=py37h295c915_0
+  - idna=3.2=pyhd3eb1b0_0
+  - importlib-metadata=3.10.0=py37h06a4308_0
+  - importlib_metadata=3.10.0=hd3eb1b0_0
+  - intel-openmp=2021.3.0=h06a4308_3350
+  - ipython_genutils=0.2.0=pyhd3eb1b0_1
+  - jinja2=2.11.0=py_0
+  - jpeg=9b=h024ee3a_2
+  - jsonschema=3.2.0=py_2
+  - jupyter_telemetry=0.1.0=py_0
+  - jupyterhub=1.3.0=py37h06a4308_1
+  - jupyterhub-base=1.3.0=py37h06a4308_1
+  - kiwisolver=1.3.1=py37h2531618_0
+  - lcms2=2.12=h3be6417_0
+  - libcurl=7.61.1=heec0ca6_0
+  - libedit=3.1.20210714=h7f8727e_0
+  - libffi=3.2.1=hf484d3e_1007
+  - libgcc-ng=9.3.0=h5101ec6_17
+  - libgomp=9.3.0=h5101ec6_17
+  - libpng=1.6.37=hbc83047_0
+  - libprotobuf=3.15.8=h780b84a_0
+  - libsodium=1.0.18=h7b6447c_0
+  - libssh2=1.8.0=h9cfc8f7_4
+  - libstdcxx-ng=9.3.0=hd4cf53a_17
+  - libtiff=4.2.0=h85742a9_0
+  - libwebp-base=1.2.0=h27cfd23_0
+  - lz4-c=1.9.3=h295c915_1
+  - mako=1.1.4=pyhd3eb1b0_0
+  - markupsafe=2.0.1=py37h27cfd23_0
+  - matplotlib-base=3.4.2=py37hab158f2_0
+  - metomi-isodatetime=1!2.0.2=py_0
+  - mkl=2021.3.0=h06a4308_520
+  - mkl-service=2.4.0=py37h7f8727e_0
+  - mkl_fft=1.3.0=py37h42c9631_2
+  - mkl_random=1.2.2=py37h51133e4_0
+  - munkres=1.1.4=py_0
+  - ncurses=6.2=he6710b0_1
+  - nodejs=12.4.0=he1b5a44_0
+  - numpy=1.20.3=py37hf144106_0
+  - numpy-base=1.20.3=py37h74d4b33_0
+  - oauthlib=3.1.0=py_0
+  - olefile=0.46=py37_0
+  - openjpeg=2.4.0=h3ad879b_0
+  - openssl=1.0.2u=h7b6447c_0
+  - packaging=21.0=pyhd3eb1b0_0
+  - pamela=1.0.0=py_0
+  - pandas=0.25.3=py37he6710b0_0
+  - pillow=8.3.1=py37h2c7a002_0
+  - pip=21.2.2=py37h06a4308_0
+  - prometheus_client=0.11.0=pyhd3eb1b0_0
+  - promise=2.3=py37h06a4308_0
+  - protobuf=3.15.8=py37hcd2ae1e_0
+  - psutil=5.8.0=py37h27cfd23_1
+  - pyasn1=0.4.8=py_0
+  - pycparser=2.20=py_2
+  - pycurl=7.43.0.2=py37hb7f436b_0
+  - pyjwt=1.7.1=py37_0
+  - pympler=0.9=py_0
+  - pyopenssl=19.0.0=py37_0
+  - pyparsing=2.4.7=pyhd3eb1b0_0
+  - pyrsistent=0.17.3=py37h7b6447c_0
+  - pysocks=1.7.1=py37_1
+  - python=3.7.0=h6e4f718_3
+  - python-dateutil=2.8.2=pyhd3eb1b0_0
+  - python-editor=1.0.4=py_0
+  - python-json-logger=2.0.1=py_0
+  - python_abi=3.7=2_cp37m
+  - pytz=2021.1=pyhd3eb1b0_0
+  - pyuv=1.4.0=py37h5e8e339_1003
+  - pyzmq=19.0.2=py37he6710b0_1
+  - readline=7.0=h7b6447c_5
+  - requests=2.26.0=pyhd3eb1b0_0
+  - ruamel.yaml=0.16.12=py37h7b6447c_1
+  - ruamel.yaml.clib=0.2.2=py37h7b6447c_0
+  - rx=1.6.1=py_0
+  - setuptools=52.0.0=py37h06a4308_0
+  - six=1.16.0=pyhd3eb1b0_0
+  - sqlalchemy=1.4.22=py37h7f8727e_0
+  - sqlite=3.33.0=h62c20be_0
+  - tk=8.6.10=hbc83047_0
+  - tornado=6.1=py37h27cfd23_0
+  - traitlets=5.0.5=pyhd3eb1b0_0
+  - typing_extensions=3.10.0.0=pyh06a4308_0
+  - urllib3=1.26.6=pyhd3eb1b0_1
+  - urwid=2.0.1=py37h516909a_1000
+  - werkzeug=0.12.2=py_1
+  - wheel=0.37.0=pyhd3eb1b0_0
+  - xz=5.2.5=h7b6447c_0
+  - zeromq=4.3.4=h2531618_0
+  - zipp=3.5.0=pyhd3eb1b0_0
+  - zlib=1.2.11=h7b6447c_3
+  - zstd=1.4.9=haebb681_0

src/admin-guide/environments/live-basic.yml

@@ -0,0 +1,30 @@
+name: cylc-8-basic
+# Cylc 8 without GUI installed from the default GitHub branch.
+channels:
+  - defaults
+  - conda-forge
+  - kinow
+dependencies:
+  - _libgcc_mutex=0.1=main
+  - _openmp_mutex=4.5=1_gnu
+  - ca-certificates=2021.7.5=h06a4308_1
+  - certifi=2021.5.30=py39h06a4308_0
+  - ld_impl_linux-64=2.35.1=h7274673_9
+  - libffi=3.3=he6710b0_2
+  - libgcc-ng=9.3.0=h5101ec6_17
+  - libgomp=9.3.0=h5101ec6_17
+  - libstdcxx-ng=9.3.0=hd4cf53a_17
+  - ncurses=6.2=he6710b0_1
+  - openssl=1.1.1k=h27cfd23_0
+  - pip=21.2.4=py37h06a4308_0
+  - python=3.9.6=h12debd9_1
+  - readline=8.1=h27cfd23_0
+  - setuptools=52.0.0=py39h06a4308_0
+  - sqlite=3.36.0=hc218d9a_0
+  - tk=8.6.10=hbc83047_0
+  - tzdata=2021a=h5d7bf9c_0
+  - wheel=0.37.0=pyhd3eb1b0_0
+  - xz=5.2.5=h7b6447c_0
+  - zlib=1.2.11=h7b6447c_3
+  - pip:
+    - git+https://github.com/cylc/cylc-flow.git

src/admin-guide/environments/live-full.yml

@@ -0,0 +1,16 @@
+name: cylc-8-live-with-rose
+# Cylc 8, the UI server, Cylc Rose and Metomi Rose
+# n.b. The UI needs to be installed with Yarn: For details see
+# https://github.com/cylc/cylc-ui
+channels:
+  - defaults
+  - conda-forge
+  - kinow
+dependencies:
+  - python
+  - 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