Commit b3834a37 authored by Javier Vegas-Regidor's avatar Javier Vegas-Regidor
Browse files

Updated doc

parent ecf09d62
No preview for this file type
......@@ -62,9 +62,9 @@ copyright = u'2016, BSC-CNS Earth Sciences Department'
# built documents.
#
# The short X.Y version.
version = '3.0'
version = '3.0b'
# The full version, including alpha/beta/rc tags.
release = '3.0.0'
release = '3.0.0b'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......
......@@ -23,7 +23,7 @@ If you have any doubts, or just want help to start the development, contact javi
Developing a diagnostic
-----------------------
For new diagnsotics development, we have some advice to give:
For new diagnostics development, we have some advice to give:
* Do not worry about performance at first, just create a version that works. Developers can help you to optimize it
later.
......
......@@ -7,7 +7,7 @@ Welcome to Earth Diagnostics's documentation!
=============================================
.. toctree::
:maxdepth: 2
:maxdepth: 3
tutorial
tips
......
......@@ -33,7 +33,7 @@ Call the diags with -h option to see if everything is ready:
Creating a config file
----------------------
If you go into the earthdiagnsotics folder in the git repository, you will see a diags.conf that can be used as a model
If you go into the earthdiagnostics folder in the git repository, you will see a diags.conf that can be used as a model
for your config file. It contains commentaries explaining what represents each one of its parameters, so please read it
carefully.
......
......@@ -19,6 +19,18 @@ class AreaMoc(Diagnostic):
:created: March 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
:param basin: basin to compute
:type basin: Basin
:param box: box to compute
:type box: Box
"""
def __init__(self, data_manager, startdate, member, chunk, basin, box):
......
......@@ -15,6 +15,21 @@ class AverageSection(Diagnostic):
:created: March 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
:param variable: variable's name
:type variable: str
:param domain: variable's domain
:type domain: str
:param box: box to use for the average
:type box: Box
"""
def __init__(self, data_manager, startdate, member, chunk, variable, domain, box):
......
......@@ -16,6 +16,16 @@ class ConvectionSites(Diagnostic):
:created: October 2013
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
:param nemo_version: NEMO's version
:type nemo_version: str
"""
def __init__(self, data_manager, startdate, member, chunk, nemo_version):
......
......@@ -17,6 +17,22 @@ class CutSection(Diagnostic):
:created: September 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
:param variable: variable's name
:type variable: str
:param domain: variable's domain
:type domain: str
:param zonal: specifies if section is zonal or meridional
:type zonal: bool
:param value: value of the section's coordinate
:type value: int
"""
def __init__(self, data_manager, startdate, member, chunk, variable, domain, zonal, value):
......
......@@ -17,6 +17,16 @@ class Gyres(Diagnostic):
:created: October 2013
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
:param nemo_version: NEMO's version
:type nemo_version: str
"""
def __init__(self, data_manager, startdate, member, chunk, nemo_version):
Diagnostic.__init__(self, data_manager)
......
......@@ -20,6 +20,19 @@ class HeatContent(Diagnostic):
:created: May 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
:param mixed_layer: If 1, restricts calculation to the mixed layer, if -1 exclude it. If 0, no effect
:type mixed_layer: int
:param box: box to use for the average
:type box: Box
"""
def __init__(self, data_manager, startdate, member, chunk, basin, mixed_layer, box):
......
......@@ -18,6 +18,16 @@ class HeatContentLayer(Diagnostic):
:created: June 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
:param box: box to use for the calculations
:type box: Box
"""
def __init__(self, data_manager, startdate, member, chunk, box):
......
......@@ -18,6 +18,20 @@ class Interpolate(Diagnostic):
:created: November 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
:param variable: variable's name
:type variable: str
:param domain: variable's domain
:type domain: str
:param nemo_version: NEMO model version
:type nemo_version: str
"""
def __init__(self, data_manager, startdate, member, chunk, variable, domain, nemo_version):
Diagnostic.__init__(self, data_manager)
......
......@@ -19,7 +19,18 @@ class MaxMoc(Diagnostic):
:created: March 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param year: year to compute
:type year: int
:param basin: basin to compute
:type basin: Basin
:param box: box to compute
:type box: Box
"""
def __init__(self, data_manager, startdate, member, year, basin, box):
......
......@@ -16,6 +16,14 @@ class MixedLayerHeatContent(Diagnostic):
:created: February 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
"""
def __init__(self, data_manager, startdate, member, chunk):
......
......@@ -15,6 +15,14 @@ class MixedLayerSaltContent(Diagnostic):
:created: February 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
"""
def __init__(self, data_manager, startdate, member, chunk):
......
......@@ -18,6 +18,14 @@ class Moc(Diagnostic):
:created: March 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
"""
def __init__(self, data_manager, startdate, member, chunk):
......
......@@ -14,6 +14,14 @@ class Psi(Diagnostic):
:created: March 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
"""
def __init__(self, data_manager, startdate, member, chunk):
Diagnostic.__init__(self, data_manager)
......
......@@ -27,6 +27,18 @@ class Siasiesiv(Diagnostic):
gphit = None
def __init__(self, data_manager, basin, startdate, member, chunk, mask):
"""
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
:param mask: mask to use
:type mask: numpy.array
"""
Diagnostic.__init__(self, data_manager)
self.basin = basin
if basin == Basins.Global:
......
......@@ -17,6 +17,18 @@ class VerticalMean(Diagnostic):
:created: February 2012
:last modified: June 2016
:param data_manager: data management object
:type data_manager: DataManager
:param startdate: startdate
:type startdate: str
:param member: member number
:type member: int
:param chunk: chunk's number
:type chunk: int
:param variable: variable to average
:type variable: str
:param box: box used to restrict the vertical mean
:type box: Box
"""
def __init__(self, data_manager, startdate, member, chunk, variable, box):
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment