Skip to content

Latest commit

 

History

History
60 lines (34 loc) · 2.08 KB

README.md

File metadata and controls

60 lines (34 loc) · 2.08 KB

Zapata

Computational and Mapping Library

A revolutionary library for analysis and plotting of meteorological data. The mapping is based on cartopy and GEOCAT libraries from NCAR. It uses xarray as a core data structure for all processing.

The directory examples_notebook contains working Jupyter Notebooks to illustarte different applications of Zapata.

Documentation

Zapata documentation is created using sphinx and it is sourced from the code itself.

To create a local copy of HTML documentation go to docs folder and type gmake html. If a previous compilation of the documentation exist, it is a good practice to clean up with gmake clean before updating the HTML files.

HTML documentation can be accessed opening the main page at docs/build/html/index.html

To update the entire content of the documentation (e.g., after the inclusion of new modules) go to docs folder and use sphinx-apidoc: sphinx-apidoc -f -e -M -o source ..

Setup working environemt

Python working environment can be setup using the provided conda environment.yml file:

conda env create -f environment.yml

conda activate zapata

To update your zapata environment with following updates use

conda env update -f environment.yml

Library content

zapata package

Contains computation modules and plotting modules along with dedicated functions to read input data form different datasets (local and remote).

  • computation : Routines for averaging and various computations

  • data : Information on data sets and routine to get data from the data sets

  • mapping : Mapping routines based on Cartopy

  • lib : Utilties for the rest of the modules.

klus package

Contains algorithms for data analysis contributed by Stefan Klus

  • algorithms : Routines for averaging and various computations

  • kernel : Information on data sets and routine to get data from the data sets

  • osbervables : Mapping routines based on Cartopy

interp module

subroutines for data interpolation

Zeus module

Functions to access and remote working on Zeus cluster