pencil.read.zprof

Contains the classes and methods to read the time series file.

Classes

ZProfile

ZProfile -- holds the zprofile data.

Functions

zprof(*args, **kwargs)

zprof(var_name, datadir='data', dim=None, nfield=1)

Module Contents

pencil.read.zprof.zprof(*args, **kwargs)

zprof(var_name, datadir=’data’, dim=None, nfield=1)

Read vertical profiles written in data/proc*/zprof_varname.dat. Returns a ZProfile object with z and profiles(z).

Parameters:

• var_name (string) – Name of the zprof var file.

• datadir (string) – Directory where the data is stored.

• dim (obj) – Dimension object.

• nfield (int) – Number of fields to be read.

class pencil.read.zprof.ZProfile

Bases: object

ZProfile – holds the zprofile data.

Fill members with default values.

prof = 0

z = 0

keys()

read(var_name, datadir='data', dim=None, nfield=1)

read(var_name, datadir=’data’, dim=None, nfield=1)

Read vertical profiles written in data/proc*/zprof_varname.dat. Returns a ZProfile object with z and profiles(z).

Parameters:

• var_name (string) – Name of the zprof var file.

• datadir (string) – Directory where the data is stored.

• dim (obj) – Dimension object.

• nfield (int) – Number of fields to be read.