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.

Sign up for GitHub

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 ecFlow references in documentation #63

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update ecFlow references in documentation #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 24 additions & 28 deletions docs/content/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,53 +31,49 @@ Setup
Conda Environment (Recommended)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For Conda environment, a definition file is provided in the repository root. It will create a suitable environment with all dependencies installed.
An environment definition file to setup Conda is provided at the root of the **pyflow** repository.
The following commands create a suitable environment with all necessary dependencies, including `ecFlow`_:

.. code-block:: shell

git clone ssh://[email protected]/ecflow/pyflow.git
# clone using HTTPS
git clone https://github.com/ecmwf/pyflow.git
# or, clone using an SSH key
git clone [email protected]:ecmwf/pyflow.git

cd pyflow
conda env create -f environment.yml
conda activate pyflow


ECMWF Environment Modules
~~~~~~~~~~~~~~~~~~~~~~~~~

On ECMWF systems, Environment Modules can be used to switch on relevant packages and make them available for use.
To install **pyflow** in the Conda environment, simply use :code:`pip`

.. code-block:: shell

module load python3 ecflow/5 pyflow


.. warning::

Please make sure to also set the following environment variable, so **pyflow** library can be found:

.. code-block:: shell

export PYTHONPATH="$PYFLOW_DIR/lib/python3.6/site-packages:$PYTHONPATH"


.. todo::

The need for ``PYTHONPATH`` variable should be handled in the next release of the module.
pip install pyflow-workflow-generator


Install from Source
~~~~~~~~~~~~~~~~~~~

Follow `ecFlow installation instructions`_ and after all steps make sure to set following environment variable to correct paths.
Follow the `ecFlow installation instructions`_ ensuring that the ecFlow Python interface is enabled (see :code:`ENABLE_PYTHON`).
After a successful build, perform the ecFlow installation step to place all binary artifacts into an instalation directory.
Considering :code:`$ECFLOW_DIR` is the installation directory, the ecFlow Python interface is available at
:code:`$ECFLOW_DIR/lib/python3.XX/site-packages/ecflow/`.

Ensure the following environment variables are set, and install **pyflow**:

.. code-block:: shell

export ECFLOW_DIR=/path/to/ecflow
git clone ssh://[email protected]/ecflow/pyflow.git
cd pyflow
pip3 install .
export ECFLOW_DIR=/path/to/installation/directory/of/ecflow

# clone using HTTPS
git clone https://github.com/ecmwf/pyflow.git
# or, clone using an SSH key
git clone [email protected]:ecmwf/pyflow.git

cd pyflow
pip install .

.. _`ecFlow`: https://github.com/ecmwf/ecflow
.. _`Jupyter Notebook`: https://jupyter.org
.. _`ecFlow installation instructions`: https://github.com/ecmwf/ecflow#install-from-source
.. _`ecFlow installation instructions`: https://ecflow.readthedocs.io/en/latest/install/build_from_source.html
4 changes: 2 additions & 2 deletions docs/content/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Introduction

.. seealso::

For more details about **ecFlow**, please check `ecFlow Documentation`_.
For more details about **ecFlow**, please check `ecFlow documentation`_.


Benefits
Expand Down Expand Up @@ -44,4 +44,4 @@ The aim of **pyflow** is to build object-oriented suites, which compile to **ecF


.. _`ecFlow`: https://github.com/ecmwf/ecflow
.. _`ecFlow Documentation`: https://confluence.ecmwf.int/display/ECFLOW
.. _`ecFlow documentation`: https://ecflow.readthedocs.io/
4 changes: 2 additions & 2 deletions docs/content/introductory-course/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ You can quickly get started with **pyflow** with a trivial example outlined belo

.. seealso::

For more details about **ecFlow**, please check `ecFlow Documentation`_.
For more details about **ecFlow**, please check `ecFlow documentation`_.


Write Suite
Expand Down Expand Up @@ -141,4 +141,4 @@ After you finish, make sure to stop the local **ecFlow** server:
ecflow_stop.sh


.. _`ecFlow Documentation`: https://confluence.ecmwf.int/display/ECFLOW
.. _`ecFlow documentation`: https://ecflow.readthedocs.io/
Loading