CDPP / HELIOPROPA

Blame view

README.md 957 Bytes
Edit Raw Normal View History
19268da3   Goutte   Initial commit. 
1
5f63c83b   Goutte   Lint. 
2
 
## http://heliopropa.irap.omp.eu
19268da3   Goutte   Initial commit. 
3
4
5
6
7
 

# What

## Web Server
6b149919   Goutte   Add a Download bu... 
8
 
Build and serve heliopropa's visualizations.
5f63c83b   Goutte   Lint. 
9
10
 
It's a `flask` webserver, serving `d3.js` plots written in `livescript`,
which is just javascript with lots of sugar to make it palatable.
6b149919   Goutte   Add a Download bu... 
11
 
It also gathers NetCDF data from AMDA, and serves it as CSV to the plotter.
19268da3   Goutte   Initial commit. 
12
13
14
15
 


### Rationale
6b149919   Goutte   Add a Download bu... 
16
17
 
- Reading NetCDF from javascript is doable, but still *very* hacky.
- The bridge can handle pagination and collecting multiple NetCDF into one CSV.
19268da3   Goutte   Initial commit. 
18
19
20
21
22
23
24
25
 


# How

## Overview

- `config.yml` : the main configuration file.
- `web/run.py` : the front controller, holding most of the code.
6b149919   Goutte   Add a Download bu... 
26
 
- `web/view/home.html.jinja2` : the HTML template.
d1c44c51   Goutte   Enable Earth 
27
 
- `web/static/js/swapp.ls` : most of the javascript client-side.
19268da3   Goutte   Initial commit. 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 


## 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).