Thor - The web server of WeatherMagic

Table of Contents

• Thor - The web server of WeatherMagic
• Dependencies
• Installation for development
  • Exiting virtualenv
  • Testing
• Installation for production
• Usage
• License

Dependencies

This project is built using Python 3. You need to insteall Python and its package manager pip in order to run thor. You'll also need some netcdf libraries.

On Debian or Ubuntu:

sudo apt-get install python3 python3-pip netcdf-bin libhdf5-serial-dev libnetcdf-dev memcached libmemcached-dev zlib1g-dev

On macOS:

brew install python3 findutils memcached
pip3 install virtualenv

Installation for development

Development requires a couple additional dependencies (see also additional pip dependencies after virtualenv is set up):

On Debian/Ubuntu:

sudo apt-get install python3-dev python-virtualenv liblapack-dev libatlas-dev gfortran

It's recommended to use virtualenv for development which allows for setup and other possibly system damaging procedures without actually running the risk of doing so. To set up the virtual environment for the first time, stand in the source code folder and run:

virtualenv -p python3 env

Then activate the environment, this is the only thing you need to do on consecutive shells you want to develop in:

source env/bin/activate

You're now ready to install the additional python dependencies into your virtual environment using pip:

# macOS specific!!!
export CPPFLAGS="-I/usr/local/include"
export LDFLAGS="-L/usr/local/lib"
# END macOS specific!!!
USE_SETUPCFG=0 HDF5_INCDIR=/usr/include/hdf5/serial pip3 install -U -r dev-requirements.txt

To keep everything nice and clean we should also lint our code before commiting it, still standing in the root of the source code folder:

ln -s src/commit-hook.bash .git/hooks/pre-commit

Exiting virtualenv

In order to escape the virtualenv one can either close the terminal or run:

deactivate

Installation for production

To install from source first install the dependencies detailed above and then run the following:

git clone https://github.com/WeatherMagic/thor.git
cd thor
sudo pip3 install -U -r requirements.txt
sudo pip3 install .

Get data files from ESGF

• Create an account according to: https://github.com/WeatherMagic/thor/blob/master/doc/earthsystemcog_summary.md
• Run the script in scripts/get_ESCOG_files.sh
• Choose the ammount of data you want (hist/max)
• Enter your ESGF-id (https://.... .... ...)
• Enter empty MyProxy password
• Enter your ESGF password next

Usage

Run thor with:

./thor.py

Or for disabled cache:

./thor.py --disable-cache

License

You are granted a licensed to use this program and all of it's components, which we hold the copyright of, under the GNU Affero General Public License version 3. A complete copy of the license is available in the LICENSE.txt file and can also be viewed on the GNU website.