Base Classes and Protocols

Base Classes and Protocols#

DataFieldSpecification#

DataFieldSpecification(name, dtype[, ...])

Class to define attributes for a data "field".

GSolveParameters#

GSolveParameters()

Base class to store parameters related to GSolveTable derived classes.

GSolveParameters.copy()

Return a deep copy of object.

GSolveParameters.from_series(ds[, ...])

Generate a GsolveParameters object from a pandas.Series.

GSolveParameters.default_values()

Return dict of default parameter values.

GSolveParameters.non_default_values()

Return dict of non-default parameter values.

GSolveParameters.summary([include_name, as_list])

Return parameters as strings in the form 'param: value'.

GSolveParameters.to_dict()

Return parameters as a dict.

GSolveParameters.to_excel(fname[, ...])

Write parameters to an Excel worksheet.

GSolveParameters.to_series([series_name, ...])

Return parameters as a Series with parameter names as the index.

GSolveTable#

GSolveTable()

Base class for various GSolve tabular data structures.

GSolveTable.copy()

Return a deep copy of object.

GSolveTable.from_csv(csv_file[, ...])

Create object from a CSV file.

GSolveTable.from_dataframe(df[, use_index, ...])

Create object from a pandas DataFrame.

GSolveTable.from_excel(excel_file[, ...])

Create a object from an Excel file.

GSolveTable.known_fields()

Return a list of known fields in the object.

GSolveTable.required_fields()

Return a list of required fields in the object.

GSolveTable.set_column(label[, data, ...])

Set a column in the obj.data attribute.

GSolveTable.write_to_csv(fname[, ...])

Write data to a csv file.