epygram — About the Package

Enhanced Python for Graphics and Analysis of Meteorological fields

epygram is a package of classes, designed to handle Meteorological Fields, and various resource Formats from which the Fields can be extracted.

It is distributed along with a series of applicative tools using the package, that can be used ‘as is’, or can be taken as templates for building more complex applications with the epygram package.

The package uses extensively the footprints package (included in epygram distributions), designed by the VORTEX team (MF) in order (basically) to tackle once-for-all with Factories for families of similar classes. The basic idea behind this concept is that similar classes have a similar set of attributes, but with behavioral differences (values or name/number of attributes), viewed as their “footprint”.

For the needs of the FA, LFI & LFA formats and spectral transforms of fields from ARPEGE/ALADIN/AROME models, the arpifs4py library is needed. It is also therein included, already compiled for Mageia4 platforms, and with necessary stuff for recompiling it on other platforms. Be aware to be recompiled, this library needs an arpifs pack pre-compiled with gmkpack, and gribex library.

Other dependencies:

and (if according formats are activated):


Copyright Météo France (2014 - 2016), contributors : A. Mary <Météo France, CNRM/GMAP/COOPE, alexandre.mary@meteo.fr> || S. Riette

This software is governed by the CeCILL-C license under French law and abiding by the rules of distribution of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following URL “http://www.cecill.info”.

As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software’s author, the holder of the economic rights, and the successive licensors have only limited liability.

In this respect, the user’s attention is drawn to the risks associated with loading, using, modifying and/or developing or reproducing the software by the user in light of its specific status of free software, that may mean that it is complicated to manipulate, and that also therefore means that it is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the software’s suitability as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions as regards security.

The fact that you are presently reading this means that you have had knowledge of the CeCILL-C license and that you accept its terms.


Miscellaneous

class epygram.epygramError[source]

Bases: exceptions.Exception

Errors class for the package.

epygram.init_env(omp_num_threads=1, no_mpi=True, unlimited_stack=True)

A function to modify execution environment (to be called early in execution).

Currently,

  • environments variables:
    • if no_mpi, DR_HOOK_NOT_MPI set to 1
    • OMP_NUM_THREADS set to omp_num_threads
  • stack size unlimited on Bull.
epygram.showconfig()[source]

Print current config.