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

Revert "Merge branch 'devel_better_data_management' into 'master'"

This reverts merge request !21
parent 8b5afb22
*.pyc
.idea/*
doc/build/*
*.err
*.out
*.nc
.coverage
htmlcov
\ No newline at end of file
.*.sw*
.*.log*
[submodule "earthdiagnostics/cmor_tables/cmip6"]
path = earthdiagnostics/cmor_tables/cmip6
url = https://github.com/jvegasbsc/cmip6-cmor-tables.git
[submodule "earthdiagnostics/cmor_tables/primavera"]
path = earthdiagnostics/cmor_tables/primavera
url = https://github.com/jonseddon/cmip6-cmor-tables.git
3.0.0
Complete rewrite in Python
Update CDFTools from version 2.1 to 3.0
Adoption of CMOR standard
graft earthdiagnostics
include diags.conf
include README
include VERSION
\ No newline at end of file
This tool is a set of diagnostics used at BSC-ES department for NEMO and EC-EARTH models postprocessing.
They are based on CDO, NCO and CDFTOOLS 3.0. For CDFTOOLS, a custom build is required.
To use the ocean diagnostic tools available here and to be able to create new diagnostics,
you need first to add the following line to your .bashrc:
PATH=/cfu/software/cdftools2.1/:$PATH
FULL DOCUMENTATION AND HOW TOs
==============================
#Launching instructions:
Check the Earth Diagnostics documentation in PDF format in EarthDiagnostics.pdf available also in this folder.
./ocean_pp.bash $path_to_your_file/config_file-ocean_pp.bash
- You can copy and modify the config_file to any directory if you indicate the good path when launching ocean_pp.bash
- ocean_pp.bash, README and example of config_file-ocean_pp.bash can be downloaded from git repository: git clone https://dev.cfu.local/cfutools.git <localdir2>
CONTACT
=======
#
For any doubts or suggestions, contact javier.vegas@bsc.es
\ No newline at end of file
####################### DIAGNOSTICS LIST #######################################
'siasiesiv' : sea ice area + sea ice extent + sea ice volume
'moc' : Atlantic + Pacific + Indian + Indo-Pacific + Global
meridional overturning streamfunction
'max_moc' : Yearly maximum of the Atlantic meridional overturning
streamfunction between 38N-50N and 500-3000m and
at 40N.
Beware that the max_moc diagnostics can not be computed
if you don't process complete years, as it is a diagnostic
computed from complete years.
'area_moc' : Averaged Atlantic meridional overturning streamfunction
between 40N-55N and 1km-2km and between 30N-40N and 1km-2km
'convection' : indices of convective activity in the Labrador, extended Irminger,
GIN and Wedell seas computed as the maximum in mixed layer depth
based on the potential density criteria
'stc' : Subtropical cell strength, computed as the averaged Atlantic
and Pacific overturning streamfunction in 0-25N/S, 0-200m
'ext_raw_ice' : raw ice varibales to be extracted from input files
(called "ice" before february 2013 update))
'ext_raw_oce' : raw ocean varibales to be extracted from input files
(called "sstsssmld" before february 2013 update))
'heat_sal_mxl' : mixed layer heat and salt content (potential density criteria)
'psi' : barotropic streamfunction
'gyres' : indices of the barotropic gyres computed as the maximum absolute
barotropic streamfunction in the North Atlantic and North Pacific
subpolar and subtropical gyres and in the South Atlantic, South
Pacific and Indian subtropical gyres and indice of the Antarctic
Circumpolar Current strength
'usalc' : upper layer salt content 0-300m
'temp_lev' : temperature, vertical mean between dif levels (2D)
'sal_lev' : salinity, vertical mean between dif levels (2D)
'lmsalc' : middle + lower layer salt content 300m-bottom
'ohc' : global total ocean heat content
'ohc_specified_layer' : Pointwise ocean heat content in a specified ocean thickness (at present 0-300 m)
'uohc' : global upper (0-350m) ocean heat content
'mohc' : global middle (350-800m) ocean heat content
'lohc' : global lower (800m-bottom) ocean heat content
'xohc' : global mixed layer ocean heat content
'TSec_ave190-220E' : meridional temperature section averaged between 190E and 220E
'SSec_ave190-220E' : meridional salinity section averaged between 190E and 220E (added in february 2013 update)
'vert_Tsections' : zonal temperature sections along 45S, 0N, 45N, and
meridional temperature sections along 30W, 80E, 180E
'vert_Ssections' : zonal salinity sections along 45S, 0N, 45N, and
meridional salinity sections along 30W, 80E, 180E (added in february 2013 update)
'3dtemp' : 3-dimensional temperature interpolated horizontally onto the
atmospheric grid
'3dsal' : 3-dimensional salinity interpolated horizontally onto the
atmospheric grid (added in february 2013 update)
'NAtlohc' : North Atlantic (10-65N) total ocean heat content
'xNAtlohc' : North Atlantic (10-65N) mixed layer ocean heat content
'uNAtlohc' : North Atlantic (10-65N) upper (0-350m) ocean heat content
'mNAtlohc' : North Atlantic (10-65N) middle (350-800m) ocean heat content
'lNAtlohc' : North Atlantic (10-65N) lower (800m-bottom) ocean heat content
'NPacohc' : North Pacific (10-70N) ocean heat content
'xNPacohc' : North Pacific (10-70N) mixed layer ocean heat content
'uNPacohc' : North Pacific (10-70N) upper (0-350m) ocean heat content
'mNPacohc' : North Pacific (10-70N) middle (350-800m) ocean heat content
'lNPacohc' : North Pacific (10-70N) lower (800m-bottom) ocean heat content
'TAtlohc' : Tropical Atlantic (30S-30N) ocean heat content
'xTAtlohc' : Tropical Atlantic (30S-30N) mixed layer ocean heat content
'uTAtlohc' : Tropical Atlantic (30S-30N) upper (0-350m) ocean heat content
'mTAtlohc' : Tropical Atlantic (30S-30N) middle (350-800m) ocean heat
content
'lTAtlohc' : Tropical Atlantic (30S-30N) lower (800m-bottom) ocean heat
content
'TPacohc' : Tropical Pacific (30S-30N) ocean heat content
'xTPacohc' : Tropical Pacific (30S-30N) mixed layer ocean heat content
'uTPacohc' : Tropical Pacific (30S-30N) upper (0-350m) ocean heat content
'mTPacohc' : Tropical Pacific (30S-30N) middle (350-800m) ocean heat content
'lTPacohc' : Tropical Pacific (30S-30N) lower (800m-bottom) ocean heat
content
'TIndohc' : Tropical Indian (30S-30N) ocean heat content
'xTIndohc' : Tropical Indian (30S-30N) mixed layer ocean heat content
'uTIndohc' : Tropical Indian (30S-30N) upper (0-350m) ocean heat content
'mTIndohc' : Tropical Indian (30S-30N) middle (350-800m) ocean heat content
'lTIndohc' : Tropical Indian (30S-30N) lower (800m-bottom) ocean heat
content
'Antaohc' : Antarctic (90-60S) ocean heat content
'xAntaohc' : Antarctic (90-60S) mixed layer ocean heat content
'uAntaohc' : Antarctic (90-60S) upper (0-350m) ocean heat content
'mAntaohc' : Antarctic (90-60S) middle (350-800m) ocean heat content
'lAntaohc' : Antarctic (90-60S) lower (800m-bottom) ocean heat content
'Arctohc' : Arctic (65-90N) ocean heat content
'xArctohc' : Arctic (65-90N) mixed layer ocean heat content
'uArctohc' : Arctic (65-90N) upper (0-350m) ocean heat content
'mArctohc' : Arctic (65-90N) middle (350-800m) ocean heat content
'lArctohc' : Arctic (65-90N) lower (800m-bottom) ocean heat content
'temp_lev' : vertical mean of ocean temp (weighted) between level1 and level2 (in numbers, not in meters), specified in the config file
'sal_lev' : vertical mean of ocean sal (weighted) between level1 and level2 (in numbers, not in meters), specified in the config file
#!/usr/bin/env python
# coding=utf-8
"""Script for launching Earth Diagnostics"""
import os
import sys
scriptdir = os.path.abspath(os.path.dirname(sys.argv[0]))
assert sys.path[0] == scriptdir
sys.path[0] = os.path.normpath(os.path.join(scriptdir, os.pardir))
# noinspection PyUnresolvedReferences,PyPep8
from earthdiagnostics.earthdiags import EarthDiags
# noinspection PyProtectedMember
def main():
"""
Entry point for the Earth Diagnostics
"""
if not EarthDiags.parse_args():
os._exit(1)
os._exit(0)
if __name__ == "__main__":
main()
This diff is collapsed.
#!/bin/bash
# This is an example of a configuration_file needed to launch ocean_pp.bash. For any other information about how to use it, you can refer to the README or the cfu wiki (http://ic3.cat/wikicfu/index.php/Tools#update_February_2013).
listpost=('temp_lev' 'sal_lev')
# Valid options : ('siasiesiv' 'ohc' 'moc' 'max_moc' 'area_moc' 'ext_raw_ice' (previously 'ice') 'ext_raw_oce' (previously 'sstsssmld') 'heat_sal_mxl' 'psi' 'usalc' 'lmsalc' 'uohc' 'mohc' 'lohc' 'xohc' 'ohc_specified_layer' 'stc' 'vert_Tsections' 'vert_Ssections' '3dtemp' '3dsal' 'TSec_ave190-220E' 'SSec_ave190-220E' 'NAtlohc' 'xNAtlohc' 'uNAtlohc' 'mNAtlohc' 'lNAtlohc' 'NPacohc' 'xNPacohc' 'uNPacohc' 'mNPacohc' 'lNPacohc' 'TAtlohc' 'xTAtlohc' 'uTAtlohc' 'mTAtlohc' 'lTAtlohc' 'TPacohc' 'xTPacohc' 'uTPacohc' 'mTPacohc' 'lTPacohc' 'TIndohc' 'xTIndohc' 'uTIndohc' 'mTIndohc' 'lTIndohc' 'Antaohc' 'xAntaohc' 'uAntaohc' 'mAntaohc' 'lAntaohc' 'Arctohc' 'xArctohc' 'uArctohc' 'mArctohc' 'lArctohc' )
# Beware that the max_moc diagnostics can not be computed if you don't process complete years (because that's a diagnostic computed from annual means)
level1=1
level2=14 #If temp_lev or sal_lev is chosen on listpost, the lev1 and lev2 correspond to the levels between which the vertical mean has to be calculated. Lev1 and lev2 should be between 1,42 or 1,46, depending on the numbers of vertical levels on the original files.
raw_vars_ocean=( '' ) # If listpost contains "ext_raw_oce" option, this is the list ocean variables you want to extract. If nothing is specified, all variables present in input file will be treated. If raw_vars_ocean='default', sosstsst, sosaline, somixhgt and somxl010 will be extracted.
raw_vars_ice=( '' ) # If listpost contains "ext_raw_ice" option, this is the list of seaice variables you want to extract. If nothing is specified, all variables will be treated. If raw_vars_ice='default', isnowthi, iicethic, ileadfra, iicetemp, and ice_pres will be extracted.
expid=m02j # expid or nemovar_s4 / nemovar_combine / glorys2v1
mod='ecearth' # nemo / ecearth
typeoutput='MMO' # diags / MMO
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
listmemb=( 0 1 2 3 4 5 6 7 8 9 ) # list of members
syeari=1993 # first start date, format "yyyy"
syearf=2009 # last start date, format "yyyy"
moni=11 # first month of the hindcast, format "mm", e.g. 05 for May
intsdate=1 # interval between start dates
chunklen=4 # length of the chunks (in months)
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ltime0=1 # first leadtime to post-process
ltimef=4 # last leadtime to postprocess
# Fill up either ltime0/ltimef or year0/yearf
year0= # first year to post-process in the fist start date
yearf= # last year to post-process in the fist start date
# If you fill up the year argument, complete years will be processed, year by
# year from moni
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
NEMOVERSION=Ec3.0_O1L46 # NEMO version
# Valid options : Ec2.3_O1L42 for Ec-Earth 2.3 ORCA1 L42
# Ec3.0_O1L46 for Ec-Earth 3.0 ORCA1 L46
# Ec3.0_O25L46 for Ec-Earth 3.0 ORCA0.25 L46
# N3.2_O1L42 for Nemo 3.2 ORCA1 L42
# N3.3_O1L46 for Nemo 3.3 ORCA1 L42
# nemovar_O1L42 for Nemo COMBINE and ORAS4 ORCA1L42
# === Development in progress : ===
# glorys2v1_O25L75 for Nemo GLORYS2v1 ORCA025L75
# ucl_O2L31 for Nemo UCL ORCA2L31
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
PATHCOMMONOCEANDIAG='/home/Earth/'${USER}'/ocean_diagnostics'
CON_FILES='/esnas/autosubmit/con_files'
rootout='/esnas/exp/'${mod}'/'${expid}'/monthly_mean'
#rootout='/esnas/exp/'${mod}'/'${expid}'/daily_mean'
[DIAGNOSTICS]
# Data adaptor type: CMOR (for our experiments), THREDDS (for other experiments)
DATA_ADAPTOR = OBSRECON
# Path to the folder where you want to create the temporary files
SCRATCH_DIR = /scratch/Earth/$USER
# Root path for the cmorized data to use
DATA_DIR = /esnas:/esarchive
# Specify if your data is from an experiment (exp), observation (obs) or reconstructions (recon)
DATA_TYPE = recon
# CMORization type to use. Important also for THREDDS as it affects variable name conventions.
# Options: SPECS (default), PRIMAVERA, CMIP6
DATA_CONVENTION = SPECS
# Path to NEMO's mask and grid files needed for CDFTools
CON_FILES = /esnas/autosubmit/con_files/
# Diagnostics to run, space separated. You must provide for each one the name and the parameters (comma separated) or
# an alias defined in the ALIAS section (see more below). If you are using the diagnostics just to CMORize, leave it
# empty
#DIAGS = discretize,atmos,sfcWind,,0,40
DIAGS = climpercent,atmos,sfcWind,2010,2012,11 daysover,atmos,sfcWind,2010,2012,11
#DIAGS = OHC
# Frequency of the data you want to use by default. Some diagnostics do not use this value: i.e. monmean always stores
# its results at monthly frequency (obvious) and has a parameter to specify input's frequency.
FREQUENCY = 6hr
# Path to CDFTOOLS binaries
CDFTOOLS_PATH = ~jvegas/CDFTOOLS/bin
# If true, copies the mesh files regardless of presence in scratch dir
RESTORE_MESHES = False
# Limits the maximum amount of threads used. Default: 0 (no limitation, one per virtual core available)z
MAX_CORES = 2
[CMOR]
# If true, recreates CMOR files regardless of presence. Default = False
FORCE = False
# If true, CMORizes ocean files. Default = True
OCEAN_FILES = True
FILTER_FILES =
# If true, CMORizes atmosphere files. Default = True
ATMOSPHERE_FILES = False
# You can specify the variable to cmorize, in the way domain:var domain:var2 domain2:var
VARIABLE_LIST =
# Variables to be CMORized from the grib atmospheric files, separated by comma.
# You can also specify the levels to extract using the following syntax
# VARIABLE_CODE, VARIABLE_CODE:LEVEL, VARIABLE_CODE:LEVEL1-LEVEL2, VARIABLE_CODE:MIN_LEVEL:MAX_LEVEL:STEP
# Examples:
# Variable with code 129 at level 30000: 129:30000
# Variable with code 129 at levels 30000, 40000 and 60000: 129:30000-40000-60000
# Variable with code 129 at levels between 30000 and 600000 with 10000 intervals:
# 129:30000:60000:10000 equivalent to 129:30000-40000-50000-60000
# Hourly vars
ATMOS_HOURLY_VARS = 129:30000:90000:5000, 130, 131:30000:90000:5000, 132:30000:90000:5000, 151, 167, 168, 164, 165, 166
# Daily vars
ATMOS_DAILY_VARS = 167, 165, 166, 151, 164, 168, 169, 177, 179, 228, 201, 202, 130:85000
# Monthly vars
ATMOS_MONTHLY_VARS = 167, 201, 202, 165, 166, 151, 144, 228, 205, 182, 164, 146, 147, 176, 169, 177, 175, 212, 141, 180, 181, 179, 168, 243, 129:5000-20000-50000-85000, 130:5000-20000-50000-85000, 131:5000-20000-50000-85000, 132:5000-20000-50000-85000, 133:5000-20000-50000-85000
# The next bunch of parameters are used to provide metadata for the CMOR files
# ASSOCIATED_EXPERIMENT =
# INITIALIZATION_METHOD = 1
# INITIALIZATION_DESCRIPTION = ocean: ECMWF system4, ice: DFS4.3 , atmosphere:
# PHYSICS_VERSION = 1
# PHYSICS_DESCRIPTION =
# ASSOCIATED_MODEL =
# SOURCE = 'EC-Earthv2.3.0, ocean: Nemo3.1, ifs31r1, lim2
[THREDDS]
SERVER_URL = https://earth.bsc.es/thredds
[EXPERIMENT]
# Experiments parameters as defined in CMOR standard
INSTITUTE = ecmwf
MODEL = erainterim
# Model version: Available versions
MODEL_VERSION = Ec3.2_O1L75
# Atmospheric output timestep in hours
ATMOS_TIMESTEP = 6
# Ocean output timestep in hours
OCEAN_TIMESTEP = 6
# For those who use Autosubmit, this will be easy
# EXPID is the unique identifier of the experiment.
# STARTDATES is the list of start dates
# MEMBERS is the list of members of your experiment (only the numbers, the fc will be added by the tool)
# MEMBER_DIGITS is the minimum number of digits to use for the member name: if 1 the name for member 0 will be fc0,
# if 2, fc00
# CHUNK_SIZE is the size of each data file, given in months
# CHUNKS is the number of chunks. You can specify less chunks than present on the experiment
EXPID = testing_erainterim
STARTDATES = 20101101 20111101 20121101
# STARTDATES = 19840101 19850101
MEMBERS = 0
MEMBER_DIGITS = 1
CHUNK_SIZE = 1
CHUNKS = 1
# CHUNKS = 1
# This ALIAS section is a bit different
# Inside this, you can provide alias for frequent diagnostics calls.
# By default, there are some of the diagnostics available at the previous version.
# You can define an alias for one or moraa90a1ee diagnostic calls
[ALIAS]
MAX_MOC = mocmax,38,50,500,2000 mocmax,40,40,0,10000
AREA_MOC = mocarea,40,55,1000,2000,atl mocarea,30,40,1000,2000,atl
STC = mocarea,0,25,0,200,Pac mocarea,-25,0,0,200,Pac mocarea,0,25,0,200,Atl mocarea,-25,0,0,200,Atl
HEAT_SAL_MXL = mlotstsc mlotsthc
LMSALC = vertmeanmeters,so,300,5400
USALC = vertmeanmeters,so,0,300
OHC = ohc,glob,0,1,10
XOHC = ohc,glob,1,0,0
LOHC = ohc,glob,0,23,46
MOHC = ohc,glob,0,18,22
UOHC = ohc,glob,0,1,17
OHC_SPECIFIED_LAYER = ohclayer,0,300 ohclayer,300,800
3DTEMP = interp,thetao
3DSAL = interp,so
TSEC_AVE190-220E =avgsection,ocean,thetao,190,220,-90,90,regular
SSEC_AVE190-220E =avgsection,ocean,so,190,220,-90,90,regular
VERT_SSECTIONS = cutsection,so,Z,0 cutsection,so,Z,45 cutsection,so,Z,-45 cutsection,so,M,-30 cutsection,so,M,80
VERT_TSECTIONS = cutsection,thetao,Z,0 cutsection,thetao,Z,45 cutsection,thetao,Z,-45 cutsection,thetao,M,-30 cutsection,thetao,M,180 cutsection,thetao,M,80
SIASIESIV = siasiesiv,glob
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/EarthDiagnostics.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/EarthDiagnostics.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/EarthDiagnostics"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/EarthDiagnostics"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
earthdiagnostics
================
earthdiagnostics.box
--------------------
.. automodule:: earthdiagnostics.box
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.cdftools
-------------------------
.. automodule:: earthdiagnostics.cdftools
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.cmorizer
-------------------------
.. automodule:: earthdiagnostics.cmorizer
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.cmormanager
----------------------------
.. automodule:: earthdiagnostics.cmormanager
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.config
-----------------------
.. automodule:: earthdiagnostics.config
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.constants
--------------------------
.. automodule:: earthdiagnostics.constants
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.datamanager
----------------------------
.. automodule:: earthdiagnostics.datamanager
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.diagnostic
---------------------------
.. automodule:: earthdiagnostics.diagnostic
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.earthdiags
---------------------------
.. automodule:: earthdiagnostics.earthdiags
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.parser
-----------------------
.. automodule:: earthdiagnostics.parser
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.utils
----------------------
.. automodule:: earthdiagnostics.utils
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.variable
-------------------------
.. automodule:: earthdiagnostics.variable
:show-inheritance:
:inherited-members:
:members:
earthdiagnostics.general
========================
earthdiagnostics.general.attribute
----------------------------------