-
Notifications
You must be signed in to change notification settings - Fork 19
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
proposal: meta package #234
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -30,47 +30,69 @@ present Cylc only tested on Linux. | |||||
Quick Installation | ||||||
------------------ | ||||||
|
||||||
Via Conda (recommended): | ||||||
Conda (recommended) | ||||||
^^^^^^^^^^^^^^^^^^^ | ||||||
|
||||||
Base installation (just the :term:`scheduler`): | ||||||
|
||||||
.. code-block:: console | ||||||
|
||||||
# install cylc with the browser-GUI | ||||||
$ conda install cylc | ||||||
|
||||||
Via pip: | ||||||
Full installation with the UI Server and Rose | ||||||
:ref:`Cylc components <Cylc components>`. | ||||||
|
||||||
.. note:: | ||||||
.. code-block:: console | ||||||
|
||||||
We recommend using a virtual environment. | ||||||
$ conda install cylc cylc.uiserver cylc.rose | ||||||
|
||||||
.. note:: | ||||||
Pip | ||||||
^^^ | ||||||
|
||||||
.. warning:: | ||||||
|
||||||
You must ensure :ref:`non-Python dependencies` have been installed via | ||||||
other means. | ||||||
|
||||||
Requires Python 3.7 | ||||||
.. tip:: | ||||||
.. _venv: https://docs.python.org/3/tutorial/venv.html | ||||||
.. _pipenv: https://pipenv.pypa.io/en/latest/ | ||||||
|
||||||
We recommend using a virtual Python environement such as `venv`_ or | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
`pipenv`_. | ||||||
|
||||||
Base installation (just the :term:`scheduler`): | ||||||
|
||||||
.. code-block:: console | ||||||
|
||||||
# install the "core" cylc package | ||||||
$ pip install cylc-flow | ||||||
$ pip install cylc | ||||||
|
||||||
# install the browser-GUI | ||||||
$ pip install cylc-uiserver | ||||||
Full installation with the UI Server and Rose | ||||||
:ref:`Cylc components <Cylc components>`. | ||||||
|
||||||
.. code-block:: console | ||||||
|
||||||
$ pip install cylc[uiserver,rose] | ||||||
|
||||||
Non-Python Requirements | ||||||
|
||||||
.. _non-Python dependencies: | ||||||
|
||||||
Non-Python Dependencies | ||||||
----------------------- | ||||||
|
||||||
.. _configurable-http-proxy: https://anaconda.org/conda-forge/configurable-http-proxy | ||||||
|
||||||
The following dependencies are installed by Conda but not by pip: | ||||||
|
||||||
* `configurable-http-proxy`_ | ||||||
* Python | ||||||
|
||||||
The following dependencies are not installed by Conda or pip: | ||||||
|
||||||
* ``bash`` | ||||||
* GNU `coreutils`_ | ||||||
* ``mail`` (for automated email functionality) | ||||||
|
||||||
The following dependencies are installed by Conda but not by pip: | ||||||
|
||||||
* `configurable-http-proxy`_ | ||||||
|
||||||
|
||||||
Installing On Mac OS | ||||||
-------------------- | ||||||
|
@@ -136,19 +158,23 @@ your ``$PATH``, follow the instructions in the ``brew install`` output. | |||||
Site Installation | ||||||
----------------- | ||||||
|
||||||
|
||||||
For multi-user installation we recommend using Conda and installing | ||||||
Cylc components only where required. | ||||||
|
||||||
The Cylc Packages | ||||||
^^^^^^^^^^^^^^^^^ | ||||||
|
||||||
Cylc is split into a number of packages providing different functionality: | ||||||
.. _Cylc components: | ||||||
|
||||||
The Cylc Components | ||||||
^^^^^^^^^^^^^^^^^^^ | ||||||
|
||||||
Cylc is split into a number of sub-packages providing different functionality: | ||||||
|
||||||
`Cylc Flow`_ | ||||||
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` | ||||||
Integrates with `Rose`_ providing support for Rose configurations. | ||||||
|
||||||
Installation Types | ||||||
^^^^^^^^^^^^^^^^^^ | ||||||
|
@@ -171,13 +197,16 @@ Job Hosts | |||||
Recommended Installation | ||||||
^^^^^^^^^^^^^^^^^^^^^^^^ | ||||||
|
||||||
User Machines | ||||||
User Machines: | ||||||
* `Cylc Flow`_ | ||||||
Cylc Servers | ||||||
* :ref:`Cylc Rose` | ||||||
Cylc Servers: | ||||||
* `Cylc Flow`_ | ||||||
* `Cylc UI Server`_ | ||||||
* :ref:`Cylc Rose` | ||||||
Job Hosts: | ||||||
* `Cylc Flow`_ | ||||||
* :ref:`Cylc Rose` | ||||||
|
||||||
.. _managing environments: | ||||||
|
||||||
|
@@ -204,11 +233,15 @@ however, many things may need to be configured e.g: | |||||
* Communication methods | ||||||
* User/Site preferences | ||||||
|
||||||
Cylc Flow | ||||||
^^^^^^^^^ | ||||||
.. _config.py: https://github.com/cylc/cylc-uiserver#configuring | ||||||
|
||||||
`Cylc Flow`_ is configured by the :cylc:conf:`global.cylc` file which supports | ||||||
configuration of the system on both a site and user basis. | ||||||
Cylc Flow | ||||||
Configured by the :cylc:conf:`global.cylc` file. | ||||||
Cylc UI Server | ||||||
Configured by the `config.py`_ file. | ||||||
Rose / Cylc Rose | ||||||
Configured by the | ||||||
:ref:`rose.conf <rose:Site And User Configuration>` file. | ||||||
|
||||||
.. note:: | ||||||
|
||||||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
.. _cylc-rose: | ||
.. _Cylc Rose: | ||
|
||
Cylc Rose | ||
========= | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mention that a built cylc-ui is now included in cylc-uiserver?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(OK I see you're not including cylc-ui in the list of non-Python deps, further down).