| 1 | ---------------------------- |
|---|
| 2 | PLANETOPLOT v2 |
|---|
| 3 | ---------------------------- |
|---|
| 4 | A. Spiga LMD/UPMC 24/03/2013 |
|---|
| 5 | ---------------------------- |
|---|
| 6 | |
|---|
| 7 | Contents |
|---|
| 8 | -------- |
|---|
| 9 | -------- |
|---|
| 10 | core |
|---|
| 11 | ---- |
|---|
| 12 | - ppclass.py --> main class with pp() objects (need ppplot and ppcompute) |
|---|
| 13 | - ppplot.py --> plot class (can be used independently, need ppcompute) |
|---|
| 14 | - ppcompute.py --> computation class (can be used independently) |
|---|
| 15 | scripts |
|---|
| 16 | ------- |
|---|
| 17 | - pp.py --> command line utility to use ppclass [HELP with 'pp.py -h'] |
|---|
| 18 | - pp_reload.py --> command line utility to load saved plot objects *.ppobj |
|---|
| 19 | - example/* --> example scripts using ppclass |
|---|
| 20 | settings files |
|---|
| 21 | -------------- |
|---|
| 22 | - set_area.txt --> setting file: predefined areas for plotting (can be omitted) |
|---|
| 23 | - set_back.txt --> setting file: predefined backgrounds for plotting (can be omitted) |
|---|
| 24 | - set_multiplot.txt --> setting file: predefined coefficients for multiplots (can be omitted) |
|---|
| 25 | - set_ppclass.txt --> setting file: predefined variables for x,y,z,t (can be omitted) |
|---|
| 26 | - set_var.txt --> setting file: predefined colorbars, format, labels, etc... for variables (can be omitted) |
|---|
| 27 | documentation |
|---|
| 28 | ------------- |
|---|
| 29 | - README.TXT --> this README file |
|---|
| 30 | data |
|---|
| 31 | ---- |
|---|
| 32 | - demo_data/* --> plot objects for a demonstration tour and customizing tests |
|---|
| 33 | |
|---|
| 34 | Requirements |
|---|
| 35 | ------------ |
|---|
| 36 | ------------ |
|---|
| 37 | python + numpy + matplotlib + netCDF4 |
|---|
| 38 | - for mapping --> Basemap |
|---|
| 39 | - for scientific computations --> scipy |
|---|
| 40 | [recommended: Enthought Python Distribution (free for academics)] |
|---|
| 41 | |
|---|
| 42 | Installation |
|---|
| 43 | ------------ |
|---|
| 44 | ------------ |
|---|
| 45 | - install required softwares and librairies in requirements |
|---|
| 46 | - add planetoplot_v2 in your PYTHONPATH environment variable (and in your PATH to use pp.py) |
|---|
| 47 | |
|---|
| 48 | Take a demo tour |
|---|
| 49 | ---------------- |
|---|
| 50 | ---------------- |
|---|
| 51 | pp_reload.py demo_data/* |
|---|
| 52 | |
|---|
| 53 | Improvements compared to v1 |
|---|
| 54 | --------------------------- |
|---|
| 55 | --------------------------- |
|---|
| 56 | * code readability and structuration for future improvements |
|---|
| 57 | * modularity (class formulation) |
|---|
| 58 | + easy definition/addition of attributes |
|---|
| 59 | * separation between data retrieval and plotting |
|---|
| 60 | * versatility |
|---|
| 61 | + command line (pp.py) |
|---|
| 62 | --> for quick inspection |
|---|
| 63 | + interactive session (ipython) |
|---|
| 64 | --> for testing and exploring |
|---|
| 65 | + scripts |
|---|
| 66 | --> for powerful and fully customized results |
|---|
| 67 | * performance (overall and on large files) |
|---|
| 68 | + memory consumption (only retrieve what is needed) |
|---|
| 69 | * saving/loading plot objects in/from *.ppobj |
|---|
| 70 | * plot aesthetics and customizing (see header in ppplot) |
|---|
| 71 | * multiplot flexibility with .plotin attribute |
|---|
| 72 | * easy definition of presets with set_*.txt files |
|---|
| 73 | * function: one field vs. another one |
|---|
| 74 | * emulation of + - / * ** operations on fields |
|---|
| 75 | (between two fields or between a field and a int/float) |
|---|
| 76 | * computations of min/max in addition to mean |
|---|
| 77 | * simple inspection of dimensions+variables in a file (pp.py -f file) |
|---|
| 78 | * verbose / non verbose mode |
|---|
| 79 | |
|---|
| 80 | Acknowledgements |
|---|
| 81 | ---------------- |
|---|
| 82 | ---------------- |
|---|
| 83 | Thanks to A. Colaitis, T. Navarro, J. Leconte |
|---|
| 84 | for feedbacks and contributions on version 1 |
|---|
