index.rst 1.73 KB
Newer Older
BorjaEst's avatar
BorjaEst committed
1
.. rubric:: Data skimming for ozone assessment.
2

BorjaEst's avatar
BorjaEst committed
3
**o3skim** is an open source project and Python package that provides the 
BorjaEst's avatar
BorjaEst committed
4
tools to pre-process, standardize and reduce ozone data from netCDF_ models to
BorjaEst's avatar
BorjaEst committed
5
simplify and speed up ozone data transfer and plot.
BorjaEst's avatar
BorjaEst committed
6
7
8
9

.. _netCDF: http://www.unidata.ucar.edu/software/netcdf


10
11
Getting started
=========================================
BorjaEst's avatar
BorjaEst committed
12

BorjaEst's avatar
BorjaEst committed
13
14
15
16
* Which :doc:`getting_started/prerequisites` you need to start.
* How to :doc:`getting_started/build` your o3skim container.
* How to :doc:`getting_started/deployment` your o3skim container.
* How to use the o3skim :doc:`getting_started/cli`
BorjaEst's avatar
BorjaEst committed
17
18

.. toctree::
BorjaEst's avatar
BorjaEst committed
19
   :maxdepth: 2
BorjaEst's avatar
BorjaEst committed
20
   :hidden:
BorjaEst's avatar
BorjaEst committed
21
   :caption: Getting started
BorjaEst's avatar
BorjaEst committed
22

BorjaEst's avatar
BorjaEst committed
23
24
25
26
   getting_started/prerequisites
   getting_started/build
   getting_started/deployment
   getting_started/cli
BorjaEst's avatar
BorjaEst committed
27
   
BorjaEst's avatar
BorjaEst committed
28

29
30
User guide
=========================================
BorjaEst's avatar
BorjaEst committed
31

BorjaEst's avatar
BorjaEst committed
32
* Create your :doc:`user_guide/source-file` to point what to skim.
BorjaEst's avatar
BorjaEst committed
33
* Learn how to skim by reading the :doc:`user_guide/o3skim`
34
35

.. toctree::
BorjaEst's avatar
BorjaEst committed
36
   :maxdepth: 2
BorjaEst's avatar
BorjaEst committed
37
38
   :hidden:
   :caption: User guide:
39

BorjaEst's avatar
BorjaEst committed
40
   user_guide/source-file
BorjaEst's avatar
BorjaEst committed
41
   user_guide/o3skim
BorjaEst's avatar
BorjaEst committed
42
43


44
45
Developer guide
=========================================
BorjaEst's avatar
BorjaEst committed
46

BorjaEst's avatar
BorjaEst committed
47
48
* How to do a :doc:`dev_guide/local-install`
* How to run and create new :doc:`dev_guide/tests`
BorjaEst's avatar
BorjaEst committed
49
50

.. toctree::
BorjaEst's avatar
BorjaEst committed
51
   :maxdepth: 2
BorjaEst's avatar
BorjaEst committed
52
53
   :hidden:
   :caption: Developer guide:
BorjaEst's avatar
BorjaEst committed
54

BorjaEst's avatar
BorjaEst committed
55
56
   dev_guide/local-install
   dev_guide/tests
BorjaEst's avatar
BorjaEst committed
57
58
59


See also
60
61
62
63
=========================================

Indices and tables
---------------------
BorjaEst's avatar
BorjaEst committed
64

BorjaEst's avatar
BorjaEst committed
65
66
67
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
BorjaEst's avatar
BorjaEst committed
68
69


BorjaEst's avatar
BorjaEst committed
70
Authors
71
---------------------
BorjaEst's avatar
BorjaEst committed
72
73
74
75

- `@V.Kozlov <https://git.scc.kit.edu/eo9869>`_ - TBD
- `@T.Kerzenmacher <https://git.scc.kit.edu/px5501>`_ - TBD
- `@B.Esteban <https://git.scc.kit.edu/zr5094>`_ - TBD
BorjaEst's avatar
BorjaEst committed
76

77

BorjaEst's avatar
BorjaEst committed
78
Acknowledgements
79
---------------------
80
81