Installation¶
Install from Conda¶
Warning
TODO: Prepare Conda package.
Install from GitHub¶
Check out code from the ShearWater GitHub repo and start the installation:
$ git clone https://github.com/cehbrecht/shearwater.git
$ cd shearwater
Create Conda environment named shearwater:
$ conda env create -f environment.yml
$ source activate shearwater
Install ShearWater app:
$ pip install -e .
OR
make install
For development you can use this command:
$ pip install -e .[dev]
OR
$ make develop
Start ShearWater PyWPS service¶
After successful installation you can start the service using the shearwater
command-line.
$ shearwater --help # show help
$ shearwater start # start service with default configuration
OR
$ shearwater start --daemon # start service as daemon
loading configuration
forked process id: 42
The deployed WPS service is by default available on:
http://localhost:5000/wps?service=WPS&version=1.0.0&request=GetCapabilities.
Note
Remember the process ID (PID) so you can stop the service with kill PID
.
You can find which process uses a given port using the following command (here for port 5000):
$ netstat -nlp | grep :5000
Check the log files for errors:
$ tail -f pywps.log
… or do it the lazy way¶
You can also use the Makefile
to start and stop the service:
$ make start
$ make status
$ tail -f pywps.log
$ make stop
Run ShearWater as Docker container¶
You can also run ShearWater as a Docker container.
Warning
TODO: Describe Docker container support.
Use Ansible to deploy ShearWater on your System¶
Use the Ansible playbook for PyWPS to deploy ShearWater on your system.