Outputs (taurex.output)

Base

Output base class

MetadataType

Type for metadata

alias of Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]]

class Output(name: str)

Bases: OutputGroup

Base calss for handling outputs from Taurex3

close() → None

Close output.

open() → None

Open output.

store_dictionary(dictionary: Dict[str, Any], group_name: str | None = None) → None

Store a dictionary in the output.

class OutputGroup(name: str)

Bases: Loggable

Stores output data in a hierarchical structure.

create_group(group_name: str) → OutputGroup

Create a group.

store_dictionary(dictionary: Dict[str, Any], group_name: str | None = None) → None

Store a dictionary in the output.

write_array(array_name: str, array: ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_list(list_name: str, list_array: _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_scalar(scalar_name: str, scalar: float | int | float64 | int64, metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_string(string_name: str, string: str, metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_string_array(string_name: str, string_array: str | None, metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

taurex.output.hdf5 module

Outputs using HDF5 format.

class HDF5Output(filename, append=False)

Bases: Output, HDF5OutputGroup

Output using HDF5 format.

close() → None

Close file.

open() → None

Open file.

class HDF5OutputGroup(entry: Group | None = None, name: str | None = None)

Bases: OutputGroup

Stores output data in the HDF5 hierarchical structure.

create_group(group_name: str) → HDF5OutputGroup

Create a group.

write_array(array_name: str, array: ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_scalar(scalar_name: str, scalar: float | int | float64 | int64, metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_string(string_name: str, string: str, metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_string_array(string_name: str, string_array: Sequence[str], metadata: Dict[str, Any] = None) → None

Write a string array to the output.

taurex.output.writeable module

Writeable class.

class Writeable

Bases: object

Abstract class for writeable objects.

abstract write(output)

Module contents

Module to handle outputs and storage from various models.

class HDF5Output(filename, append=False)

Bases: Output, HDF5OutputGroup

Output using HDF5 format.

close() → None

Close file.

open() → None

Open file.

class Output(name: str)

Bases: OutputGroup

Base calss for handling outputs from Taurex3

close() → None

Close output.

open() → None

Open output.

store_dictionary(dictionary: Dict[str, Any], group_name: str | None = None) → None

Store a dictionary in the output.

class OutputGroup(name: str)

Bases: Loggable

Stores output data in a hierarchical structure.

create_group(group_name: str) → OutputGroup

Create a group.

store_dictionary(dictionary: Dict[str, Any], group_name: str | None = None) → None

Store a dictionary in the output.

write_array(array_name: str, array: ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_list(list_name: str, list_array: _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_scalar(scalar_name: str, scalar: float | int | float64 | int64, metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_string(string_name: str, string: str, metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

write_string_array(string_name: str, string_array: str | None, metadata: Dict[str, float | int | float64 | int64 | ndarray | _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]] | None = None) → None

class Writeable

Bases: object

Abstract class for writeable objects.

abstract write(output)