The IOOS Compliance Checker's web front end companion.

The MIT License (MIT)

Copyright (C) 2015 RPS ASA

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

• hdf5
• netcdf
• openssl
• libxml2
• libxslt
• nodejs
• npm
• libgeos
• libudunits2-dev

$ pip install -r requirements.txt

It should be noted that, because of some packaging conflicts, the compliance-checker requirement points at the GitHub repository on the master branch.

• redis

1. Clone the repository

$ git clone https://github.com/ioos/compliance-checker-web/

2. Install node and JS dependencies

$ npm install -g grunt-cli yarn
$ cd compliance-checker-web # if not already
$ grunt

The application has two components that need to run. app.py and worker.py:

python app.py

If running the actual compliance checker report, be sure worker.py is running and started after running python app.py

For production, you can use whatever WSGI service you desire, I personally use gunicorn.

gunicorn -w 2 -b 0.0.0.0:3000 app:app

The worker listens for incoming jobs from the UI through a redis connection. After the job is executed the resulting report is stored on redis for an hour.

To run the worker:

$ python worker.py

In production environments it's better to run a few workers.

1. Build the container

$ docker build -t <name>:<tag> -f Dockerfile .

Production builds should be tagged with ioos/compliance-checker-web:latest.

2. Use docker-compose to run locally:

$ docker-compose up -d

3. Visit the docker host on port 3000

The following are a list of useful configuration variables that can be specified using an environment file or specifying environment variables when launching the docker container.

• MAX_CONTENT_LENGTH: Maximum number of bytes allowed for upload. Default is 16793600 (16 MiB)
• LOGGING: Should the application log information
• LOG_FILE_PATH: Root directory where logging should write files
• LOG_FILE: The filename in the directory to write log files to.
• UPLOAD_FOLDER: The folder where uploaded contents should be written to. Defaults to /var/run/datasets

Details on how to use the API are available on the API wiki page.

Here are a couple examples:

JSON Output

https://data.ioos.us/compliance/api/run?report_format=json&test=cf:1.6&url=http://sos.maracoos.org/stable/dodsC/hrecos/stationHRMARPH-agg.ncml

HTML Output

https://data.ioos.us/compliance/api/run?report_format=html&test=cf:1.6&url=http://sos.maracoos.org/stable/dodsC/hrecos/stationHRMARPH-agg.ncml