carputils.carpio Namespace Reference

Each module in this package defines a class for reading and writing a specific data type. More...

Namespaces
	bin
	Provides a class for bench .bin file IO to/from python numpy arrays.
	csv
	Read csv files.
	filelike
	igb
	Provides a class for IGB IO to/from python numpy arrays.
	limpetguihdf5
	lut
	Read binary lookup tables into python numpy arrays.
	meshtool
	msh_stats
	quantity
	Provides a class to convert physical quantities from a string to numerical values.
	sv
	Functionality to read/write state variable (sv) files.
	tagdefs
	Provides a class for .dat and .vec IO to/from python numpy arrays.
	txt
	Provides a class for .dat and .vec IO to/from python numpy arrays.

Functions
def	show (msg, mode=1, showTime=None)
	Helper function to output status messages to the commandline. More...
def	print_dict (dict_config)
def	dat2adj (datfile, adjfile, grid='intra')
	Convert a .dat file to a nodal adjustment vector file. More...
def	create_struct (kwargs)
	create structure with provided members More...

Variables
dictionary	READERS
bool	globalShowTime = False

Detailed Description

Each module in this package defines a class for reading and writing a specific data type.

Some convenience methods are also provided for common file type conversions.

Function Documentation

create_struct()

def carputils.carpio.create_struct

(

kwargs

)

create structure with provided members

Parameters

kwargs dict

object of type Struct where the attributes are the keys of the provided kwargs holding the corresponding values

dat2adj()

def carputils.carpio.dat2adj	(		datfile,
			adjfile,
			grid = 'intra'
	)

Convert a .dat file to a nodal adjustment vector file.

Parameters

datfile	(str) Path of .dat file to convert
adjfile	(str) Path to write nodal adjustment vector file
grid	(str) String to enter in output file header as grid type

print_dict()

def carputils.carpio.print_dict

(

dict_config

)

show()

def carputils.carpio.show	(		msg,
			mode = 1,
			showTime = None
	)

Helper function to output status messages to the commandline.

In case the standard terminal size can not be identified, the default message line length will be 80 characters.

Parameters

msg	Message to send to the command line
mode	0 – message will be framed with a header and footer e.g. "==="
1	message will be prepended with a hash tag
showTime	append the time to the message

Variable Documentation

globalShowTime

bool carputils.carpio.globalShowTime = False

READERS

dictionary carputils.carpio.READERS

Initial value:

=  {'.igb':      igb.open,
           '.igb.gz':   igb.open,
           '.dynpt':    igb.open,
           '.dynpt.gz': igb.open,
           '.dat':      txt.open,
           '.dat.gz':   txt.open,
           '.vec':      txt.open,
           '.vec.gz':   txt.open,
           '.vtx':      txt.open,
           '.vtx.gz':   txt.open,
           '.bin':      bin.open,
           '.csv':      csv.open}