Debian Codegraph @

doc/index.rst

raw
1 .. drslib documentation master file, created by
2 sphinx-quickstart on Thu Jul 8 11:22:21 2010.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
6
7 esgf-drslib documentation
8 =========================
9
10
11 Drslib is a Python library for processing data intended for publishing
12 into the Earth System Grid Federation (`ESGF`_). It was first
13 designed for the 5th Climate Model Intercomparison Project (CMIP5_)
14 Data Reference Syntax (DRS_). It has subsequently been extended to
15 support the SPECS_ and CORDEX_ projects and provides an internal API
16 for future extension. Drslib API-level code for working with DRS
17 components, algorithms for decuding DRS components from incomplete
18 information and a command-line tool for manipulating data files into
19 the recommended DRS directory structure.It has been developed by the
20 `Centre for Environmental Data Archival <http://ceda.ac.uk>`_ as part
21 of the ESG Federation.
22
23 .. _CMIP5: http://cmip-pcmdi.llnl.gov/cmip5/
24 .. _DRS: http://cmip-pcmdi.llnl.gov/cmip5/docs/cmip5_data_reference_syntax.pdf
25 .. _ESGF: http://esgf.org/
26 .. _CORDEX: http://wcrp-cordex.ipsl.jussieu.fr/
27 .. _SPECS: http://www.specs-fp7.eu/
28
29
30 User Guide
31 ----------
32
33 .. toctree::
34 :maxdepth: 3
35
36 intro.rst
37 howto.rst
38 command.rst
39 product.rst
40 schemes.rst
41
42 Reference
43 ---------
44
45 .. toctree::
46 :maxdepth: 3
47
48 modules.rst
49
50 Appendix
51 --------
52
53 .. toctree::
54 :maxdepth: 3
55
56 cmip3.rst
57
58
59 Indices and tables
60 ------------------
61
62 * :ref:`genindex`
63 * :ref:`modindex`
64 * :ref:`search`
65