diff --git a/README.md b/README.md new file mode 100644 index 0000000..3b44006 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ + +The sources of the website available at https://spaceweatheronline.cdpp.eu + + +# What + +## Web Server + +Build and serve the space weather visualization webpages. +A flask webserver, serving d3.js visualizations. + + +## Bridge + +Gather NetCDF data from AMDA, and serve it as CSV to the javascript plotter. + + +### Rationale + +- Reading NetCDF from javascript is doable, but still very hacky. +- The bridge can handle pagination, collecting multiple NetCDF into one CSV. + + +# How + +## Overview + +- `config.yml` : the main configuration file. +- `web/run.py` : the front controller, holding most of the code. + + +## Install + +``` bash +virtualenv venv +source venv/bin/activate +pip install -r requirements.txt +``` + + +## Develop + +``` bash +source venv/bin/activate +python web/run.py +``` + +Then, browse [localhost:5000](http://localhost:5000). diff --git a/VERSION b/VERSION new file mode 100644 index 0000000..bd52db8 --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +0.0.0 \ No newline at end of file -- libgit2 0.21.2