https://github.com/vacumm/vacumm
A python library for ocean sciences
https://github.com/vacumm/vacumm
oceanography python
Last synced: 11 days ago
JSON representation
A python library for ocean sciences
- Host: GitHub
- URL: https://github.com/vacumm/vacumm
- Owner: VACUMM
- License: other
- Created: 2015-09-30T15:27:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-07-17T13:14:25.000Z (over 5 years ago)
- Last Synced: 2025-06-06T20:07:28.752Z (9 months ago)
- Topics: oceanography, python
- Language: Python
- Homepage: http://vacumm.github.io/vacumm/
- Size: 107 MB
- Stars: 18
- Watchers: 10
- Forks: 3
- Open Issues: 13
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
VACUMM
======
.. image:: https://zenodo.org/badge/22859/VACUMM/vacumm.svg
:target: https://zenodo.org/badge/latestdoi/22859/VACUMM/vacumm
.. image:: https://travis-ci.org/VACUMM/vacumm.svg?branch=master
:target: https://travis-ci.org/VACUMM/vacumm
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 `_.
.. code-block:: python
>>> from vcmq import *
>>> sst = DS(data_sample('mars3d.xy.nc'), 'mars').get_sst()
>>> map2(sst)
Features
--------
- 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/basemap 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.
Dependencies
------------
Mandatory:
`CDAT `_ (or more specifically
`cdms2 `_,
`cdutil `_,
`genutil `_ from CDAT, and
`matplotlib `_,
`basemap `_),
`configobj `_.
Optional:
`seawater `_,
`PIL `_,
`pytz `_,
`paramiko `_,
`xlwt `_,
`sphinx-fortran `_,
`cmocean `_.
Download
--------
To download VACUMM sources, please go to this page:
http://www.ifremer.fr/vacumm/user.install.download.html
Installation
------------
From sources::
$ python setup.py install
Using `conda `_::
$ conda install -c vacumm -c conda-forge -c cdat vacumm
For more information, please go to this:
http://www.ifremer.fr/vacumm/user.install.installations.html
Release notes
-------------
Release notes for each version are available here:
http://www.ifremer.fr/vacumm/appendix.release.html
Documentation
-------------
The documentation is available here:
http://www.ifremer.fr/vacumm
License
-------
VACUMM is under the :ref:`CeCiLL ` license,
which is compatible with well knwon GPL license.
Support
-------
You can submit `issues `_
and `pull requests `_
from the GitHub site.
Stephane Raynaud (raynaud (at) gmail.com),
Guillaume Charria (Guillaume.Charria (at) ifremer.fr).
See the contact page:
http://www.ifremer.fr/vacumm/contact.html