py-modelrunner
latest
Installation
Install using pip
Install using conda
Installing from source
Prerequisites
Downloading the package
User Manual
Main structure of the package
Design philosophy
Examples
io_hdf.py
io_json.py
io_yaml.py
model_class.py
model_decorator.py
model_function.py
model_storage_output.py
read_many.py
script_custom_func.py
script_function.py
script_many_classes.py
script_minimal.py
script_model_class.py
submit_function.py
submit_many_func.py
submit_many_iter.py
submit_shebang.py
modelrunner package
modelrunner.model package
modelrunner.model.base module
modelrunner.model.factory module
modelrunner.model.parameters module
modelrunner.run package
modelrunner.run.compatibility package
modelrunner.run.compatibility.triage module
modelrunner.run.compatibility.version0 module
modelrunner.run.compatibility.version1 module
modelrunner.run.compatibility.version2 module
modelrunner.run.job module
modelrunner.run.launch module
modelrunner.run.results module
modelrunner.storage package
modelrunner.storage.backend package
modelrunner.storage.backend.hdf module
modelrunner.storage.backend.json module
modelrunner.storage.backend.memory module
modelrunner.storage.backend.text_base module
modelrunner.storage.backend.utils module
modelrunner.storage.backend.yaml module
modelrunner.storage.backend.zarr module
modelrunner.storage.access_modes module
modelrunner.storage.attributes module
modelrunner.storage.base module
modelrunner.storage.group module
modelrunner.storage.tools module
modelrunner.storage.trajectory module
modelrunner.storage.utils module
modelrunner.config module
modelrunner.utils module
py-modelrunner
Index
Edit on GitHub
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
|
Y
|
Z
A
AccessError
AccessMode (class in modelrunner.storage.access_modes)
append() (TrajectoryWriter method)
Array (class in modelrunner.storage.utils)
ArrayCollectionState (class in modelrunner.run.compatibility.version1)
ArrayState (class in modelrunner.run.compatibility.version1)
as_dataframe() (ResultCollection method)
attrs (StorageGroup property)
auto_type() (in module modelrunner.model.parameters)
C
can_update (StorageBase property)
(ZarrStorage property)
,
[1]
choices (Parameter attribute)
classmethod() (hybridmethod method)
clear() (MemoryStorage method)
,
[1]
cleared_default_model() (in module modelrunner.model.factory)
close() (HDFStorage method)
,
[1]
(ModelBase method)
(open_storage method)
(StorageBase method)
(TextStorageBase method)
(Trajectory method)
(TrajectoryWriter method)
(ZarrStorage method)
,
[1]
closed (open_storage property)
(StorageBase property)
cls (Parameter attribute)
codec (StorageBase property)
Config (class in modelrunner.config)
constant_parameters (ResultCollection property)
convert() (Parameter method)
copy() (Config method)
create_dynamic_array() (StorageBase method)
(StorageGroup method)
create_group() (StorageBase method)
(StorageGroup method)
D
data (Result property)
dataframe (ResultCollection property)
decode_attrs() (in module modelrunner.storage.attributes)
decode_binary() (in module modelrunner.storage.utils)
decode_class() (in module modelrunner.storage.utils)
default_codec (StorageBase attribute)
default_value (Parameter attribute)
DeprecatedParameter (class in modelrunner.model.parameters)
description (AccessMode attribute)
(ModelBase attribute)
(Parameter attribute)
DictState (class in modelrunner.run.compatibility.version1)
dynamic_append (AccessMode attribute)
E
encode_attrs() (in module modelrunner.storage.attributes)
encode_binary() (in module modelrunner.storage.utils)
encode_class() (in module modelrunner.storage.utils)
encode_internal_attrs (YAMLStorage attribute)
,
[1]
ensure_directory_exists() (in module modelrunner.run.job)
ensure_group() (StorageBase method)
environment variable
PYTHONPATH
escape_string() (in module modelrunner.run.job)
extend_dynamic_array() (StorageBase method)
(StorageGroup method)
extensions (HDFStorage attribute)
,
[1]
(JSONStorage attribute)
,
[1]
(StorageBase attribute)
(YAMLStorage attribute)
,
[1]
(ZarrStorage attribute)
,
[1]
extra (DeprecatedParameter attribute)
(Parameter attribute)
F
file_mode (AccessMode attribute)
filtered() (ResultCollection method)
flush() (StorageBase method)
(TextStorageBase method)
from_command_line() (ModelBase class method)
from_data() (Result class method)
(StateBase class method)
from_file() (Result class method)
from_folder() (ResultCollection class method)
G
get() (ResultCollection method)
(StorageGroup method)
get_all_parameters() (in module modelrunner.model.parameters)
get_class() (StorageGroup method)
get_config() (in module modelrunner.run.job)
get_job_name() (in module modelrunner.run.job)
get_parameter_default() (Parameterized class method)
get_parameters() (Parameterized class method)
get_result() (ModelBase method)
groupby() (ResultCollection method)
guess_format() (in module modelrunner.run.compatibility.triage)
H
HDFStorage (class in modelrunner.storage.backend)
(class in modelrunner.storage.backend.hdf)
hidden (Parameter attribute)
HideParameter (class in modelrunner.model.parameters)
hybridmethod (class in modelrunner.utils)
I
import_class() (in module modelrunner.utils)
info (Result attribute)
insert (AccessMode attribute)
instancemethod() (hybridmethod method)
is_group() (HDFStorage method)
,
[1]
(MemoryStorage method)
,
[1]
(StorageBase method)
(StorageGroup method)
(ZarrStorage method)
,
[1]
items() (StorageGroup method)
J
JSONStorage (class in modelrunner.storage.backend)
(class in modelrunner.storage.backend.json)
K
keys() (HDFStorage method)
,
[1]
(MemoryStorage method)
,
[1]
(StorageBase method)
(StorageGroup method)
(ZarrStorage method)
,
[1]
L
load() (Config method)
M
make_model() (in module modelrunner.model.factory)
make_model_class() (in module modelrunner.model.factory)
MemoryStorage (class in modelrunner.storage.backend)
(class in modelrunner.storage.backend.memory)
MockModel (class in modelrunner.run.results)
mode (HDFStorage attribute)
,
[1]
(JSONStorage attribute)
(open_storage property)
(StorageBase attribute)
(YAMLStorage attribute)
(ZarrStorage attribute)
,
[1]
model (Result attribute)
ModelBase (class in modelrunner.model.base)
modelrunner
module
modelrunner.config
module
modelrunner.model
module
modelrunner.model.base
module
modelrunner.model.factory
module
modelrunner.model.parameters
module
modelrunner.run
module
modelrunner.run.compatibility
module
modelrunner.run.compatibility.triage
module
modelrunner.run.compatibility.version0
module
modelrunner.run.compatibility.version1
module
modelrunner.run.compatibility.version2
module
modelrunner.run.job
module
modelrunner.run.launch
module
modelrunner.run.results
module
modelrunner.storage
module
modelrunner.storage.access_modes
module
modelrunner.storage.attributes
module
modelrunner.storage.backend
module
modelrunner.storage.backend.hdf
module
modelrunner.storage.backend.json
module
modelrunner.storage.backend.memory
module
modelrunner.storage.backend.text_base
module
modelrunner.storage.backend.utils
module
modelrunner.storage.backend.yaml
module
modelrunner.storage.backend.zarr
module
modelrunner.storage.base
module
modelrunner.storage.group
module
modelrunner.storage.tools
module
modelrunner.storage.trajectory
module
modelrunner.storage.utils
module
modelrunner.utils
module
module
modelrunner
modelrunner.config
modelrunner.model
modelrunner.model.base
modelrunner.model.factory
modelrunner.model.parameters
modelrunner.run
modelrunner.run.compatibility
modelrunner.run.compatibility.triage
modelrunner.run.compatibility.version0
modelrunner.run.compatibility.version1
modelrunner.run.compatibility.version2
modelrunner.run.job
modelrunner.run.launch
modelrunner.run.results
modelrunner.storage
modelrunner.storage.access_modes
modelrunner.storage.attributes
modelrunner.storage.backend
modelrunner.storage.backend.hdf
modelrunner.storage.backend.json
modelrunner.storage.backend.memory
modelrunner.storage.backend.text_base
modelrunner.storage.backend.utils
modelrunner.storage.backend.yaml
modelrunner.storage.backend.zarr
modelrunner.storage.base
modelrunner.storage.group
modelrunner.storage.tools
modelrunner.storage.trajectory
modelrunner.storage.utils
modelrunner.utils
N
name (AccessMode attribute)
(DeprecatedParameter attribute)
(ModelBase attribute)
(Parameter attribute)
NoData (class in modelrunner.run.compatibility.version1)
normalize_zarr_store() (in module modelrunner.run.compatibility.triage)
NoValueType (class in modelrunner.model.parameters)
O
ObjectState (class in modelrunner.run.compatibility.version1)
open_group() (StorageGroup method)
open_storage (class in modelrunner.storage.tools)
overwrite (AccessMode attribute)
P
Parameter (class in modelrunner.model.parameters)
Parameterized (class in modelrunner.model.parameters)
parameters (Result property)
(ResultCollection property)
parameters_default (Parameterized attribute)
parent (StorageGroup property)
parse() (AccessMode class method)
PYTHONPATH
R
read (AccessMode attribute)
read_array() (StorageBase method)
(StorageGroup method)
read_attrs() (StorageBase method)
(StorageGroup method)
read_hdf_data() (in module modelrunner.run.compatibility.version0)
read_item() (StorageGroup method)
read_object() (StorageBase method)
(StorageGroup method)
remove_duplicates() (ResultCollection method)
required (Parameter attribute)
Result (class in modelrunner.run.results)
result (Result attribute)
result_check_load_old_version() (in module modelrunner.run.compatibility.triage)
result_from_file_v0() (in module modelrunner.run.compatibility.version0)
result_from_file_v1() (in module modelrunner.run.compatibility.version1)
result_from_file_v2() (in module modelrunner.run.compatibility.version2)
ResultCollection (class in modelrunner.run.results)
run_from_command_line() (ModelBase class method)
run_function_with_cmd_args() (in module modelrunner.run.launch)
run_script() (in module modelrunner.run.launch)
S
same_model (ResultCollection property)
save() (Config method)
set_attrs (AccessMode attribute)
set_default() (in module modelrunner.model.factory)
short_description (Parameter property)
show_parameters() (Parameterized method)
simplify_data() (in module modelrunner.storage.backend.utils)
sorted() (ResultCollection method)
StateBase (class in modelrunner.run.compatibility.version1)
storage (ModelBase property)
(Result attribute)
StorageBase (class in modelrunner.storage.base)
StorageGroup (class in modelrunner.storage.group)
submit_job() (in module modelrunner.run.job)
submit_jobs() (in module modelrunner.run.job)
T
TextStorageBase (class in modelrunner.storage.backend.text_base)
times (Trajectory attribute)
(TrajectoryWriter property)
to_dict() (Config method)
to_file() (Result method)
to_text() (TextStorageBase method)
Trajectory (class in modelrunner.storage.trajectory)
TrajectoryWriter (class in modelrunner.storage.trajectory)
tree() (StorageGroup method)
V
varying_parameters (ResultCollection property)
W
write_array() (StorageBase method)
(StorageGroup method)
write_attrs() (StorageBase method)
(StorageGroup method)
write_item() (StorageGroup method)
write_object() (StorageBase method)
(StorageGroup method)
write_result() (ModelBase method)
Y
YAMLStorage (class in modelrunner.storage.backend)
(class in modelrunner.storage.backend.yaml)
Z
ZarrStorage (class in modelrunner.storage.backend)
(class in modelrunner.storage.backend.zarr)
Read the Docs
v: latest
Versions
latest
stable
Downloads
pdf
epub
On Read the Docs
Project Home
Builds