-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #27 from force-h2020/command-line
installation update
- Loading branch information
Showing
6 changed files
with
112 additions
and
49 deletions.
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
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,70 +1,105 @@ | ||
Installation | ||
============ | ||
|
||
To install both ``force-bdss`` and the ``force-wfmanager`` applications, first checkout the following | ||
git repositories | ||
The BDSS, the Workflow Manager and all plugins can be cloned from the | ||
`Force 2020 github respositories <https://github.com/force-h2020>`_. | ||
For the BDSS and Workflow Manager, | ||
|
||
.. code-block:: console | ||
git clone https://github.com/force-h2020/force-bdss | ||
git clone https://github.com/force-h2020/force-wfmanager | ||
This tutorial uses the Enthought-Example and Nevergrad plugins as examples, | ||
|
||
.. code-block:: console | ||
git clone https://github.com/force-h2020/force-bdss-plugin-enthought-example | ||
git clone https://github.com/force-h2020/force-bdss-plugin-nevergrad | ||
Enthought Deployment Manager | ||
---------------------------- | ||
|
||
The last repository is optional, but recommended if you want to practice | ||
writing plugins. | ||
The BDSS, the Workflow Manager and plugins must be installed through the `Enthought Deployment | ||
Manager (EDM) <https://www.enthought.com/enthought-deployment-manager/>`_, a python | ||
virtual environment and package manager. For new users it is worth examining EDM's | ||
`documentation <http://docs.enthought.com/edm/>`_. | ||
|
||
If you never installed the Enthought Deployment Manager (EDM), perform the following operations | ||
To install EDM, follow the instructions specific to your operating system | ||
`,here <https://docs.enthought.com/edm/installation.html>`_. | ||
|
||
|
||
The Bootstrap Environment | ||
------------------------- | ||
|
||
Once EDM is installed create a 'bootstrap' environment from which you can install | ||
the BDSS, Workflow Manager and plugins, | ||
|
||
.. code-block:: console | ||
wget https://package-data.enthought.com/edm/rh5_x86_64/1.11/edm_1.11.0_linux_x86_64.sh && bash ./edm_1.11.0_linux_x86_64.sh-b -f -p $HOME | ||
export PATH=${HOME}/edm/bin:${PATH} | ||
edm install --version 3.6 -y click setuptools | ||
edm shell | ||
edm install -e bootstrap -y click setuptools | ||
If you instead already have an EDM installation and a default environment, perform the following | ||
Note that 'bootstrap' can be replaced by any name to the same effect. Now you can enter | ||
``bootstrap`` with, | ||
|
||
.. code-block:: console | ||
edm shell | ||
edm install -y click setuptools | ||
edm shell -e bootstrap | ||
Verify that your shell prompt now contains the string "``(edm)``". | ||
You are now in your default EDM environment, and we assume this environment to be the bootstrap environment. | ||
The BDSS software will not be installed in this environment, but in a separate one. The following | ||
commands however must be executed from the bootstrap environment. | ||
and your shell prompt is prefixed with ``(bootstrap)``. | ||
|
||
Installation of the force BDSS runtime environment is performed with the | ||
following command. This should be done from the directory containing the ``force-bdss`` folder (named | ||
``Force-Project`` in this example) | ||
|
||
.. code-block:: console | ||
The BDSS Runtime Environment | ||
---------------------------- | ||
|
||
.. _bdss-environment-ref: | ||
|
||
~/Force-Project (edm)$ cd force-bdss | ||
~/Force-Project/force-bdss (edm)$ python -m ci build-env | ||
Although repositories (BDSS, etc) are installed *from* the ``bootstrap`` environment, they are | ||
installed *into* a separate environment, within which the BDSS and the Workflow Manager will | ||
actually run. Thus this environment has also to be created before installation. To do this | ||
first cd into the cloned force-bdss respository, | ||
|
||
This will create another edm environment called ``force-py36``. | ||
Do not enter this environment. | ||
.. code-block:: console | ||
~/Force-Project (bootstrap)$ cd force-bdss | ||
To install the BDSS | ||
and then, | ||
|
||
.. code-block:: console | ||
~/Force-Project/force-bdss (edm)$ python -m ci install | ||
~/Force-Project/force-bdss (edm)$ cd .. | ||
To install the workflow manager | ||
~/Force-Project/force-bdss (bootstrap)$ python -m ci build-env | ||
This creates a environment called ``force-pyXX``, where ``XX`` refers to the python version that | ||
the environment runs (e.g. ``force-py36`` for python 3.6) . You will now see it in the list of EDM environments, | ||
|
||
.. code-block:: console | ||
~/Force-Project (edm)$ cd force-wfmanager | ||
~/Force-Project/force-wfmanager (edm)$ python -m ci install | ||
~/Force-Project/force-wfmanager (edm)$ cd .. | ||
(bootstrap)$ edm environments list | ||
>> * bootstrap cpython 3.6.9+2 win_x86_64 msvc2015 ~\.edm\envs\bootstrap | ||
>> force-py36 cpython 3.6.9+2 win_x86_64 msvc2015 ~.edm\envs\force-pyXX | ||
To run BDSS from the command line see :ref:`Using the Command Line <cli-ref>`. | ||
|
||
|
||
and (optional, but recommended), the example plugins | ||
Repository Installation | ||
----------------------- | ||
|
||
From the ``bootstrap`` environment (not ``force-pyXX``!), for each respository in turn, | ||
cd into its directory and then install it with ``python -m ci install``. i.e., | ||
|
||
.. code-block:: console | ||
~/Force-Project (edm)$ cd force-bdss-plugin-enthought-example | ||
~/Force-Project/force-bdss (bootstrap)$ python -m ci install | ||
~/Force-Project/force-bdss (bootstrap)$ cd ../force-wfmanager | ||
~/Force-Project/force-wfmanager (bootstrap)$ python -m ci install | ||
~/Force-Project/force-wfmanager (bootstrap)$ cd ../force-bdss-plugin-enthought-example | ||
~/Force-Project/force-bdss-plugin-enthought-example (edm)$ python -m ci install | ||
~/Force-Project/force-bdss-plugin-enthought-example (edm)$ cd .. | ||
~/Force-Project/force-wfmanager (bootstrap)$ cd ../force-bdss-plugin-nevergrad | ||
~/Force-Project/force-bdss-plugin-nevergrad (bootstrap)$ python -m ci install | ||
...etc |
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 |
---|---|---|
@@ -1,20 +1,45 @@ | ||
Starting the Workflow Manager | ||
============================= | ||
|
||
The Workflow Manager can be started from within the ``bootstrap`` environment with, | ||
|
||
.. code-block:: console | ||
(bootstrap)$ edm run -e force-pyXX -- force_wfmanager | ||
where force-pyXX is the :ref:`BDSS runtime environment <bdss-environment-ref>`. | ||
Alternatively one can enter the runtime environment, e.g. ``force-py36``, | ||
|
||
.. code-block:: console | ||
(bootstrap)$ edm shell -e force-py36 | ||
and then, | ||
|
||
.. code-block:: console | ||
(force-py36)(bootstrap)$ force_wfmanager | ||
Views | ||
===== | ||
----- | ||
|
||
The Workflow Manager has two "views": | ||
The Workflow Manager has two major UI components or "views": | ||
|
||
``Setup Workflow`` | ||
For constructing the workflow, selecting parameters and KPIs and selecting | ||
an optimizer. | ||
|
||
.. figure:: images/setup_view.png | ||
:align: center | ||
:scale: 60 % | ||
|
||
``View Results`` | ||
For viewing the results of an optimization. | ||
|
||
You can switch between the views with the top-left button in the tool-bar: the label | ||
of this button will change accordingly. | ||
|
||
.. figure:: images/setup_workflow.png | ||
.. figure:: images/results_view.png | ||
:align: center | ||
:scale: 60 % | ||
|
||
.. figure:: images/view_results.png | ||
:align: center | ||
You can switch between the views with the top-left button in the tool-bar: the label | ||
of this button will change accordingly. We will consider the two views, in turn, over the | ||
next two topics. |