Metadata-Version: 2.0
Name: coastviewer
Version: 0.1.9
Summary: Coast Viewer, the backend for the coast viewer. A tool to visualize coastal data.
Home-page: https://github.com/openearth/coastviewer
Author: Fedor Baart
Author-email: fedor.baart@deltares.nl
License: GNU General Public License v3
Keywords: coastviewer
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: Click (>=6.0)

# Coastviewer
Coast viewer server side. Serves several sources as KML and geojson.

Read the documentation at http://coastviewer.readthedocs.io/

# Download data
For linux/ubuntu systems: 
``` shell
cd data
make
```
For windows systems: 
Install chocolatey from https://chocolatey.org/install
``` shell
choco install make
choco install wget
cd data
make
```

# Install dependencies (docker)
Install docker (for windows 7 or lower install docker terminal) from https://docs.docker.com/engine/installation/.

``` shell
docker pull openearth/coastviewer
```

# Install dependencies (development)

Install dependencies
On linux/ubuntu systems:
- apt-get install GDAL
- apt-get install python35

On windows systems:
Install GDAL, see tutorial from https://sandbox.idre.ucla.edu/sandbox/tutorials/installing-gdal-for-windows/.

Install python 3.5 from https://www.python.org/downloads/release/python-350/.

``` shell
pip install -e .
```
Install the requirements: 

``` shell
pip install -r requirements.txt
```


# Run the server (docker)

``` shell
docker run openearth/coastviewer
```

# Run the server (development)

``` shell
coastviewer
```


# Use
Load the link [http://localhost:5000/coastviewer/1.1.0/transects/kml](transects/kml) in Google Earth (add network link).

# Test
Load the [http://localhost:5000/coastviewer/1.1.0/ui](test ui) in your browser. for the integration tests.
Run `make test` for the unit tests.
Run `make lint` for code formatting checks.


=======
History
=======

0.1.0 (2017-07-13)
------------------

* First release on PyPI.


