mtnlion.tools.ldp module

Required modules.

class mtnlion.tools.ldp.Spreadsheet(assumption=None)[source]

Bases: object

Hold spreadsheet data.

cell(xpos, ypos)[source]

Retrieve cell information.

Parameters

  • xpos (integer) – cell row

  • ypos (integer) – cell column

Returns

cell values and info

Return type

xlrd.sheet.Cell

set_ctypes(ctype)[source]

Set spreadsheet cell types. I.e. NUMBER, TEXT, etc.

Parameters

ctype – cell types to set

set_data(data_in)[source]

Set spreadsheet data using cell generators.

set_values(values)[source]

Set spreadsheet cell values.

Parameters

values (container, e.g. list) – values to set

size()[source]

Retrieve the dimensions of the spreadsheet.

Returns

spreadsheed dimensions

Return type

tuple

mtnlion.tools.ldp.load(file, mmap_mode=None, allow_pickle=True, fix_imports=True, encoding='ASCII')[source]

Load numpy .npy and .npz files to an array or map of arrays respectively using np.load.

mtnlion.tools.ldp.load_mat(filename, variable)[source]

Read the variable from filename.

Example

sheet = read_mat(“parameter.mat”, “cse”)

Parameters

  • filename (string) – name of the .mat file to read

  • variable (string) – variable to load

Returns

variable data

Return type

array

mtnlion.tools.ldp.load_params(sheet, rows=None, ncols=None, pcols=None, cols=None, nrows=None, prows=None)[source]

Read designated parameters from the sheet.

Example

sheet=read_excel(‘parameter_list.xlsx’, 0, ‘index’) params[“pos”] = load_params(sheet, range(55, 75), ncols=2, pcols=3)

Parameters

  • sheet (ldp.Spreadsheet) – spreadsheet data

  • rows (range) – same as nrows=prows

  • cols (range) – same as ncols=pcols

  • nrows (int) – cell rows to read for parameter names

  • ncols (int) – cell columns to read for parameter names

  • prows (int) – cell rows to read for parameter data

  • pcols (int) – cell columns to read for parameter data

Returns

mapping of parameter names to values

Return type

dict

mtnlion.tools.ldp.load_section(sheet, row_range=None, col_range=None)[source]

Read a ‘chunk’ of data from a spreadsheet.

Given a selection of rows and columns, this function will return the intersection of the two ranges. Note that the minimum value for each range is 1.

Example

spreadsheet = read_excel(‘parameters.xlsx’, ‘Parameters’) cell_data = load_section(spreadsheet, [1, 3, 5], range(7, 42))

Parameters

  • sheet (xlrd.sheet) – spreadsheet data

  • row_range (list of integers or integer) – selected rows

  • col_range (list of integers or integer) – selected columns

Returns

section of sheet data

Return type

array if assume=NUMBER else list

mtnlion.tools.ldp.loadtxt(*args, **kwargs)[source]

Load ascii files into a numpy ndarray using numpy.loadtxt.

mtnlion.tools.ldp.read_csv(filename, start=1, stop=None, assume=1)[source]

Read a csv file into a Spreadsheet.

Example

sheet = read_csv(‘parameters.csv’, start=9, assume=NUMBER)

Parameters

  • filename (string) – name of the file to read

  • start (integer) – row to start reading

  • stop (integer) – row to stop reading

  • assume (integer) – type of data to assume

Returns

spreadsheet data

Return type

Spreadsheet

mtnlion.tools.ldp.read_excel(filename, sheet=None)[source]

Read sheet data or sheet names from an Excel workbook into a Spreadsheet.

Example

sheet_names = read_excel(‘parameter.xlsx’) # returns a list of sheet names

Example

spreadsheet = read_excel(‘parameter.xlsx’, 0) # read the first sheet

Example

spreadsheet = read_excel(parameter.xls’, ‘sheet_2’) # load ‘sheet_2’

Parameters

  • filename (string) – name of the excel woorkbook to import

  • sheet (string or integer or None) – spreadsheet name or index to import

Returns

sheet names if sheet is None, otherwise sheet data

Return type

list of strings if sheet is None, otherwise Spreadsheet