diff --git a/README.rst b/README.rst index c011297942b43abdf9718caca0432da7c30017d7..7bf7f8bfc4eb953ea5ae4b3e34c6a2dc57ab350e 100644 --- a/README.rst +++ b/README.rst @@ -4,3 +4,4 @@ FORCE BDSS This repository contains the implementation of the Business Decision System. It is implemented under the FORCE project (Horizon 2020/NMBP-23-2016/721027). +To install, follow the `installation instructions <doc/source/installation.rst>`_ diff --git a/doc/source/index.rst b/doc/source/index.rst index 467b4ca39d68e477b4a57f4f7f20188f44b4a1e5..f8af52ef9478786d26fc63a6d8c790fd3538138e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,6 +10,7 @@ User Manual :maxdepth: 1 Introduction <introduction> + Installation instructions <installation> Design <design> Plugin development <plugin_development> diff --git a/doc/source/installation.rst b/doc/source/installation.rst new file mode 100644 index 0000000000000000000000000000000000000000..89cb78949799f94a7a9e0534bca9ddfda2799975 --- /dev/null +++ b/doc/source/installation.rst @@ -0,0 +1,49 @@ +Installation Instructions +------------------------- +To install force-bdss and the workflow manager, first checkout the following +git repositories:: + + git clone https://github.com/force-h2020/force-bdss + git clone https://github.com/force-h2020/force-wfmanager + git clone https://github.com/force-h2020/force-bdss-plugin-enthought-example + +The last repository is optional, but recommended if you want to practice +writing plugins. + +Next, download EDM package manager, and create an appropriate +environment:: + + wget https://package-data.enthought.com/edm/rh5_x86_64/1.4/edm_1.4.1_linux_x86_64.sh && bash ./edm_1.4.1_linux_x86_64.sh -b -p $HOME + export PATH=${HOME}/edm/bin:${PATH} + edm environments create --version 3.5 force + edm shell --environment=force + +Veryfy that your prompt changes to add "(force)". +Install the required packages for the workflow manager:: + + cat force-wfmanager/requirements/edm_requirements.txt | grep -v "^#" | while read line; do edm install -y `echo $line | awk '{print $1"=="$2}'`; done + +Now, install the bdss:: + + pushd force-bdss + pip install -r requirements/requirements.txt + pip install -e . + popd + +the workflow manager:: + + pushd force-wfmanager + pip install -r requirements/requirements.txt + pip install -e . + popd + +and (optional, but recommended), the example plugins:: + + pushd force-bdss-plugin-enthought-example + pip install -r requirements/requirements.txt + pip install -e . + popd + +Now you can invoke the workflow manager with force_wfmanager, +and the bdss with force_bdss. +