sbmlsim.result.xresult

Module for encoding simulation results and processed data.

Module Contents

Classes

XResult

Result of simulations.

Attributes

logger

r

sbmlsim.result.xresult.logger[source]
class sbmlsim.result.xresult.XResult(xdataset, uinfo=None)[source]

Result of simulations.

A wrapper around xr.Dataset which adds unit support via dictionary lookups.

Parameters
__getitem__(self, key)[source]

Get item.

Return type

xarray.DataArray

__getattr__(self, name)[source]

Provide dot access to keys.

__str__(self)[source]

Get string.

Return type

str

dim_mean(self, key)[source]

Get mean over all added dimensions.

Parameters

key (str) –

Return type

xarray.Dataset

dim_std(self, key)[source]

Get standard deviation over all added dimensions.

dim_min(self, key)[source]

Get minimum over all added dimensions.

dim_max(self, key)[source]

Get maximum over all added dimensions.

_redop_dims(self)[source]

Dimensions for reducing operations.

Return type

List[str]

classmethod from_dfs(cls, dfs, scan=None, uinfo=None)[source]

Create XResult from DataFrames.

Structure is based on the underlying scans

Parameters
Return type

XResult

to_netcdf(self, path_nc)[source]

Store results as netcdf.

is_timecourse(self)[source]

Check if timecourse.

Return type

bool

to_mean_dataframe(self)[source]

Convert to DataFrame with mean data.

Return type

pandas.DataFrame

to_dataframe(self)[source]

Convert to DataFrame.

Return type

pandas.DataFrame

to_tsv(self, path_tsv)[source]

Write data to tsv.

static from_netcdf(path)[source]

Read from netCDF.

sbmlsim.result.xresult.r[source]