drrc
Content
1. User manual
1.1. Installing drrc
1.1.1. Installing the Needed Packages
1.1.2. Editable Installation of Development-Stage Code
1.2. Genration of training data
1.2.1. Creating 1D Kuramoto-Sivashinsky Data
1.2.2. Creating 2D Data
1.3. Running a job on the cluster
1.3.1. Installing python on the cluster
1.3.1.1. At MPI-DS
1.3.1.2. At GWDG
1.3.2. Submission Scripts
1.4. Analysing raw cluster output
1.5. Contributing to DRRC
1.5.1. Automated Documentation
1.5.2. First steps to work in this repository
1.5.3. Working in this repository
1.5.3.1. Avoiding “it works on my machine”-like problems
1.5.3.2. Formatting Code
1.6. The Manuscript
1.6.1. Generating Plots for this Project
1.7. Automated Testing
1.7.1. Workflow and local testing
1.8. Open Questions
2. drrc
2.1. drrc.tools package
2.1.1. drrc.tools.general_methods module
2.1.2. drrc.tools.logger_config module
2.1.3. drrc.tools.plot_config module
2.1.4. drrc.tools.visualization module
2.2. drrc.analysis module
2.3. drrc.config module
2.4. drrc.kuramoto_sivashinsky module
2.5. drrc.parallelreservoirs module
2.6. drrc.reservoircomputer module
2.7. drrc.spatially_extended_systems module
Changelog
UNPUBLISHED – 2025/10/02
drrc
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
V
|
W
_
_boundary_condition() (ParallelReservoirsBase method)
_collect_reservoir_state() (ReservoirComputer method)
_concatenate() (AutomaticPostprocessing method)
_evaluate_one_step() (ParallelReservoirsBase static method)
_generate_statistics() (AutomaticPostprocessing method)
(HyperPostProcessing method)
_get_adjacency_matrix() (ReservoirComputer method)
_get_initial() (IntegrationMethods static method)
_get_input_length() (ParallelReservoirs method)
(ParallelReservoirsBase method)
(ParallelReservoirsFFT method)
(ParallelReservoirsPCA method)
_get_input_matrix() (ReservoirComputer method)
_get_path() (in module drrc.tools.general_methods)
_get_raw_file() (HyperPostProcessing method)
_initialize_reservoir_slices() (ParallelReservoirsBase method)
_initialize_reservoirs() (ParallelReservoirsBase method)
_inv_transform_data() (ParallelReservoirs method)
(ParallelReservoirsBase method)
(ParallelReservoirsFFT method)
(ParallelReservoirsPCA method)
_read_test_csv() (AutomaticPostprocessing method)
_reformat_single_file() (HyperPostProcessing method)
_transform_data() (ParallelReservoirs method)
(ParallelReservoirsBase method)
(ParallelReservoirsFFT method)
(ParallelReservoirsPCA method)
A
aliev_panfilov_local() (LocalModel method)
AnalyseClusterRunBase (class in drrc.analysis)
apply_5stencil() (Diffusion method)
apply_9stencil() (Diffusion method)
auto_concatenate() (AutomaticPostprocessing method)
auto_statisticsgeneration() (AutomaticPostprocessing method)
AutomaticPostprocessing (class in drrc.analysis)
B
BoundaryCondition (class in drrc.spatially_extended_systems)
C
Config (class in drrc.config)
D
Diffusion (class in drrc.spatially_extended_systems)
drrc
module
drrc.analysis
module
drrc.config
module
drrc.kuramoto_sivashinsky
module
drrc.parallelreservoirs
module
drrc.reservoircomputer
module
drrc.spatially_extended_systems
module
drrc.tools
module
drrc.tools.general_methods
module
drrc.tools.logger_config
module
drrc.tools.plot_config
module
drrc.tools.visualization
module
E
ElapsedTimeFormatter (class in drrc.tools.logger_config)
error_calculation() (in module drrc.tools.general_methods)
exp_euler_itt() (IntegrationMethods static method)
exp_euler_itt_with_save() (IntegrationMethods static method)
F
fitzhugh_nagumo_local() (LocalModel method)
fix_raw_data() (HyperPostProcessing method)
format() (ElapsedTimeFormatter method)
from_config() (ParallelReservoirsArguments class method)
from_dict() (ParallelReservoirsArguments class method)
G
generate_submission_script_from_YAML() (Config method)
generate_timeseries() (KuramotoSivashinsky method)
generate_timeseries_pypde() (KuramotoSivashinsky method)
generate_timeseries_spectral() (KuramotoSivashinsky method)
get_data_dir() (Config method)
get_git_root() (Config static method)
H
HyperPostProcessing (class in drrc.analysis)
I
IndentDumper (class in drrc.config)
IntegrationMethods (class in drrc.spatially_extended_systems)
iterative_predict() (ParallelReservoirsBase method)
J
jobscript_datadir() (Config method)
K
KuramotoSivashinsky (class in drrc.kuramoto_sivashinsky)
L
load() (ParallelReservoirsBase method)
load_evalaluation_datasets() (Config method)
load_training_dataset() (Config method)
LocalModel (class in drrc.spatially_extended_systems)
M
make_jobscript_datadir() (Config method)
max_length (Config property)
module
drrc
drrc.analysis
drrc.config
drrc.kuramoto_sivashinsky
drrc.parallelreservoirs
drrc.reservoircomputer
drrc.spatially_extended_systems
drrc.tools
drrc.tools.general_methods
drrc.tools.logger_config
drrc.tools.plot_config
drrc.tools.visualization
N
no_flux() (BoundaryCondition method)
P
ParallelReservoirs (class in drrc.parallelreservoirs)
ParallelReservoirsArguments (class in drrc.parallelreservoirs)
ParallelReservoirsBase (class in drrc.parallelreservoirs)
ParallelReservoirsFFT (class in drrc.parallelreservoirs)
ParallelReservoirsPCA (class in drrc.parallelreservoirs)
param_scan_len() (Config method)
param_scan_list() (Config method)
parse_YAML() (Config method)
path (Config property)
plot_conservation() (KuramotoSivashinsky method)
plot_kymograph() (KuramotoSivashinsky method)
predict_single_step() (ReservoirComputer method)
print_percent_of_saved_frames() (progress_feedback static method)
printProgressBar() (progress_feedback static method)
process() (AnalyseClusterRunBase method)
(HyperPostProcessing method)
produce_animation() (visualization static method)
produce_series_of_snapshots() (visualization static method)
progress_feedback (class in drrc.tools.general_methods)
propagate_reservoir_state() (ReservoirComputer method)
R
reservoir_transient() (ParallelReservoirsBase method)
ReservoirComputer (class in drrc.reservoircomputer)
S
save() (AnalyseClusterRunBase method)
(HyperPostProcessing method)
(KuramotoSivashinsky method)
(ParallelReservoirsBase method)
set_figure_index() (in module drrc.tools.plot_config)
set_plot_style() (in module drrc.tools.plot_config)
summary() (AutomaticPostprocessing method)
T
train() (ParallelReservoirsBase method)
(ReservoirComputer method)
train_on_multiple_datasets() (ReservoirComputer method)
V
visualization (class in drrc.tools.visualization)
W
write_metadata_HDF() (Config method)