From 37a33bf0dfd5f38f9f9b87241e22d50f5b0b8bbd Mon Sep 17 00:00:00 2001 From: Esterly Date: Tue, 25 Jul 2017 10:43:38 -0600 Subject: [PATCH] Updating Installation Instructions --- doc/installation.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/installation.rst b/doc/installation.rst index 24e8992..8822879 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -76,6 +76,22 @@ The following installation procedure allows for easier updating of the code with python example_shortTermExtreme.py python example_fatigue.py +Configuring your PYTHONPTH +```````````````````````````` +The following instructions will help you configure your PYTHONPATH, which is a search path Python uses for +importing other python modules. + +**Windows:** + | 1.) Navigate to Control Panel -> System -> Advanced system settings -> Environment Variables + | 2.) Click "New..." + | 3.) Under "Variable Name" type: PYTHONPATH + | 4.) Under "Variable Value" enter the location of your Python source directory (i.e "C:\Python27") +**Linux/OS X** + | 1.) Navigate to your home directory + | 2.) Add a line such as "export PYTHONPATH=“/path/where/your/modules/are/located" to your .bash_rc file if running Linux, or .bash_profile if running OS X + | 3.) Place the modules you would like to import in the directory you specified in the previous step + + Dependencies ------------- `Python 2.7.x `_ and the following Python packages are required to run `WDRT`. `WDRT` currently will not fully run on Python 3.5.x. @@ -88,6 +104,11 @@ These packages can easily be installed using using `pip `_ * `requests `_ * `BeautifulSoup4 `_ + * `netCDF4 `_ + +.. Note:: + + the netCDF4 package is only required if you are using a CDIP site in the ESSC module Troubleshooting ---------------