diff --git a/README.rst b/README.rst index 5a305d04..6d95e075 100644 --- a/README.rst +++ b/README.rst @@ -32,6 +32,10 @@ To install:: git clone git@github.com:ARM-software/workload-automation.git workload-automation sudo -H python setup [install|develop] +Note: A `requirements.txt` is included however this is designed to be used as a +reference for known working versions rather than as part of a standard +installation. + Please refer to the `installation section `_ in the documentation for more details. diff --git a/doc/source/user_information/installation.rst b/doc/source/user_information/installation.rst index a036d822..3a5fa5aa 100644 --- a/doc/source/user_information/installation.rst +++ b/doc/source/user_information/installation.rst @@ -12,8 +12,9 @@ Installation .. module:: wa This page describes the 3 methods of installing Workload Automation 3. The first -option is to use :ref:`pip` which -will install the latest release of WA, the latest development version from :ref:`github ` or via a :ref:`dockerfile`. +option is to use :ref:`pip` which will install the latest release of WA, the +latest development version from :ref:`github ` or via a +:ref:`dockerfile`. Prerequisites @@ -97,8 +98,8 @@ similar distributions, this may be done with APT:: If you do run into this issue after already installing some packages, you can resolve it by running :: - sudo chmod -R a+r /usr/local/lib/python2.7/dist-packagessudo - find /usr/local/lib/python2.7/dist-packages -type d -exec chmod a+x {} \; + sudo chmod -R a+r /usr/local/lib/python2.7/dist-packages + sudo find /usr/local/lib/python2.7/dist-packages -type d -exec chmod a+x {} \; (The paths above will work for Ubuntu; they may need to be adjusted for other distros). @@ -171,9 +172,11 @@ install them upfront (e.g. if you're planning to use WA to an environment that may not always have Internet access). * nose - * PyDAQmx - * pymongo - * jinja2 + * mock + * daqpower + * sphinx + * sphinx_rtd_theme + * psycopg2-binary @@ -205,6 +208,13 @@ Alternatively, you can also install the latest development version from GitHub install the latest version of `devlib `_. +.. note:: Please note that while a `requirements.txt` is included, this is + designed to be a reference of known working packages rather to than to + be used as part of a standard installation. The version restrictions + in place as part of `setup.py` should automatically ensure the correct + packages are install however if encountering issues please try + updating/downgrading to the package versions list within. + If the above succeeds, try :: diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..acb84d08 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,22 @@ +certifi==2019.6.16 +chardet==3.0.4 +colorama==0.4.1 +enum34==1.1.6; python_version<"3" +devlib==1.1.2 +future==0.17.1 +idna==2.8 +Louie-latest==1.3.1 +nose==1.3.7 +numpy==1.16.4 +pandas==0.24.2 +pexpect==4.7.0 +ptyprocess==0.6.0 +pyserial==3.4 +python-dateutil==2.8.0 +pytz==2019.1 +PyYAML==5.1.1 +requests==2.22.0 +six==1.12.0 +urllib3==1.25.3 +wlauto==3.1.4 +wrapt==1.11.2