pencil.read.indices

Contains the index information.

Classes

Index

Index -- holds pencil code index data.

Functions

index(*args, **kwargs)

index(datadir='data', param=None, dim=None)

Module Contents

pencil.read.indices.index(*args, **kwargs)

index(datadir=’data’, param=None, dim=None)

Read Pencil Code index data from index.pro.

Parameters:

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

• param (obj) – Parameter object.

• dim (obj) – Dimension object.

Return type:

Class containing the index information.

class pencil.read.indices.Index

Bases: object

Index – holds pencil code index data.

Fill members with default values.

keys()

read(datadir='data', filename=None, param=None, dim=None)

read(datadir=’data’, param=None, dim=None)

Read Pencil Code index data from index.pro or other filename.

Parameters:

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

• filename (bool) – If present replace “index.pro”

• param (obj) – Parameter object.

• dim (obj) – Dimension object.

Return type:

Class containing the index information.