"Validation, Analysis, Comparison - Utilities written in Python to validate and analyze Multi-Model outputs, and compare them to observations."
-- Quote translated from the forge page of the project
VACUMM provides generic and specialized tools for the validation of ocean models, and more especially the MARS model from IFREMER. The heart of VACUMM is a library written mainly in the Python language, whose core can be used for the preprocessing and the postprocessing of oceanic and atmospheric data coming from models or observations. The library for instance also has specialized modules for managing outputs from models and making advanced diagnostics.
- A huge documentation with a gallery, a lot of examples and the complete API: http://www.ifremer.fr/vacumm
- Full UV-CDAT support and extensions.
- Matplotlib graphics with advanced plotting objects like geographical mapping tools.
- Numerous utilities for manipulating and converting time data.
- Regridding and interpolation of random or gridded data, in 1D or 2D, with curvilinear grid support.
- Helper routines for inspecting and reading NetCDF objects in single or multiple file datasets.
- Generic and specialized 1D and 2D filters working on masked variables.
- Specialized physical and numerical diagnostics, like dynamics, thermodynamics, spectral analyses, tides, etc.
- Support and extension of CF conventions for searching or formatting variables.
- Miscellaneous location utilities such as readers of sigma coordinates for ocean models, or Arakawa grid converters.
- High level generic interface for reading and post-processing NetCDF data from standard or known dataset, such as model outputs or satellite products.
- Statistical accumulator for large datasets.
- Interfaces for working with random and gridded bathymetries, and with shorelines.
- Utilities for working with masks and selection of spatial data.
- Utilities for working with input and output remote files.
- Advanced logging classes.
- Extensions to sphinx for Fortran and Python.
- A collection of scripts for some diagnostics.
RequirementsMandatory: UVCDAT, configobj.
Optional: seawater, PIL, pytz, paramiko, xlwt.
DownloadTo download VACUMM, please go to this page.
$ python setup.py install
Release notesRelease notes for each version are available on this page.
DocumentationThe documentation is available here, with in particular its user guide and its library.
LicenseVACUMM is under the CeCiLL license, which is compatible with well knwon GPL license.
TranslationThe documentation is currently being translated. Parts may be in english, in french or in both languages. If you want to contribute to the translation, you are welcome!
ContactStephane Raynaud (raynaud (at) actimar.fr), Guillaume Charria (Guillaume.Charria (at) ifremer.fr).
See the contact page.
CAPARMOR users!If you have an access to the CAPARMOR supercomputer at IFREMER, you can quickly try VACUMM from the shell:
$ module purge $ module use /home11/caparmor/mars/PYTHON/modulefiles $ module load uvcdat121 $ python
>>> import vacumm
>>> from vcmq import * >>> sst = DS(data_sample('mars3d.xy.nc'), 'mars').get_sst() >>> map2(sst)