studpy 0.5.4__tar.gz → 0.5.6__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {studpy-0.5.4 → studpy-0.5.6}/PKG-INFO +1 -1
- {studpy-0.5.4 → studpy-0.5.6}/README.md +10 -1
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/10440334042371544726 +1 -1
- studpy-0.5.6/docs/.cache/10450421714888733546 +1 -0
- studpy-0.5.6/docs/.cache/11416029251644926645 +1 -0
- studpy-0.5.6/docs/.cache/11489429464240129383 +1 -0
- studpy-0.5.6/docs/.cache/11792514947601496843 +1 -0
- studpy-0.5.6/docs/.cache/1183586995044264848 +1 -0
- studpy-0.5.6/docs/.cache/11995640519999250966 +1 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/12315245384958044900 +1 -1
- studpy-0.5.6/docs/.cache/12689754196300952681 +1 -0
- studpy-0.5.6/docs/.cache/12748013961559743443 +1 -0
- studpy-0.5.6/docs/.cache/12779242267087665917 +1 -0
- studpy-0.5.6/docs/.cache/13387495034338757884 +1 -0
- studpy-0.5.6/docs/.cache/14075396793549163709 +1 -0
- studpy-0.5.6/docs/.cache/14439113695162943756 +1 -0
- studpy-0.5.6/docs/.cache/14791180290639909936 +1 -0
- studpy-0.5.6/docs/.cache/15165088998828831295 +1 -0
- studpy-0.5.6/docs/.cache/15207151427907910612 +1 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/15435112720243442645 +1 -1
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/15708793647317840429 +1 -1
- studpy-0.5.6/docs/.cache/16238694768030385479 +1 -0
- studpy-0.5.6/docs/.cache/16306262686086729811 +1 -0
- studpy-0.5.6/docs/.cache/16311618007809597249 +1 -0
- studpy-0.5.6/docs/.cache/16406420537681484501 +1 -0
- studpy-0.5.6/docs/.cache/16500387819492867696 +1 -0
- studpy-0.5.6/docs/.cache/16559974269243301644 +1 -0
- studpy-0.5.6/docs/.cache/16776236318889977301 +1 -0
- studpy-0.5.6/docs/.cache/1732166332310728737 +1 -0
- studpy-0.5.6/docs/.cache/17451784970925268089 +1 -0
- studpy-0.5.6/docs/.cache/17559734116529924498 +1 -0
- studpy-0.5.6/docs/.cache/17937867438617690887 +1 -0
- studpy-0.5.6/docs/.cache/1809002168669670119 +1 -0
- studpy-0.5.6/docs/.cache/18418292597904469700 +1 -0
- studpy-0.5.6/docs/.cache/2776536709976023163 +1 -0
- studpy-0.5.6/docs/.cache/3510474247905761739 +1 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/3541202890535126406 +1 -1
- studpy-0.5.6/docs/.cache/4053008418746218077 +1 -0
- studpy-0.5.6/docs/.cache/4371669200151672470 +1 -0
- studpy-0.5.6/docs/.cache/4659137580020018790 +1 -0
- studpy-0.5.6/docs/.cache/5425051190048379052 +1 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/5442029056690001212 +1 -1
- studpy-0.5.6/docs/.cache/5746805504933263125 +1 -0
- studpy-0.5.6/docs/.cache/5962113476580536672 +1 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/6651262319416851290 +1 -1
- studpy-0.5.6/docs/.cache/6827513434514690935 +1 -0
- studpy-0.5.6/docs/.cache/7407377899490230065 +1 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/7746505677481989602 +1 -1
- studpy-0.5.6/docs/.cache/8188774958613721473 +1 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/9424055347302266368 +1 -1
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/autorefs.json +10987 -10987
- studpy-0.5.6/docs/docs/documentation/get-started/starter-example-report-2.png +0 -0
- studpy-0.5.6/docs/docs/documentation/get-started/starter-example-tool-1.png +0 -0
- studpy-0.5.6/docs/docs/documentation/get-started/starter-example.md +365 -0
- studpy-0.5.6/docs/docs/documentation/key-concepts/input_target.md +44 -0
- studpy-0.5.6/docs/docs/documentation/key-concepts/input_target_case_1.png +0 -0
- studpy-0.5.6/docs/docs/documentation/key-concepts/input_target_case_2.png +0 -0
- studpy-0.5.6/docs/docs/documentation/key-concepts/input_target_case_3.png +0 -0
- studpy-0.5.6/docs/docs/documentation/key-concepts/input_target_case_4.png +0 -0
- studpy-0.5.6/docs/docs/documentation/key-concepts/input_target_case_5.png +0 -0
- studpy-0.5.6/docs/docs/documentation/key-concepts/input_target_overview_1.png +0 -0
- studpy-0.5.6/docs/docs/documentation/key-concepts/input_target_target_1.png +0 -0
- studpy-0.5.4/docs/docs/documentation/__Key-Concepts/01-overview.md → studpy-0.5.6/docs/docs/documentation/key-concepts/overview.md +3 -3
- studpy-0.5.6/docs/docs/documentation/key-concepts/overview_objects_6.png +0 -0
- studpy-0.5.6/docs/docs/documentation/key-concepts/param_config_linear_start_1.png +0 -0
- studpy-0.5.4/docs/docs/documentation/__Key-Concepts/04-sim_runner.md → studpy-0.5.6/docs/docs/documentation/key-concepts/sim_runner.md +2 -2
- studpy-0.5.6/docs/docs/documentation/key-concepts/source_target.md +11 -0
- studpy-0.5.4/docs/docs/documentation/__Key-Concepts/04-study.md → studpy-0.5.6/docs/docs/documentation/key-concepts/study.md +4 -0
- studpy-0.5.6/docs/docs/documentation/key-concepts/study_runner.md +11 -0
- studpy-0.5.6/docs/zensical.toml +70 -0
- {studpy-0.5.4 → studpy-0.5.6}/pyproject.toml +1 -1
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/__init__.py +1 -1
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param.py +2 -2
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/__init__.py +2 -1
- studpy-0.5.6/src/studpy/cases/param_configs/linear_span_config.py +32 -0
- studpy-0.5.6/src/studpy/cases/param_configs/linear_start.py +29 -0
- studpy-0.5.6/src/studpy/report/models.py +11 -0
- studpy-0.5.6/src/studpy/report/report.css +67 -0
- studpy-0.5.6/src/studpy/report/report.js +284 -0
- studpy-0.5.6/src/studpy/report/report.py +55 -0
- studpy-0.5.6/src/studpy/report/report_head.js +8 -0
- studpy-0.5.6/src/studpy/report/utils.py +6 -0
- studpy-0.5.6/src/studpy/runtime/models/__init__.py +5 -0
- studpy-0.5.6/src/studpy/runtime/models/file_tracker.py +9 -0
- studpy-0.5.6/src/studpy/runtime/models/run_state.py +23 -0
- studpy-0.5.6/src/studpy/runtime/models/simulation_run_state.py +2 -0
- studpy-0.5.6/src/studpy/runtime/models/study_run_state.py +6 -0
- studpy-0.5.4/src/studpy/runtime/models/time_track.py → studpy-0.5.6/src/studpy/runtime/models/time_tracker.py +1 -1
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/runtime/sim_runner.py +13 -15
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/runtime/sim_runner_engine.py +6 -2
- studpy-0.5.6/src/studpy/runtime/sim_runner_file_workspace.py +17 -0
- studpy-0.5.6/src/studpy/runtime/study_parallel_runner.py +42 -0
- studpy-0.5.6/src/studpy/runtime/study_report.py +9 -0
- studpy-0.5.6/src/studpy/runtime/study_report_config.py +4 -0
- studpy-0.5.6/src/studpy/runtime/study_runner.py +28 -0
- studpy-0.5.6/src/studpy/runtime/study_sequential_runner.py +19 -0
- studpy-0.5.6/src/studpy/runtime/utils.py +2 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/study.py +1 -1
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/study_run_filestore.py +1 -1
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/class_load.py +3 -2
- studpy-0.5.6/src/studpy/utils/file_stats.py +6 -0
- studpy-0.5.6/tests/test_10_cases_param_configs/test_22_param_linear_start.py +57 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_30_case_builder/test_10_case_builder_except.py +8 -8
- studpy-0.5.4/docs/.cache/10120058703495413635 +0 -1
- studpy-0.5.4/docs/.cache/10450421714888733546 +0 -1
- studpy-0.5.4/docs/.cache/10501867902726615992 +0 -1
- studpy-0.5.4/docs/.cache/11416029251644926645 +0 -1
- studpy-0.5.4/docs/.cache/11489429464240129383 +0 -1
- studpy-0.5.4/docs/.cache/12779242267087665917 +0 -1
- studpy-0.5.4/docs/.cache/13933668085211369552 +0 -1
- studpy-0.5.4/docs/.cache/14457269576597410790 +0 -1
- studpy-0.5.4/docs/.cache/14791180290639909936 +0 -1
- studpy-0.5.4/docs/.cache/15737098405526994950 +0 -1
- studpy-0.5.4/docs/.cache/16311618007809597249 +0 -1
- studpy-0.5.4/docs/.cache/16406420537681484501 +0 -1
- studpy-0.5.4/docs/.cache/16500387819492867696 +0 -1
- studpy-0.5.4/docs/.cache/1732166332310728737 +0 -1
- studpy-0.5.4/docs/.cache/17451784970925268089 +0 -1
- studpy-0.5.4/docs/.cache/1809002168669670119 +0 -1
- studpy-0.5.4/docs/.cache/1972624678796423847 +0 -1
- studpy-0.5.4/docs/.cache/2364165715076704139 +0 -1
- studpy-0.5.4/docs/.cache/2499279330732599812 +0 -1
- studpy-0.5.4/docs/.cache/3510474247905761739 +0 -1
- studpy-0.5.4/docs/.cache/4371669200151672470 +0 -1
- studpy-0.5.4/docs/.cache/4465813520685555786 +0 -1
- studpy-0.5.4/docs/.cache/4563315176155559468 +0 -1
- studpy-0.5.4/docs/.cache/5167637570810249119 +0 -1
- studpy-0.5.4/docs/.cache/5469674853214792527 +0 -1
- studpy-0.5.4/docs/.cache/6827513434514690935 +0 -1
- studpy-0.5.4/docs/.cache/6895961101567862719 +0 -1
- studpy-0.5.4/docs/.cache/7150296321399982445 +0 -1
- studpy-0.5.4/docs/.cache/8188774958613721473 +0 -1
- studpy-0.5.4/docs/.cache/8590914185171562985 +0 -1
- studpy-0.5.4/docs/.cache/9163793954965876825 +0 -1
- studpy-0.5.4/docs/.cache/9280534032297586767 +0 -1
- studpy-0.5.4/docs/.cache/9582269429869240455 +0 -1
- studpy-0.5.4/docs/docs/documentation/_Get-Started/02-starter-example.md +0 -349
- studpy-0.5.4/docs/docs/documentation/__Key-Concepts/01-overview_objects_4.png +0 -0
- studpy-0.5.4/docs/zensical.toml +0 -44
- studpy-0.5.4/src/studpy/cases/param_configs/linear_span_config.py +0 -31
- studpy-0.5.4/src/studpy/runtime/models/__init__.py +0 -5
- studpy-0.5.4/src/studpy/runtime/models/executor_state.py +0 -10
- studpy-0.5.4/src/studpy/runtime/models/runner_exec_state.py +0 -7
- studpy-0.5.4/src/studpy/runtime/sim_runner_file_workspace.py +0 -17
- studpy-0.5.4/src/studpy/runtime/study_local_parallel_executor copy.py +0 -20
- studpy-0.5.4/src/studpy/runtime/study_seq_executor.py +0 -37
- studpy-0.5.4/tests/.test_90_batch/test_01_batch.py +0 -28
- studpy-0.5.4/tests/.test_90_batch/test_02_batch_errors.py +0 -70
- studpy-0.5.4/tests/.test_90_batch/test_03_batch_log_files.py +0 -48
- studpy-0.5.4/tests/.test_90_batch/test_10_batch_study.py +0 -76
- studpy-0.5.4/tests/.test_91_study_batch_file/test_01_study_batch_file.py +0 -46
- studpy-0.5.4/tests/test_80_study/__init__.py +0 -0
- studpy-0.5.4/tests/test_80_study/simulation_1_cfg_templates/simulation.json +0 -6
- {studpy-0.5.4 → studpy-0.5.6}/.coveragerc +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/.forgejo/workflows/release.yaml +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/.gitignore +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/.gitignore +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/.cache/objects.inv +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/assets/extra.css +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/assets/logo.png +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/assets/logo.svg +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/assets/logo_white.svg +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/batch/BatchExecCmdIter.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/case_builder/CopyConfig.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/case_builder/GaussianConfig.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/case_builder/LHSConfig.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/case_builder/LinearConfig.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/case_builder/ListConfig.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/case_builder/OATConfig.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/case_builder/RandomIntConfig.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/case_builder/TableConfig.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/files_builder/FilesBuilder.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/documentation/api/study/Study.md +0 -0
- {studpy-0.5.4/docs/docs/documentation/_Get-Started → studpy-0.5.6/docs/docs/documentation/get-started}/03-tmp-input-example.tom.md +0 -0
- /studpy-0.5.4/docs/docs/documentation/_Get-Started/01-installation.md → /studpy-0.5.6/docs/docs/documentation/get-started/installation.md +0 -0
- /studpy-0.5.4/docs/docs/documentation/_Get-Started/99-license.md → /studpy-0.5.6/docs/docs/documentation/get-started/license.md +0 -0
- /studpy-0.5.4/docs/docs/documentation/__Key-Concepts/02-case_builder.md → /studpy-0.5.6/docs/docs/documentation/key-concepts/case_builder.md +0 -0
- /studpy-0.5.4/docs/docs/documentation/__Key-Concepts/03-file_builder.md → /studpy-0.5.6/docs/docs/documentation/key-concepts/file_builder.md +0 -0
- /studpy-0.5.4/docs/docs/documentation/__Key-Concepts/01-overview_scope_1_1.png → /studpy-0.5.6/docs/docs/documentation/key-concepts/overview_scope_1_1.png +0 -0
- /studpy-0.5.4/docs/docs/documentation/__Key-Concepts/01-overview_scope_2_2.png → /studpy-0.5.6/docs/docs/documentation/key-concepts/overview_scope_2_2.png +0 -0
- /studpy-0.5.4/docs/docs/documentation/__Key-Concepts/04-sim_runner_2.png → /studpy-0.5.6/docs/docs/documentation/key-concepts/sim_runner_2.png +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/index.md +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/docs/stylesheets/extra.css +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/overrides/partials/header.html +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/docs/script.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/batch/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/batch/batch_exec_cmd_iter.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/batch/run_command_context.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/batch/run_executable.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/batch/run_filestore.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/batch/validated_batch.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/case_builder.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/case_builder_load_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/case_builder_mutate.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/lsh_build_cases.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/one_at_time_sampling.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/constants.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/copy_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/gaussian_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/lhs_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/linear_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/list_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/oat_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/param_config_base.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/random_int_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_configs/table_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/param_target.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/reference_configs/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/reference_configs/latin_hypercube_sampling_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/reference_configs/one_at_time_sampling_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/target/target_spec.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/cases/target/target_spec_parser.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/constants.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/file_processor.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/files_builder.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/files_builder_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/formats/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/formats/format_abstract_pydantic.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/formats/json.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/formats/models/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/formats/models/format_element.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/formats/models/search_found_item.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/formats/txt_kv.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/formats/xml.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/formats/yaml.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/input_element.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/models/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/inputs/models/param_target.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/outputs/__init__.py +0 -0
- {studpy-0.5.4/tests/.test_90_batch → studpy-0.5.6/src/studpy/report}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/runtime/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/runtime/models/sim_runner_exec_config.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/runtime/models/sim_runner_exec_context.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/study_batch_file.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/study_batch_post_and_end.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/config_file.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/dict.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/folder.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/html.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/logger_print.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/pydantic.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/time.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/txt.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/src/studpy/utils/xml.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/.test_82_batch_val.py +0 -0
- {studpy-0.5.4/tests/.test_91_study_batch_file → studpy-0.5.6/tests}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/conftest.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/dev.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/examples/starter_example_1.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/examples/starter_example_2.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/template/INI/init_mod.tmp +0 -0
- {studpy-0.5.4/tests → studpy-0.5.6/tests/test_00__uti}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_00__uti/test_00_uti_logger_print.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_00__uti/test_01_uti_dict.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_00__uti/test_02_uti_folder.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_00__uti/test_10_config_file.py +0 -0
- {studpy-0.5.4/tests/test_00__uti → studpy-0.5.6/tests/test_10_cases_param_configs}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_10_cases_param_configs/test_10_param_list.py +0 -0
- /studpy-0.5.4/tests/test_10_cases_param_configs/test_11_param_linear.py → /studpy-0.5.6/tests/test_10_cases_param_configs/test_20_param_linear.py +0 -0
- /studpy-0.5.4/tests/test_10_cases_param_configs/test_12_param_linear_span.py → /studpy-0.5.6/tests/test_10_cases_param_configs/test_21_param_linear_span.py +0 -0
- /studpy-0.5.4/tests/test_10_cases_param_configs/test_14_param_gaussian.py → /studpy-0.5.6/tests/test_10_cases_param_configs/test_30_param_gaussian.py +0 -0
- /studpy-0.5.4/tests/test_10_cases_param_configs/test_13_param_random.py → /studpy-0.5.6/tests/test_10_cases_param_configs/test_40_param_random.py +0 -0
- {studpy-0.5.4/tests/test_10_cases_param_configs → studpy-0.5.6/tests/test_11_cases_param}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_11_cases_param/test_01_param_exceptions.py +0 -0
- {studpy-0.5.4/tests/test_11_cases_param → studpy-0.5.6/tests/test_20_cases_param_references}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_20_cases_param_references/test_21_params_table.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_20_cases_param_references/test_22_params_lhs.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_20_cases_param_references/test_23_params_oat.py +0 -0
- {studpy-0.5.4/tests/test_20_cases_param_references → studpy-0.5.6/tests/test_21_cases_target}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_21_cases_target/test_21_params_table.py +0 -0
- {studpy-0.5.4/tests/test_21_cases_target → studpy-0.5.6/tests/test_30_case_builder}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_30_case_builder/test_00_case_builder_empty.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_30_case_builder/test_01_case_builder_count.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_30_case_builder/test_02_case_builder_cols.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_30_case_builder/test_04_case_builder_cast.py +0 -0
- {studpy-0.5.4/tests/test_30_case_builder → studpy-0.5.6/tests/test_31_case_builder_load_save}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_31_case_builder_load_save/store/case_builder.json +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_31_case_builder_load_save/store/table.values.csv +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_31_case_builder_load_save/store_2/case_builder.yaml +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_31_case_builder_load_save/store_2/table.values.csv +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_31_case_builder_load_save/test_10_case_builder_load.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_31_case_builder_load_save/test_20_case_builder_store.py +0 -0
- {studpy-0.5.4/tests/test_31_case_builder_load_save → studpy-0.5.6/tests/test_40_case_builder_mutate}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_40_case_builder_mutate/test_01_case_builder_mutate_param.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_40_case_builder_mutate/test_02_case_builder_mutate_ref.py +0 -0
- {studpy-0.5.4/tests/test_40_case_builder_mutate → studpy-0.5.6/tests/test_50_formats}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_50_formats/test.xml +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_50_formats/test_50_inputs_format_json.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_50_formats/test_51_inputs_format_json_discover.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_50_formats/test_52_inputs_format_yaml.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_50_formats/test_53_inputs_format_yaml_discover.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_50_formats/test_54_inputs_format_xml.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_50_formats/test_55_inputs_format_xml_discover.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_50_formats/test_56_inputs_format_txt_kv.py +0 -0
- {studpy-0.5.4/tests/test_50_formats → studpy-0.5.6/tests/test_60_files_builder}/__init__.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_60_files_builder/config_files_json/simulation.json +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_60_files_builder/config_files_xml/test.xml +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_60_files_builder/test_01_inputs_files_builder.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_60_files_builder/test_02_inputs_files_builder_multi_proc.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_60_files_builder/test_03_inputs_files_builder_discover.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_60_files_builder/test_04_inputs_file_yaml.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_60_files_builder/test_05_inputs_file_json.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_60_files_builder/test_10_inputs_file_txt_kv.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_60_files_builder/test_11_inputs_file_txt_kv_search.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_70/test_01.py +0 -0
- {studpy-0.5.4/tests/test_60_files_builder → studpy-0.5.6/tests/test_80_study}/__init__.py +0 -0
- {studpy-0.5.4/tests/.test_90_batch → studpy-0.5.6/tests/test_80_study}/simulation_1_cfg_templates/simulation.json +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_80_study/test_02_study_filestore.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_80_study/test_10_study.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_80_study/test_11_study_case_save.py +0 -0
- {studpy-0.5.4 → studpy-0.5.6}/tests/test_80_study/test_20_study_source.py +0 -0
|
@@ -43,9 +43,18 @@ mypy
|
|
|
43
43
|
### Documentations
|
|
44
44
|
|
|
45
45
|
```bash
|
|
46
|
-
zensical serve -f docs/zensical.toml
|
|
46
|
+
zensical serve -f docs/zensical.toml -a localhost:9999
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
+
or
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
zensical serve -f docs/zensical.toml -a 0.0.0.0:9999
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
go to http://localhost:9999
|
|
57
|
+
|
|
49
58
|
|
|
50
59
|
|
|
51
60
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"data":{"route":{"source":"documentation/api/case_builder/LinearConfig.md","destination":"documentation/api/case_builder/LinearConfig/index.html","url":"documentation/api/case_builder/LinearConfig/"},"markdown":{"meta":{"icon":"lucide/cog"},"content":"<h1 id=\"linearconfig\">LinearConfig<a class=\"headerlink\" href=\"#linearconfig\" title=\"Permanent link\">¶</a></h1>\n\n\n<div class=\"doc doc-object doc-class\">\n\n\n\n<a id=\"studpy.cases.LinearConfig\"></a>\n <div class=\"doc doc-contents first\">\n <p class=\"doc doc-class-bases\">\n Bases: <code><!-- zensical:autoref:0 --></code></p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-children\">\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.LinearConfig.check_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">check_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.LinearConfig.check_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>if config has <strong>SOURCE</strong> in attributes, raise ValueError</p>\n\n\n </div>\n\n</div>\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.LinearConfig.need_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">need_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.LinearConfig.need_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>config has <strong>SOURCE</strong> in attributes</p>\n\n\n </div>\n\n</div>\n\n\n\n </div>\n\n </div>\n\n</div>","toc":[{"title":"LinearConfig","content":"LinearConfig","id":"linearconfig","url":"#linearconfig","children":[{"title":"LinearConfig","content":"LinearConfig","id":"studpy.cases.LinearConfig","url":"#studpy.cases.LinearConfig","children":[],"level":2},{"title":"check_target_source","content":"check_target_source","id":"studpy.cases.LinearConfig.check_target_source","url":"#studpy.cases.LinearConfig.check_target_source","children":[],"level":2},{"title":"need_target_source","content":"need_target_source","id":"studpy.cases.LinearConfig.need_target_source","url":"#studpy.cases.LinearConfig.need_target_source","children":[],"level":2}],"level":1}]},"title":"LinearConfig","registrations":{"primary":{"studpy.cases.LinearConfig.
|
|
1
|
+
{"data":{"route":{"source":"documentation/api/case_builder/LinearConfig.md","destination":"documentation/api/case_builder/LinearConfig/index.html","url":"documentation/api/case_builder/LinearConfig/"},"markdown":{"meta":{"icon":"lucide/cog"},"content":"<h1 id=\"linearconfig\">LinearConfig<a class=\"headerlink\" href=\"#linearconfig\" title=\"Permanent link\">¶</a></h1>\n\n\n<div class=\"doc doc-object doc-class\">\n\n\n\n<a id=\"studpy.cases.LinearConfig\"></a>\n <div class=\"doc doc-contents first\">\n <p class=\"doc doc-class-bases\">\n Bases: <code><!-- zensical:autoref:0 --></code></p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-children\">\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.LinearConfig.check_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">check_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.LinearConfig.check_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>if config has <strong>SOURCE</strong> in attributes, raise ValueError</p>\n\n\n </div>\n\n</div>\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.LinearConfig.need_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">need_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.LinearConfig.need_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>config has <strong>SOURCE</strong> in attributes</p>\n\n\n </div>\n\n</div>\n\n\n\n </div>\n\n </div>\n\n</div>","toc":[{"title":"LinearConfig","content":"LinearConfig","id":"linearconfig","url":"#linearconfig","children":[{"title":"LinearConfig","content":"LinearConfig","id":"studpy.cases.LinearConfig","url":"#studpy.cases.LinearConfig","children":[],"level":2},{"title":"check_target_source","content":"check_target_source","id":"studpy.cases.LinearConfig.check_target_source","url":"#studpy.cases.LinearConfig.check_target_source","children":[],"level":2},{"title":"need_target_source","content":"need_target_source","id":"studpy.cases.LinearConfig.need_target_source","url":"#studpy.cases.LinearConfig.need_target_source","children":[],"level":2}],"level":1}]},"title":"LinearConfig","registrations":{"primary":{"studpy.cases.LinearConfig.check_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.check_target_source"],"studpy.cases.LinearConfig":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig"],"studpy.cases.LinearConfig.need_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.need_target_source"],"linearconfig":["documentation/api/case_builder/LinearConfig/#linearconfig"]},"secondary":{"studpy.cases.param_configs.random_int_config.RandomIntConfig.need_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.need_target_source"],"studpy.cases.param_configs.linear_config.LinearConfig":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig"],"studpy.cases.param_configs.gaussian_config.GaussianConfig.need_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.need_target_source"],"studpy.cases.RandomIntConfig.check_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.check_target_source"],"studpy.cases.TableConfig.check_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.check_target_source"],"studpy.cases.GaussianConfig.check_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.check_target_source"],"studpy.cases.param_configs.table_config.TableConfig.need_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.need_target_source"],"studpy.cases.RandomIntConfig.need_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.need_target_source"],"studpy.cases.TableConfig.need_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.need_target_source"],"studpy.cases.param_configs.linear_config.LinearConfig.check_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.check_target_source"],"studpy.cases.GaussianConfig.need_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.need_target_source"],"studpy.cases.param_configs.random_int_config.RandomIntConfig.check_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.check_target_source"],"studpy.cases.param_configs.param_config_base.ParamConfigBase.need_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.need_target_source"],"studpy.cases.param_configs.table_config.TableConfig.check_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.check_target_source"],"studpy.cases.param_configs.linear_config.LinearConfig.need_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.need_target_source"],"studpy.cases.param_configs.gaussian_config.GaussianConfig.check_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.check_target_source"],"studpy.cases.param_configs.param_config_base.ParamConfigBase.check_target_source":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.check_target_source"],"studpy.cases.param_configs.LinearConfig":["documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig"]},"titles":{"documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.check_target_source":"<code class=\"highlight language-python\"><span class=\"n\">check_target_source</span><span class=\"p\">()</span></code>","documentation/api/case_builder/LinearConfig/#linearconfig":"LinearConfig","documentation/api/case_builder/LinearConfig/#studpy.cases.LinearConfig.need_target_source":"<code class=\"highlight language-python\"><span class=\"n\">need_target_source</span><span class=\"p\">()</span></code>"}},"html":{"autorefs":{"references":[{"attributes":[{"name":"identifier","value":"studpy.cases.param_configs.param_config_base.ParamConfigBase"},{"name":"backlink-type","value":"subclassed-by"},{"name":"backlink-anchor","value":"studpy.cases.LinearConfig"},{"name":"optional","value":""},{"name":"hover","value":""}],"title":"ParamConfigBase"}]},"search":{"sections":[{"location":null,"level":1,"title":"LinearConfig","text":"<p> Bases: <code>ParamConfigBase</code></p>"},{"location":"studpy.cases.LinearConfig.check_target_source","level":2,"title":"<code>check_target_source()</code>","text":"<p>if config has SOURCE in attributes, raise ValueError</p>"},{"location":"studpy.cases.LinearConfig.need_target_source","level":2,"title":"<code>need_target_source()</code>","text":"<p>config has SOURCE in attributes</p>"}]},"tags":{"mappings":[],"listings":[],"search_cleanup":false}}},"hash":9501432942665537522}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"data":"\n<!doctype html>\n<html lang=\"en\" class=\"no-js\">\n <head>\n \n <meta charset=\"utf-8\">\n <meta name=\"viewport\" content=\"width=device-width,initial-scale=1\">\n \n \n <meta name=\"author\" content=\"PinkSalmon\">\n \n \n \n \n <link rel=\"next\" href=\"./documentation/get-started/installation/\">\n \n \n \n \n \n <link rel=\"icon\" href=\"./assets/images/favicon.png\">\n <meta name=\"generator\" content=\"zensical-0.0.62\">\n \n \n \n <title>StudPy - StudPy</title>\n \n \n \n \n \n \n <link rel=\"stylesheet\" href=\"./assets/stylesheets/modern/main.ce62732f.min.css\">\n \n \n\n\n \n \n \n \n \n \n \n \n <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin>\n <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,500,500i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback\">\n <style>:root{--md-text-font:\"Inter\";--md-code-font:\"JetBrains Mono\"}</style>\n \n \n \n <link rel=\"stylesheet\" href=\"./stylesheets/extra.css\">\n \n <script>__md_scope=new URL(\".\",location),__md_scope.pathname.endsWith(\"/\")||(__md_scope=new URL(__md_scope.pathname+\"/\",location)),__md_hash=e=>[...e].reduce(((e,t)=>(e<<5)-e+t.charCodeAt(0)),0),__md_get=(e,t=localStorage,_=__md_scope)=>JSON.parse(t.getItem(_.pathname+\".\"+e)),__md_set=(e,t,_=localStorage,a=__md_scope)=>{try{_.setItem(a.pathname+\".\"+e,JSON.stringify(t))}catch(e){}},document.documentElement.setAttribute(\"data-platform\",navigator.platform)</script>\n \n \n\n \n \n </head>\n \n \n <body dir=\"ltr\">\n \n \n <input class=\"md-toggle\" data-md-toggle=\"drawer\" type=\"checkbox\" id=\"__drawer\" autocomplete=\"off\">\n <input class=\"md-toggle\" data-md-toggle=\"search\" type=\"checkbox\" id=\"__search\" autocomplete=\"off\">\n <label class=\"md-overlay\" for=\"__drawer\" aria-label=\"Navigation\"></label>\n <div data-md-component=\"skip\">\n \n \n <a href=\"#studpy-the-framework-for-scientific-studies\" class=\"md-skip\">\n Skip to content\n </a>\n \n </div>\n <div data-md-component=\"announce\">\n \n </div>\n \n <div data-md-color-scheme=\"default\" data-md-component=\"outdated\" hidden>\n \n </div>\n \n \n \n\n<header class=\"md-header\" data-md-component=\"header\">\n <nav class=\"md-header__inner md-grid\" aria-label=\"Header\">\n <a href=\"\" title=\"StudPy\" class=\"md-header__button md-logo\" aria-label=\"StudPy\" data-md-component=\"logo\">\n \n <img src=\"./assets/logo.svg\" alt=\"StudPy\">\n\n </a>\n <label class=\"md-header__button md-icon\" for=\"__drawer\" aria-label=\"Navigation\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-menu\" viewBox=\"0 0 24 24\"><path d=\"M4 5h16M4 12h16M4 19h16\"/></svg>\n </label>\n <div class=\"md-header__title\" data-md-component=\"header-title\">\n <div class=\"md-header__ellipsis\">\n <div class=\"md-header__topic\">\n <span class=\"md-ellipsis\">\n StudPy\n <span style=\"background: var(--md-accent-fg-color--transparent); color: var(--md-accent-fg-color); padding: 2px 4px; margin:4px; border-radius: 4px; font-size: 0.6em;\">\n v0.5.6\n </span>\n </span>\n </div>\n <div class=\"md-header__topic\" data-md-component=\"header-topic\">\n <span class=\"md-ellipsis\">\n \n StudPy\n \n </span>\n </div>\n </div>\n </div>\n \n \n <script>var palette=__md_get(\"__palette\");if(palette&&palette.color){if(\"(prefers-color-scheme)\"===palette.color.media){var media=matchMedia(\"(prefers-color-scheme: light)\"),input=document.querySelector(media.matches?\"[data-md-color-media='(prefers-color-scheme: light)']\":\"[data-md-color-media='(prefers-color-scheme: dark)']\");palette.color.media=input.getAttribute(\"data-md-color-media\"),palette.color.scheme=input.getAttribute(\"data-md-color-scheme\"),palette.color.primary=input.getAttribute(\"data-md-color-primary\"),palette.color.accent=input.getAttribute(\"data-md-color-accent\")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute(\"data-md-color-\"+key,value)}</script>\n \n \n \n \n \n <label class=\"md-header__button md-icon\" for=\"__search\" aria-label=\"Search\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-search\" viewBox=\"0 0 24 24\"><path d=\"m21 21-4.34-4.34\"/><circle cx=\"11\" cy=\"11\" r=\"8\"/></svg>\n </label>\n <div class=\"md-search\" data-md-component=\"search\" role=\"dialog\" aria-label=\"Search\">\n <button type=\"button\" class=\"md-search__button\">\n Search\n </button>\n</div>\n \n \n <div class=\"md-header__source\">\n \n </div>\n </nav>\n \n</header>\n \n <div class=\"md-container\" data-md-component=\"container\">\n \n \n \n \n \n<nav class=\"md-tabs\" aria-label=\"Tabs\" data-md-component=\"tabs\">\n <div class=\"md-grid\">\n <ul class=\"md-tabs__list\">\n \n \n \n \n \n \n \n \n <li class=\"md-tabs__item md-tabs__item--active\">\n <a href=\"\" class=\"md-tabs__link\">\n \n \n Home\n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-tabs__item\">\n <a href=\"./documentation/get-started/installation/\" class=\"md-tabs__link\">\n \n \n Documentations\n\n </a>\n </li>\n \n \n\n \n \n\n \n </ul>\n </div>\n</nav>\n \n \n \n <main class=\"md-main\" data-md-component=\"main\">\n <div class=\"md-main__inner md-grid\">\n \n \n \n <div class=\"md-sidebar md-sidebar--primary\" data-md-component=\"sidebar\" data-md-type=\"navigation\" >\n <div class=\"md-sidebar__scrollwrap\">\n <div class=\"md-sidebar__inner\">\n \n\n\n \n\n\n<nav class=\"md-nav md-nav--primary md-nav--lifted\" aria-label=\"Navigation\" data-md-level=\"0\">\n <label class=\"md-nav__title\" for=\"__drawer\">\n <a href=\"\" title=\"StudPy\" class=\"md-nav__button md-logo\" aria-label=\"StudPy\" data-md-component=\"logo\">\n \n <img src=\"./assets/logo.svg\" alt=\"StudPy\">\n\n </a>\n StudPy\n </label>\n \n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--active\">\n \n \n \n \n \n \n \n <a href=\"\" class=\"md-nav__link md-nav__link--active\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-braces\" viewBox=\"0 0 24 24\"><path d=\"M8 3H7a2 2 0 0 0-2 2v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5c0 1.1.9 2 2 2h1M16 21h1a2 2 0 0 0 2-2v-5c0-1.1.9-2 2-2a2 2 0 0 1-2-2V5a2 2 0 0 0-2-2h-1\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Home\n\n \n </span>\n \n \n\n </a>\n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2\" id=\"__nav_2_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Documentations\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_2_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Documentations\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_1\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_1\" id=\"__nav_2_1_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Get Started\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_1_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_1\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Get Started\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/get-started/installation/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-package-open\" viewBox=\"0 0 24 24\"><path d=\"M12 22v-9M15.17 2.21a1.67 1.67 0 0 1 1.63 0L21 4.57a1.93 1.93 0 0 1 0 3.36L8.82 14.79a1.66 1.66 0 0 1-1.64 0L3 12.43a1.93 1.93 0 0 1 0-3.36z\"/><path d=\"M20 13v3.87a2.06 2.06 0 0 1-1.11 1.83l-6 3.08a1.93 1.93 0 0 1-1.78 0l-6-3.08A2.06 2.06 0 0 1 4 16.87V13\"/><path d=\"M21 12.43a1.93 1.93 0 0 0 0-3.36L8.83 2.2a1.64 1.64 0 0 0-1.63 0L3 4.57a1.93 1.93 0 0 0 0 3.36l12.18 6.86a1.64 1.64 0 0 0 1.63 0z\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Installation\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/get-started/starter-example/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-file-box\" viewBox=\"0 0 24 24\"><path d=\"M14 2v5a1 1 0 0 0 1 1h5\"/><path d=\"M14.692 22H18a2 2 0 0 0 2-2V8a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 14 2H6a2 2 0 0 0-2 2v3.804\"/><path d=\"M2.264 13.752 7 16.5l4.737-2.748\"/><path d=\"M2.995 13.014A2 2 0 0 0 2 14.744v3.516a2 2 0 0 0 .996 1.73l3 1.74a2 2 0 0 0 2.008 0l3-1.74A2 2 0 0 0 12 18.26v-3.517a2 2 0 0 0-.995-1.73l-3-1.742a2 2 0 0 0-1.892-.064zM7 16.5V22\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Starter Example\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/get-started/license/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-scale\" viewBox=\"0 0 24 24\"><path d=\"M12 3v18M19 8l3 8a5 5 0 0 1-6 0zV7\"/><path d=\"M3 7h1a17 17 0 0 0 8-2 17 17 0 0 0 8 2h1M5 8l3 8a5 5 0 0 1-6 0zV7M7 21h10\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n License\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_2\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_2\" id=\"__nav_2_2_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Key Concepts\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_2_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Key Concepts\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/key-concepts/overview/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-info\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"M12 16v-4M12 8h.01\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Overview\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/key-concepts/sim_runner/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-settings\" viewBox=\"0 0 24 24\"><path d=\"M9.671 4.136a2.34 2.34 0 0 1 4.659 0 2.34 2.34 0 0 0 3.319 1.915 2.34 2.34 0 0 1 2.33 4.033 2.34 2.34 0 0 0 0 3.831 2.34 2.34 0 0 1-2.33 4.033 2.34 2.34 0 0 0-3.319 1.915 2.34 2.34 0 0 1-4.659 0 2.34 2.34 0 0 0-3.32-1.915 2.34 2.34 0 0 1-2.33-4.033 2.34 2.34 0 0 0 0-3.831A2.34 2.34 0 0 1 6.35 6.051a2.34 2.34 0 0 0 3.319-1.915\"/><circle cx=\"12\" cy=\"12\" r=\"3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Simulation Runner\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/key-concepts/case_builder/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-clipboard-list\" viewBox=\"0 0 24 24\"><rect width=\"8\" height=\"4\" x=\"8\" y=\"2\" rx=\"1\" ry=\"1\"/><path d=\"M16 4h2a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h2M12 11h4M12 16h4M8 11h.01M8 16h.01\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Case Builder\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/key-concepts/file_builder/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-folder-tree\" viewBox=\"0 0 24 24\"><path d=\"M20 10a1 1 0 0 0 1-1V6a1 1 0 0 0-1-1h-2.5a1 1 0 0 1-.8-.4l-.9-1.2A1 1 0 0 0 15 3h-2a1 1 0 0 0-1 1v5a1 1 0 0 0 1 1ZM20 21a1 1 0 0 0 1-1v-3a1 1 0 0 0-1-1h-2.9a1 1 0 0 1-.88-.55l-.42-.85a1 1 0 0 0-.92-.6H13a1 1 0 0 0-1 1v5a1 1 0 0 0 1 1ZM3 5a2 2 0 0 0 2 2h3\"/><path d=\"M3 3v13a2 2 0 0 0 2 2h3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n File Builder\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/key-concepts/input_target/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-square-arrow-right-enter\" viewBox=\"0 0 24 24\"><path d=\"m10 16 4-4-4-4M3 12h11\"/><path d=\"M3 8V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Input Target\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/key-concepts/study/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-file-chart-column-increasing\" viewBox=\"0 0 24 24\"><path d=\"M6 22a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h8a2.4 2.4 0 0 1 1.704.706l3.588 3.588A2.4 2.4 0 0 1 20 8v12a2 2 0 0 1-2 2z\"/><path d=\"M14 2v5a1 1 0 0 0 1 1h5M8 18v-2M12 18v-4M16 18v-6\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Study\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/key-concepts/source_target/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-square-arrow-right-enter\" viewBox=\"0 0 24 24\"><path d=\"m10 16 4-4-4-4M3 12h11\"/><path d=\"M3 8V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Source Target\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/key-concepts/study_runner/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-square-arrow-right-enter\" viewBox=\"0 0 24 24\"><path d=\"m10 16 4-4-4-4M3 12h11\"/><path d=\"M3 8V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Study Runner\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_3\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_3\" id=\"__nav_2_3_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Api\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_3_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_3\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Api\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/key-concepts/01-overview.md\" class=\"md-nav__link\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Overview\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n </ul>\n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-sidebar md-sidebar--secondary\" data-md-component=\"sidebar\" data-md-type=\"toc\" >\n <div class=\"md-sidebar__scrollwrap\">\n \n \n \n \n \n \n \n \n <div class=\"md-sidebar__inner\">\n \n\n\n<nav class=\"md-nav md-nav--secondary\" aria-label=\"On this page\">\n \n \n \n \n \n \n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-content\" data-md-component=\"content\">\n \n \n\n\n\n \n\n\n \n <article class=\"md-content__inner md-typeset\">\n \n \n\n<h1 id=\"studpy-the-framework-for-scientific-studies\">StudPy - The framework for scientific studies<a class=\"headerlink\" href=\"#studpy-the-framework-for-scientific-studies\" title=\"Permanent link\">¶</a></h1>\n<p>Explore more. Compute faster.</p>\n<p><img alt=\"\" src=\"assets/logo.png\" /></p>\n\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n\n \n </article>\n </div>\n \n \n<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith(\"__tabbed_\"))</script>\n </div>\n \n <button type=\"button\" class=\"md-top md-icon\" data-md-component=\"top\" hidden>\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-circle-arrow-up\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"m16 12-4-4-4 4M12 16V8\"/></svg>\n Back to top\n</button>\n \n </main>\n \n <footer class=\"md-footer\">\n \n <div class=\"md-footer-meta md-typeset\">\n <div class=\"md-footer-meta__inner md-grid\">\n <div class=\"md-copyright\">\n \n <div class=\"md-copyright__highlight\">\n Copyright © 2026 StudPy - A PinkSalmon Library\n </div>\n \n \n</div>\n \n </div>\n </div>\n</footer>\n \n </div>\n <div class=\"md-dialog\" data-md-component=\"dialog\">\n <div class=\"md-dialog__inner md-typeset\"></div>\n </div>\n \n \n \n \n \n \n \n \n \n <script id=\"__config\" type=\"application/json\">{\"annotate\":null,\"base\":\".\",\"features\":[\"navigation.tabs\",\"navigation.path\",\"navigation.expand\",\"navigation.top\",\"navigation.sections\",\"navigation.indexes\",\"content.code.copy\"],\"redirect\":null,\"search\":\"./assets/javascripts/workers/search.7d14d953.min.js\",\"tags\":null,\"translations\":{\"clipboard.copied\":\"Copied to clipboard\",\"clipboard.copy\":\"Copy to clipboard\",\"search.result.more.one\":\"1 more on this page\",\"search.result.more.other\":\"# more on this page\",\"search.result.none\":\"No matching documents\",\"search.result.one\":\"1 matching document\",\"search.result.other\":\"# matching documents\",\"search.result.placeholder\":\"Type to start searching\",\"search.result.term.missing\":\"Missing\",\"select.version\":\"Select version\"},\"version\":\"v0.5.6\"}</script>\n \n \n <script src=\"./assets/javascripts/bundle.8dcc8e9c.min.js\"></script>\n \n \n </body>\n</html>","hash":6947635388157597589}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"data":"\n<!doctype html>\n<html lang=\"en\" class=\"no-js\">\n <head>\n \n <meta charset=\"utf-8\">\n <meta name=\"viewport\" content=\"width=device-width,initial-scale=1\">\n \n \n <meta name=\"author\" content=\"PinkSalmon\">\n \n \n \n \n \n \n \n \n <link rel=\"icon\" href=\"../../../../assets/images/favicon.png\">\n <meta name=\"generator\" content=\"zensical-0.0.62\">\n \n \n \n <title>OATConfig - StudPy</title>\n \n \n \n \n \n \n <link rel=\"stylesheet\" href=\"../../../../assets/stylesheets/modern/main.ce62732f.min.css\">\n \n \n\n\n \n \n \n \n \n \n \n \n <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin>\n <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,500,500i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback\">\n <style>:root{--md-text-font:\"Inter\";--md-code-font:\"JetBrains Mono\"}</style>\n \n \n \n <link rel=\"stylesheet\" href=\"../../../../stylesheets/extra.css\">\n \n <script>__md_scope=new URL(\"../../../..\",location),__md_scope.pathname.endsWith(\"/\")||(__md_scope=new URL(__md_scope.pathname+\"/\",location)),__md_hash=e=>[...e].reduce(((e,t)=>(e<<5)-e+t.charCodeAt(0)),0),__md_get=(e,t=localStorage,_=__md_scope)=>JSON.parse(t.getItem(_.pathname+\".\"+e)),__md_set=(e,t,_=localStorage,a=__md_scope)=>{try{_.setItem(a.pathname+\".\"+e,JSON.stringify(t))}catch(e){}},document.documentElement.setAttribute(\"data-platform\",navigator.platform)</script>\n \n \n\n \n \n </head>\n \n \n <body dir=\"ltr\">\n \n \n <input class=\"md-toggle\" data-md-toggle=\"drawer\" type=\"checkbox\" id=\"__drawer\" autocomplete=\"off\">\n <input class=\"md-toggle\" data-md-toggle=\"search\" type=\"checkbox\" id=\"__search\" autocomplete=\"off\">\n <label class=\"md-overlay\" for=\"__drawer\" aria-label=\"Navigation\"></label>\n <div data-md-component=\"skip\">\n \n \n <a href=\"#oatconfig\" class=\"md-skip\">\n Skip to content\n </a>\n \n </div>\n <div data-md-component=\"announce\">\n \n </div>\n \n <div data-md-color-scheme=\"default\" data-md-component=\"outdated\" hidden>\n \n </div>\n \n \n \n\n<header class=\"md-header\" data-md-component=\"header\">\n <nav class=\"md-header__inner md-grid\" aria-label=\"Header\">\n <a href=\"../../../..\" title=\"StudPy\" class=\"md-header__button md-logo\" aria-label=\"StudPy\" data-md-component=\"logo\">\n \n <img src=\"../../../../assets/logo.svg\" alt=\"StudPy\">\n\n </a>\n <label class=\"md-header__button md-icon\" for=\"__drawer\" aria-label=\"Navigation\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-menu\" viewBox=\"0 0 24 24\"><path d=\"M4 5h16M4 12h16M4 19h16\"/></svg>\n </label>\n <div class=\"md-header__title\" data-md-component=\"header-title\">\n <div class=\"md-header__ellipsis\">\n <div class=\"md-header__topic\">\n <span class=\"md-ellipsis\">\n StudPy\n <span style=\"background: var(--md-accent-fg-color--transparent); color: var(--md-accent-fg-color); padding: 2px 4px; margin:4px; border-radius: 4px; font-size: 0.6em;\">\n v0.5.6\n </span>\n </span>\n </div>\n <div class=\"md-header__topic\" data-md-component=\"header-topic\">\n <span class=\"md-ellipsis\">\n \n OATConfig\n \n </span>\n </div>\n </div>\n </div>\n \n \n <script>var palette=__md_get(\"__palette\");if(palette&&palette.color){if(\"(prefers-color-scheme)\"===palette.color.media){var media=matchMedia(\"(prefers-color-scheme: light)\"),input=document.querySelector(media.matches?\"[data-md-color-media='(prefers-color-scheme: light)']\":\"[data-md-color-media='(prefers-color-scheme: dark)']\");palette.color.media=input.getAttribute(\"data-md-color-media\"),palette.color.scheme=input.getAttribute(\"data-md-color-scheme\"),palette.color.primary=input.getAttribute(\"data-md-color-primary\"),palette.color.accent=input.getAttribute(\"data-md-color-accent\")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute(\"data-md-color-\"+key,value)}</script>\n \n \n \n \n \n <label class=\"md-header__button md-icon\" for=\"__search\" aria-label=\"Search\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-search\" viewBox=\"0 0 24 24\"><path d=\"m21 21-4.34-4.34\"/><circle cx=\"11\" cy=\"11\" r=\"8\"/></svg>\n </label>\n <div class=\"md-search\" data-md-component=\"search\" role=\"dialog\" aria-label=\"Search\">\n <button type=\"button\" class=\"md-search__button\">\n Search\n </button>\n</div>\n \n \n <div class=\"md-header__source\">\n \n </div>\n </nav>\n \n</header>\n \n <div class=\"md-container\" data-md-component=\"container\">\n \n \n \n \n \n<nav class=\"md-tabs\" aria-label=\"Tabs\" data-md-component=\"tabs\">\n <div class=\"md-grid\">\n <ul class=\"md-tabs__list\">\n \n \n \n \n \n \n <li class=\"md-tabs__item\">\n <a href=\"../../../..\" class=\"md-tabs__link\">\n \n \n Home\n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-tabs__item\">\n <a href=\"../../../get-started/installation/\" class=\"md-tabs__link\">\n \n \n Documentations\n\n </a>\n </li>\n \n \n\n \n \n\n \n </ul>\n </div>\n</nav>\n \n \n \n <main class=\"md-main\" data-md-component=\"main\">\n <div class=\"md-main__inner md-grid\">\n \n \n \n <div class=\"md-sidebar md-sidebar--primary\" data-md-component=\"sidebar\" data-md-type=\"navigation\" >\n <div class=\"md-sidebar__scrollwrap\">\n <div class=\"md-sidebar__inner\">\n \n\n\n \n\n\n<nav class=\"md-nav md-nav--primary md-nav--lifted\" aria-label=\"Navigation\" data-md-level=\"0\">\n <label class=\"md-nav__title\" for=\"__drawer\">\n <a href=\"../../../..\" title=\"StudPy\" class=\"md-nav__button md-logo\" aria-label=\"StudPy\" data-md-component=\"logo\">\n \n <img src=\"../../../../assets/logo.svg\" alt=\"StudPy\">\n\n </a>\n StudPy\n </label>\n \n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../..\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-braces\" viewBox=\"0 0 24 24\"><path d=\"M8 3H7a2 2 0 0 0-2 2v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5c0 1.1.9 2 2 2h1M16 21h1a2 2 0 0 0 2-2v-5c0-1.1.9-2 2-2a2 2 0 0 1-2-2V5a2 2 0 0 0-2-2h-1\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Home\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2\" id=\"__nav_2_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Documentations\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_2_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Documentations\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_1\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_1\" id=\"__nav_2_1_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Get Started\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_1_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_1\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Get Started\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../get-started/installation/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-package-open\" viewBox=\"0 0 24 24\"><path d=\"M12 22v-9M15.17 2.21a1.67 1.67 0 0 1 1.63 0L21 4.57a1.93 1.93 0 0 1 0 3.36L8.82 14.79a1.66 1.66 0 0 1-1.64 0L3 12.43a1.93 1.93 0 0 1 0-3.36z\"/><path d=\"M20 13v3.87a2.06 2.06 0 0 1-1.11 1.83l-6 3.08a1.93 1.93 0 0 1-1.78 0l-6-3.08A2.06 2.06 0 0 1 4 16.87V13\"/><path d=\"M21 12.43a1.93 1.93 0 0 0 0-3.36L8.83 2.2a1.64 1.64 0 0 0-1.63 0L3 4.57a1.93 1.93 0 0 0 0 3.36l12.18 6.86a1.64 1.64 0 0 0 1.63 0z\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Installation\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../get-started/starter-example/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-file-box\" viewBox=\"0 0 24 24\"><path d=\"M14 2v5a1 1 0 0 0 1 1h5\"/><path d=\"M14.692 22H18a2 2 0 0 0 2-2V8a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 14 2H6a2 2 0 0 0-2 2v3.804\"/><path d=\"M2.264 13.752 7 16.5l4.737-2.748\"/><path d=\"M2.995 13.014A2 2 0 0 0 2 14.744v3.516a2 2 0 0 0 .996 1.73l3 1.74a2 2 0 0 0 2.008 0l3-1.74A2 2 0 0 0 12 18.26v-3.517a2 2 0 0 0-.995-1.73l-3-1.742a2 2 0 0 0-1.892-.064zM7 16.5V22\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Starter Example\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../get-started/license/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-scale\" viewBox=\"0 0 24 24\"><path d=\"M12 3v18M19 8l3 8a5 5 0 0 1-6 0zV7\"/><path d=\"M3 7h1a17 17 0 0 0 8-2 17 17 0 0 0 8 2h1M5 8l3 8a5 5 0 0 1-6 0zV7M7 21h10\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n License\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_2\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_2\" id=\"__nav_2_2_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Key Concepts\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_2_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Key Concepts\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/overview/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-info\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"M12 16v-4M12 8h.01\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Overview\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/sim_runner/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-settings\" viewBox=\"0 0 24 24\"><path d=\"M9.671 4.136a2.34 2.34 0 0 1 4.659 0 2.34 2.34 0 0 0 3.319 1.915 2.34 2.34 0 0 1 2.33 4.033 2.34 2.34 0 0 0 0 3.831 2.34 2.34 0 0 1-2.33 4.033 2.34 2.34 0 0 0-3.319 1.915 2.34 2.34 0 0 1-4.659 0 2.34 2.34 0 0 0-3.32-1.915 2.34 2.34 0 0 1-2.33-4.033 2.34 2.34 0 0 0 0-3.831A2.34 2.34 0 0 1 6.35 6.051a2.34 2.34 0 0 0 3.319-1.915\"/><circle cx=\"12\" cy=\"12\" r=\"3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Simulation Runner\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/case_builder/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-clipboard-list\" viewBox=\"0 0 24 24\"><rect width=\"8\" height=\"4\" x=\"8\" y=\"2\" rx=\"1\" ry=\"1\"/><path d=\"M16 4h2a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h2M12 11h4M12 16h4M8 11h.01M8 16h.01\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Case Builder\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/file_builder/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-folder-tree\" viewBox=\"0 0 24 24\"><path d=\"M20 10a1 1 0 0 0 1-1V6a1 1 0 0 0-1-1h-2.5a1 1 0 0 1-.8-.4l-.9-1.2A1 1 0 0 0 15 3h-2a1 1 0 0 0-1 1v5a1 1 0 0 0 1 1ZM20 21a1 1 0 0 0 1-1v-3a1 1 0 0 0-1-1h-2.9a1 1 0 0 1-.88-.55l-.42-.85a1 1 0 0 0-.92-.6H13a1 1 0 0 0-1 1v5a1 1 0 0 0 1 1ZM3 5a2 2 0 0 0 2 2h3\"/><path d=\"M3 3v13a2 2 0 0 0 2 2h3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n File Builder\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/input_target/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-square-arrow-right-enter\" viewBox=\"0 0 24 24\"><path d=\"m10 16 4-4-4-4M3 12h11\"/><path d=\"M3 8V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Input Target\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/study/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-file-chart-column-increasing\" viewBox=\"0 0 24 24\"><path d=\"M6 22a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h8a2.4 2.4 0 0 1 1.704.706l3.588 3.588A2.4 2.4 0 0 1 20 8v12a2 2 0 0 1-2 2z\"/><path d=\"M14 2v5a1 1 0 0 0 1 1h5M8 18v-2M12 18v-4M16 18v-6\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Study\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/source_target/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-square-arrow-right-enter\" viewBox=\"0 0 24 24\"><path d=\"m10 16 4-4-4-4M3 12h11\"/><path d=\"M3 8V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Source Target\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/study_runner/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-square-arrow-right-enter\" viewBox=\"0 0 24 24\"><path d=\"m10 16 4-4-4-4M3 12h11\"/><path d=\"M3 8V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Study Runner\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_3\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_3\" id=\"__nav_2_3_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Api\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_3_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_3\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Api\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/01-overview.md\" class=\"md-nav__link\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Overview\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n </ul>\n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-sidebar md-sidebar--secondary\" data-md-component=\"sidebar\" data-md-type=\"toc\" >\n <div class=\"md-sidebar__scrollwrap\">\n \n \n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle\" type=\"checkbox\" id=\"__toc\">\n <div class=\"md-sidebar-button__wrapper\">\n <label class=\"md-sidebar-button\" for=\"__toc\"></label>\n </div>\n \n \n <div class=\"md-sidebar__inner\">\n \n\n\n<nav class=\"md-nav md-nav--secondary\" aria-label=\"On this page\">\n \n \n \n \n \n \n <label class=\"md-nav__title\" for=\"__toc\">\n <span class=\"md-nav__icon md-icon\"></span>\n On this page\n </label>\n <ul class=\"md-nav__list\" data-md-component=\"toc\" data-md-scrollfix>\n \n <li class=\"md-nav__item\">\n <a href=\"#studpy.cases.OATConfig\" class=\"md-nav__link\">\n <span class=\"md-ellipsis\">\n <span class=\"md-typeset\">\n OATConfig\n </span>\n </span>\n </a>\n \n</li>\n \n <li class=\"md-nav__item\">\n <a href=\"#studpy.cases.OATConfig.check_target_source\" class=\"md-nav__link\">\n <span class=\"md-ellipsis\">\n <span class=\"md-typeset\">\n check_target_source\n </span>\n </span>\n </a>\n \n</li>\n \n <li class=\"md-nav__item\">\n <a href=\"#studpy.cases.OATConfig.need_target_source\" class=\"md-nav__link\">\n <span class=\"md-ellipsis\">\n <span class=\"md-typeset\">\n need_target_source\n </span>\n </span>\n </a>\n \n</li>\n \n </ul>\n \n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-content\" data-md-component=\"content\">\n \n \n\n\n\n \n\n\n \n <article class=\"md-content__inner md-typeset\">\n \n \n\n<h1 id=\"oatconfig\">OATConfig<a class=\"headerlink\" href=\"#oatconfig\" title=\"Permanent link\">¶</a></h1>\n\n\n<div class=\"doc doc-object doc-class\">\n\n\n\n<a id=\"studpy.cases.OATConfig\"></a>\n <div class=\"doc doc-contents first\">\n <p class=\"doc doc-class-bases\">\n Bases: <code><!-- zensical:autoref:0 --></code></p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-children\">\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.OATConfig.check_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">check_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.OATConfig.check_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>if config has <strong>SOURCE</strong> in attributes, raise ValueError</p>\n\n\n </div>\n\n</div>\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.OATConfig.need_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">need_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.OATConfig.need_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>config has <strong>SOURCE</strong> in attributes</p>\n\n\n </div>\n\n</div>\n\n\n\n </div>\n\n </div>\n\n</div>\n\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n\n \n </article>\n </div>\n \n \n<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith(\"__tabbed_\"))</script>\n </div>\n \n <button type=\"button\" class=\"md-top md-icon\" data-md-component=\"top\" hidden>\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-circle-arrow-up\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"m16 12-4-4-4 4M12 16V8\"/></svg>\n Back to top\n</button>\n \n </main>\n \n <footer class=\"md-footer\">\n \n <div class=\"md-footer-meta md-typeset\">\n <div class=\"md-footer-meta__inner md-grid\">\n <div class=\"md-copyright\">\n \n <div class=\"md-copyright__highlight\">\n Copyright © 2026 StudPy - A PinkSalmon Library\n </div>\n \n \n</div>\n \n </div>\n </div>\n</footer>\n \n </div>\n <div class=\"md-dialog\" data-md-component=\"dialog\">\n <div class=\"md-dialog__inner md-typeset\"></div>\n </div>\n \n \n \n \n \n \n \n \n \n <script id=\"__config\" type=\"application/json\">{\"annotate\":null,\"base\":\"../../../..\",\"features\":[\"navigation.tabs\",\"navigation.path\",\"navigation.expand\",\"navigation.top\",\"navigation.sections\",\"navigation.indexes\",\"content.code.copy\"],\"redirect\":null,\"search\":\"../../../../assets/javascripts/workers/search.7d14d953.min.js\",\"tags\":null,\"translations\":{\"clipboard.copied\":\"Copied to clipboard\",\"clipboard.copy\":\"Copy to clipboard\",\"search.result.more.one\":\"1 more on this page\",\"search.result.more.other\":\"# more on this page\",\"search.result.none\":\"No matching documents\",\"search.result.one\":\"1 matching document\",\"search.result.other\":\"# matching documents\",\"search.result.placeholder\":\"Type to start searching\",\"search.result.term.missing\":\"Missing\",\"select.version\":\"Select version\"},\"version\":\"v0.5.6\"}</script>\n \n \n <script src=\"../../../../assets/javascripts/bundle.8dcc8e9c.min.js\"></script>\n \n \n </body>\n</html>","hash":7252633412610393838}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"data":"\n<!doctype html>\n<html lang=\"en\" class=\"no-js\">\n <head>\n \n <meta charset=\"utf-8\">\n <meta name=\"viewport\" content=\"width=device-width,initial-scale=1\">\n \n \n <meta name=\"author\" content=\"PinkSalmon\">\n \n \n \n \n \n \n \n \n <link rel=\"icon\" href=\"../../../../assets/images/favicon.png\">\n <meta name=\"generator\" content=\"zensical-0.0.62\">\n \n \n \n <title>GaussianConfig - StudPy</title>\n \n \n \n \n \n \n <link rel=\"stylesheet\" href=\"../../../../assets/stylesheets/modern/main.ce62732f.min.css\">\n \n \n\n\n \n \n \n \n \n \n \n \n <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin>\n <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,500,500i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback\">\n <style>:root{--md-text-font:\"Inter\";--md-code-font:\"JetBrains Mono\"}</style>\n \n \n \n <link rel=\"stylesheet\" href=\"../../../../stylesheets/extra.css\">\n \n <script>__md_scope=new URL(\"../../../..\",location),__md_scope.pathname.endsWith(\"/\")||(__md_scope=new URL(__md_scope.pathname+\"/\",location)),__md_hash=e=>[...e].reduce(((e,t)=>(e<<5)-e+t.charCodeAt(0)),0),__md_get=(e,t=localStorage,_=__md_scope)=>JSON.parse(t.getItem(_.pathname+\".\"+e)),__md_set=(e,t,_=localStorage,a=__md_scope)=>{try{_.setItem(a.pathname+\".\"+e,JSON.stringify(t))}catch(e){}},document.documentElement.setAttribute(\"data-platform\",navigator.platform)</script>\n \n \n\n \n \n </head>\n \n \n <body dir=\"ltr\">\n \n \n <input class=\"md-toggle\" data-md-toggle=\"drawer\" type=\"checkbox\" id=\"__drawer\" autocomplete=\"off\">\n <input class=\"md-toggle\" data-md-toggle=\"search\" type=\"checkbox\" id=\"__search\" autocomplete=\"off\">\n <label class=\"md-overlay\" for=\"__drawer\" aria-label=\"Navigation\"></label>\n <div data-md-component=\"skip\">\n \n \n <a href=\"#gaussianconfig\" class=\"md-skip\">\n Skip to content\n </a>\n \n </div>\n <div data-md-component=\"announce\">\n \n </div>\n \n <div data-md-color-scheme=\"default\" data-md-component=\"outdated\" hidden>\n \n </div>\n \n \n \n\n<header class=\"md-header\" data-md-component=\"header\">\n <nav class=\"md-header__inner md-grid\" aria-label=\"Header\">\n <a href=\"../../../..\" title=\"StudPy\" class=\"md-header__button md-logo\" aria-label=\"StudPy\" data-md-component=\"logo\">\n \n <img src=\"../../../../assets/logo.svg\" alt=\"StudPy\">\n\n </a>\n <label class=\"md-header__button md-icon\" for=\"__drawer\" aria-label=\"Navigation\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-menu\" viewBox=\"0 0 24 24\"><path d=\"M4 5h16M4 12h16M4 19h16\"/></svg>\n </label>\n <div class=\"md-header__title\" data-md-component=\"header-title\">\n <div class=\"md-header__ellipsis\">\n <div class=\"md-header__topic\">\n <span class=\"md-ellipsis\">\n StudPy\n <span style=\"background: var(--md-accent-fg-color--transparent); color: var(--md-accent-fg-color); padding: 2px 4px; margin:4px; border-radius: 4px; font-size: 0.6em;\">\n v0.5.6\n </span>\n </span>\n </div>\n <div class=\"md-header__topic\" data-md-component=\"header-topic\">\n <span class=\"md-ellipsis\">\n \n GaussianConfig\n \n </span>\n </div>\n </div>\n </div>\n \n \n <script>var palette=__md_get(\"__palette\");if(palette&&palette.color){if(\"(prefers-color-scheme)\"===palette.color.media){var media=matchMedia(\"(prefers-color-scheme: light)\"),input=document.querySelector(media.matches?\"[data-md-color-media='(prefers-color-scheme: light)']\":\"[data-md-color-media='(prefers-color-scheme: dark)']\");palette.color.media=input.getAttribute(\"data-md-color-media\"),palette.color.scheme=input.getAttribute(\"data-md-color-scheme\"),palette.color.primary=input.getAttribute(\"data-md-color-primary\"),palette.color.accent=input.getAttribute(\"data-md-color-accent\")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute(\"data-md-color-\"+key,value)}</script>\n \n \n \n \n \n <label class=\"md-header__button md-icon\" for=\"__search\" aria-label=\"Search\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-search\" viewBox=\"0 0 24 24\"><path d=\"m21 21-4.34-4.34\"/><circle cx=\"11\" cy=\"11\" r=\"8\"/></svg>\n </label>\n <div class=\"md-search\" data-md-component=\"search\" role=\"dialog\" aria-label=\"Search\">\n <button type=\"button\" class=\"md-search__button\">\n Search\n </button>\n</div>\n \n \n <div class=\"md-header__source\">\n \n </div>\n </nav>\n \n</header>\n \n <div class=\"md-container\" data-md-component=\"container\">\n \n \n \n \n \n<nav class=\"md-tabs\" aria-label=\"Tabs\" data-md-component=\"tabs\">\n <div class=\"md-grid\">\n <ul class=\"md-tabs__list\">\n \n \n \n \n \n \n <li class=\"md-tabs__item\">\n <a href=\"../../../..\" class=\"md-tabs__link\">\n \n \n Home\n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-tabs__item\">\n <a href=\"../../../get-started/installation/\" class=\"md-tabs__link\">\n \n \n Documentations\n\n </a>\n </li>\n \n \n\n \n \n\n \n </ul>\n </div>\n</nav>\n \n \n \n <main class=\"md-main\" data-md-component=\"main\">\n <div class=\"md-main__inner md-grid\">\n \n \n \n <div class=\"md-sidebar md-sidebar--primary\" data-md-component=\"sidebar\" data-md-type=\"navigation\" >\n <div class=\"md-sidebar__scrollwrap\">\n <div class=\"md-sidebar__inner\">\n \n\n\n \n\n\n<nav class=\"md-nav md-nav--primary md-nav--lifted\" aria-label=\"Navigation\" data-md-level=\"0\">\n <label class=\"md-nav__title\" for=\"__drawer\">\n <a href=\"../../../..\" title=\"StudPy\" class=\"md-nav__button md-logo\" aria-label=\"StudPy\" data-md-component=\"logo\">\n \n <img src=\"../../../../assets/logo.svg\" alt=\"StudPy\">\n\n </a>\n StudPy\n </label>\n \n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../..\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-braces\" viewBox=\"0 0 24 24\"><path d=\"M8 3H7a2 2 0 0 0-2 2v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5c0 1.1.9 2 2 2h1M16 21h1a2 2 0 0 0 2-2v-5c0-1.1.9-2 2-2a2 2 0 0 1-2-2V5a2 2 0 0 0-2-2h-1\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Home\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2\" id=\"__nav_2_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Documentations\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_2_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Documentations\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_1\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_1\" id=\"__nav_2_1_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Get Started\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_1_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_1\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Get Started\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../get-started/installation/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-package-open\" viewBox=\"0 0 24 24\"><path d=\"M12 22v-9M15.17 2.21a1.67 1.67 0 0 1 1.63 0L21 4.57a1.93 1.93 0 0 1 0 3.36L8.82 14.79a1.66 1.66 0 0 1-1.64 0L3 12.43a1.93 1.93 0 0 1 0-3.36z\"/><path d=\"M20 13v3.87a2.06 2.06 0 0 1-1.11 1.83l-6 3.08a1.93 1.93 0 0 1-1.78 0l-6-3.08A2.06 2.06 0 0 1 4 16.87V13\"/><path d=\"M21 12.43a1.93 1.93 0 0 0 0-3.36L8.83 2.2a1.64 1.64 0 0 0-1.63 0L3 4.57a1.93 1.93 0 0 0 0 3.36l12.18 6.86a1.64 1.64 0 0 0 1.63 0z\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Installation\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../get-started/starter-example/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-file-box\" viewBox=\"0 0 24 24\"><path d=\"M14 2v5a1 1 0 0 0 1 1h5\"/><path d=\"M14.692 22H18a2 2 0 0 0 2-2V8a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 14 2H6a2 2 0 0 0-2 2v3.804\"/><path d=\"M2.264 13.752 7 16.5l4.737-2.748\"/><path d=\"M2.995 13.014A2 2 0 0 0 2 14.744v3.516a2 2 0 0 0 .996 1.73l3 1.74a2 2 0 0 0 2.008 0l3-1.74A2 2 0 0 0 12 18.26v-3.517a2 2 0 0 0-.995-1.73l-3-1.742a2 2 0 0 0-1.892-.064zM7 16.5V22\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Starter Example\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../get-started/license/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-scale\" viewBox=\"0 0 24 24\"><path d=\"M12 3v18M19 8l3 8a5 5 0 0 1-6 0zV7\"/><path d=\"M3 7h1a17 17 0 0 0 8-2 17 17 0 0 0 8 2h1M5 8l3 8a5 5 0 0 1-6 0zV7M7 21h10\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n License\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_2\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_2\" id=\"__nav_2_2_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Key Concepts\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_2_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Key Concepts\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/overview/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-info\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"M12 16v-4M12 8h.01\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Overview\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/sim_runner/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-settings\" viewBox=\"0 0 24 24\"><path d=\"M9.671 4.136a2.34 2.34 0 0 1 4.659 0 2.34 2.34 0 0 0 3.319 1.915 2.34 2.34 0 0 1 2.33 4.033 2.34 2.34 0 0 0 0 3.831 2.34 2.34 0 0 1-2.33 4.033 2.34 2.34 0 0 0-3.319 1.915 2.34 2.34 0 0 1-4.659 0 2.34 2.34 0 0 0-3.32-1.915 2.34 2.34 0 0 1-2.33-4.033 2.34 2.34 0 0 0 0-3.831A2.34 2.34 0 0 1 6.35 6.051a2.34 2.34 0 0 0 3.319-1.915\"/><circle cx=\"12\" cy=\"12\" r=\"3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Simulation Runner\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/case_builder/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-clipboard-list\" viewBox=\"0 0 24 24\"><rect width=\"8\" height=\"4\" x=\"8\" y=\"2\" rx=\"1\" ry=\"1\"/><path d=\"M16 4h2a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h2M12 11h4M12 16h4M8 11h.01M8 16h.01\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Case Builder\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/file_builder/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-folder-tree\" viewBox=\"0 0 24 24\"><path d=\"M20 10a1 1 0 0 0 1-1V6a1 1 0 0 0-1-1h-2.5a1 1 0 0 1-.8-.4l-.9-1.2A1 1 0 0 0 15 3h-2a1 1 0 0 0-1 1v5a1 1 0 0 0 1 1ZM20 21a1 1 0 0 0 1-1v-3a1 1 0 0 0-1-1h-2.9a1 1 0 0 1-.88-.55l-.42-.85a1 1 0 0 0-.92-.6H13a1 1 0 0 0-1 1v5a1 1 0 0 0 1 1ZM3 5a2 2 0 0 0 2 2h3\"/><path d=\"M3 3v13a2 2 0 0 0 2 2h3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n File Builder\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/input_target/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-square-arrow-right-enter\" viewBox=\"0 0 24 24\"><path d=\"m10 16 4-4-4-4M3 12h11\"/><path d=\"M3 8V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Input Target\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/study/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-file-chart-column-increasing\" viewBox=\"0 0 24 24\"><path d=\"M6 22a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h8a2.4 2.4 0 0 1 1.704.706l3.588 3.588A2.4 2.4 0 0 1 20 8v12a2 2 0 0 1-2 2z\"/><path d=\"M14 2v5a1 1 0 0 0 1 1h5M8 18v-2M12 18v-4M16 18v-6\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Study\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/source_target/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-square-arrow-right-enter\" viewBox=\"0 0 24 24\"><path d=\"m10 16 4-4-4-4M3 12h11\"/><path d=\"M3 8V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Source Target\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/study_runner/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-square-arrow-right-enter\" viewBox=\"0 0 24 24\"><path d=\"m10 16 4-4-4-4M3 12h11\"/><path d=\"M3 8V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-3\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Study Runner\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_3\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_3\" id=\"__nav_2_3_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Api\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_3_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_3\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Api\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../../key-concepts/01-overview.md\" class=\"md-nav__link\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Overview\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n \n </ul>\n </nav>\n \n </li>\n \n\n \n </ul>\n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-sidebar md-sidebar--secondary\" data-md-component=\"sidebar\" data-md-type=\"toc\" >\n <div class=\"md-sidebar__scrollwrap\">\n \n \n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle\" type=\"checkbox\" id=\"__toc\">\n <div class=\"md-sidebar-button__wrapper\">\n <label class=\"md-sidebar-button\" for=\"__toc\"></label>\n </div>\n \n \n <div class=\"md-sidebar__inner\">\n \n\n\n<nav class=\"md-nav md-nav--secondary\" aria-label=\"On this page\">\n \n \n \n \n \n \n <label class=\"md-nav__title\" for=\"__toc\">\n <span class=\"md-nav__icon md-icon\"></span>\n On this page\n </label>\n <ul class=\"md-nav__list\" data-md-component=\"toc\" data-md-scrollfix>\n \n <li class=\"md-nav__item\">\n <a href=\"#studpy.cases.GaussianConfig\" class=\"md-nav__link\">\n <span class=\"md-ellipsis\">\n <span class=\"md-typeset\">\n GaussianConfig\n </span>\n </span>\n </a>\n \n</li>\n \n <li class=\"md-nav__item\">\n <a href=\"#studpy.cases.GaussianConfig.check_target_source\" class=\"md-nav__link\">\n <span class=\"md-ellipsis\">\n <span class=\"md-typeset\">\n check_target_source\n </span>\n </span>\n </a>\n \n</li>\n \n <li class=\"md-nav__item\">\n <a href=\"#studpy.cases.GaussianConfig.need_target_source\" class=\"md-nav__link\">\n <span class=\"md-ellipsis\">\n <span class=\"md-typeset\">\n need_target_source\n </span>\n </span>\n </a>\n \n</li>\n \n </ul>\n \n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-content\" data-md-component=\"content\">\n \n \n\n\n\n \n\n\n \n <article class=\"md-content__inner md-typeset\">\n \n \n\n<h1 id=\"gaussianconfig\">GaussianConfig<a class=\"headerlink\" href=\"#gaussianconfig\" title=\"Permanent link\">¶</a></h1>\n\n\n<div class=\"doc doc-object doc-class\">\n\n\n\n<a id=\"studpy.cases.GaussianConfig\"></a>\n <div class=\"doc doc-contents first\">\n <p class=\"doc doc-class-bases\">\n Bases: <code><!-- zensical:autoref:0 --></code></p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-children\">\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.GaussianConfig.check_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">check_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.GaussianConfig.check_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>if config has <strong>SOURCE</strong> in attributes, raise ValueError</p>\n\n\n </div>\n\n</div>\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.GaussianConfig.need_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">need_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.GaussianConfig.need_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>config has <strong>SOURCE</strong> in attributes</p>\n\n\n </div>\n\n</div>\n\n\n\n </div>\n\n </div>\n\n</div>\n\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n\n \n </article>\n </div>\n \n \n<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith(\"__tabbed_\"))</script>\n </div>\n \n <button type=\"button\" class=\"md-top md-icon\" data-md-component=\"top\" hidden>\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-circle-arrow-up\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"m16 12-4-4-4 4M12 16V8\"/></svg>\n Back to top\n</button>\n \n </main>\n \n <footer class=\"md-footer\">\n \n <div class=\"md-footer-meta md-typeset\">\n <div class=\"md-footer-meta__inner md-grid\">\n <div class=\"md-copyright\">\n \n <div class=\"md-copyright__highlight\">\n Copyright © 2026 StudPy - A PinkSalmon Library\n </div>\n \n \n</div>\n \n </div>\n </div>\n</footer>\n \n </div>\n <div class=\"md-dialog\" data-md-component=\"dialog\">\n <div class=\"md-dialog__inner md-typeset\"></div>\n </div>\n \n \n \n \n \n \n \n \n \n <script id=\"__config\" type=\"application/json\">{\"annotate\":null,\"base\":\"../../../..\",\"features\":[\"navigation.tabs\",\"navigation.path\",\"navigation.expand\",\"navigation.top\",\"navigation.sections\",\"navigation.indexes\",\"content.code.copy\"],\"redirect\":null,\"search\":\"../../../../assets/javascripts/workers/search.7d14d953.min.js\",\"tags\":null,\"translations\":{\"clipboard.copied\":\"Copied to clipboard\",\"clipboard.copy\":\"Copy to clipboard\",\"search.result.more.one\":\"1 more on this page\",\"search.result.more.other\":\"# more on this page\",\"search.result.none\":\"No matching documents\",\"search.result.one\":\"1 matching document\",\"search.result.other\":\"# matching documents\",\"search.result.placeholder\":\"Type to start searching\",\"search.result.term.missing\":\"Missing\",\"select.version\":\"Select version\"},\"version\":\"v0.5.6\"}</script>\n \n \n <script src=\"../../../../assets/javascripts/bundle.8dcc8e9c.min.js\"></script>\n \n \n </body>\n</html>","hash":12447114080259807261}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"data":{"route":{"source":"documentation/get-started/installation.md","destination":"documentation/get-started/installation/index.html","url":"documentation/get-started/installation/"},"markdown":{"meta":{"icon":"lucide/package-open","tags":["Get started"]},"content":"<h1 id=\"installation\">Installation<a class=\"headerlink\" href=\"#installation\" title=\"Permanent link\">¶</a></h1>\n<p><strong>StudPy</strong> is written in <strong>Python</strong> and is published as a <strong>Python package</strong>. It could be installed with <strong>pip</strong> or with your favorite <strong>package manager</strong>.</p>\n<h2 id=\"install-with-pip\">Install with pip<a class=\"headerlink\" href=\"#install-with-pip\" title=\"Permanent link\">¶</a></h2>\n<div class=\"language-sh highlight\"><pre><span></span><code><span id=\"__span-0-1\"><a id=\"__codelineno-0-1\" name=\"__codelineno-0-1\" href=\"#__codelineno-0-1\"></a>pip<span class=\"w\"> </span>install<span class=\"w\"> </span>studpy\n</span></code></pre></div>\n<p>We recommend to use a Python virtual environment when installing with pip.</p>\n<div class=\"tabbed-set tabbed-alternate\" data-tabs=\"1:3\"><input checked=\"checked\" id=\"__tabbed_1_1\" name=\"__tabbed_1\" type=\"radio\" /><input id=\"__tabbed_1_2\" name=\"__tabbed_1\" type=\"radio\" /><input id=\"__tabbed_1_3\" name=\"__tabbed_1\" type=\"radio\" /><div class=\"tabbed-labels\"><label for=\"__tabbed_1_1\"><span class=\"twemoji\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M18.71 19.5c-.83 1.24-1.71 2.45-3.05 2.47-1.34.03-1.77-.79-3.29-.79-1.53 0-2 .77-3.27.82-1.31.05-2.3-1.32-3.14-2.53C4.25 17 2.94 12.45 4.7 9.39c.87-1.52 2.43-2.48 4.12-2.51 1.28-.02 2.5.87 3.29.87.78 0 2.26-1.07 3.81-.91.65.03 2.47.26 3.64 1.98-.09.06-2.17 1.28-2.15 3.81.03 3.02 2.65 4.03 2.68 4.04-.03.07-.42 1.44-1.38 2.83M13 3.5c.73-.83 1.94-1.46 2.94-1.5.13 1.17-.34 2.35-1.04 3.19-.69.85-1.83 1.51-2.95 1.42-.15-1.15.41-2.35 1.05-3.11\"/></svg></span> macOS</label><label for=\"__tabbed_1_2\"><span class=\"twemoji\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 448 512\"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc.--><path fill=\"currentColor\" d=\"m0 93.7 183.6-25.3v177.4H0zm0 324.6 183.6 25.3V268.4H0zm203.8 28L448 480V268.4H203.8zm0-380.6v180.1H448V32z\"/></svg></span> Windows</label><label for=\"__tabbed_1_3\"><span class=\"twemoji\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M14.62 8.35c-.42.28-1.75 1.04-1.95 1.19-.39.31-.75.29-1.14-.01-.2-.16-1.53-.92-1.95-1.19-.48-.31-.45-.7.08-.92 1.64-.69 3.28-.64 4.91.03.49.21.51.6.05.9m7.22 7.28c-.93-2.09-2.2-3.99-3.84-5.66a4.3 4.3 0 0 1-1.06-1.88c-.1-.33-.17-.67-.24-1.01-.2-.88-.29-1.78-.7-2.61-.73-1.58-2-2.4-3.84-2.47-1.81.05-3.16.81-3.95 2.4-.21.43-.36.88-.46 1.34-.17.76-.32 1.55-.5 2.32-.15.65-.45 1.21-.96 1.71-1.61 1.57-2.9 3.37-3.88 5.35-.14.29-.28.58-.37.88-.19.66.29 1.12.99.96.44-.09.88-.18 1.3-.31.41-.15.57-.05.67.35.65 2.15 2.07 3.66 4.24 4.5 4.12 1.56 8.93-.66 9.97-4.58.07-.27.17-.37.47-.27.46.14.93.24 1.4.35.49.09.85-.16.92-.64.03-.26-.06-.49-.16-.73\"/></svg></span> Linux</label></div>\n<div class=\"tabbed-content\">\n<div class=\"tabbed-block\">\n<div class=\"language-sh highlight\"><pre><span></span><code><span id=\"__span-1-1\"><a id=\"__codelineno-1-1\" name=\"__codelineno-1-1\" href=\"#__codelineno-1-1\"></a>python3<span class=\"w\"> </span>-m<span class=\"w\"> </span>venv<span class=\"w\"> </span>.venv\n</span><span id=\"__span-1-2\"><a id=\"__codelineno-1-2\" name=\"__codelineno-1-2\" href=\"#__codelineno-1-2\"></a><span class=\"nb\">source</span><span class=\"w\"> </span>.venv/bin/activate\n</span><span id=\"__span-1-3\"><a id=\"__codelineno-1-3\" name=\"__codelineno-1-3\" href=\"#__codelineno-1-3\"></a>pip<span class=\"w\"> </span>install<span class=\"w\"> </span>studpy\n</span></code></pre></div>\n</div>\n<div class=\"tabbed-block\">\n<div class=\"language-ps1 highlight\"><pre><span></span><code><span id=\"__span-2-1\"><a id=\"__codelineno-2-1\" name=\"__codelineno-2-1\" href=\"#__codelineno-2-1\"></a><span class=\"n\">python</span> <span class=\"n\">-m</span> <span class=\"n\">venv</span> <span class=\"p\">.</span><span class=\"n\">venv</span>\n</span><span id=\"__span-2-2\"><a id=\"__codelineno-2-2\" name=\"__codelineno-2-2\" href=\"#__codelineno-2-2\"></a><span class=\"p\">.</span><span class=\"n\">venv</span><span class=\"p\">\\</span><span class=\"n\">Scripts</span><span class=\"p\">\\</span><span class=\"n\">activate</span>\n</span><span id=\"__span-2-3\"><a id=\"__codelineno-2-3\" name=\"__codelineno-2-3\" href=\"#__codelineno-2-3\"></a><span class=\"n\">pip</span> <span class=\"n\">install</span> <span class=\"n\">studpy</span>\n</span></code></pre></div>\n</div>\n<div class=\"tabbed-block\">\n<div class=\"language-sh highlight\"><pre><span></span><code><span id=\"__span-3-1\"><a id=\"__codelineno-3-1\" name=\"__codelineno-3-1\" href=\"#__codelineno-3-1\"></a>python3<span class=\"w\"> </span>-m<span class=\"w\"> </span>venv<span class=\"w\"> </span>.venv\n</span><span id=\"__span-3-2\"><a id=\"__codelineno-3-2\" name=\"__codelineno-3-2\" href=\"#__codelineno-3-2\"></a><span class=\"nb\">source</span><span class=\"w\"> </span>.venv/bin/activate\n</span><span id=\"__span-3-3\"><a id=\"__codelineno-3-3\" name=\"__codelineno-3-3\" href=\"#__codelineno-3-3\"></a>pip<span class=\"w\"> </span>install<span class=\"w\"> </span>studpy\n</span></code></pre></div>\n</div>\n</div>\n</div>","toc":[{"title":"Installation","content":"Installation","id":"installation","url":"#installation","children":[{"title":"Install with pip","content":"Install with pip","id":"install-with-pip","url":"#install-with-pip","children":[],"level":2}],"level":1}]},"title":"Installation","registrations":{"primary":{"installation":["documentation/get-started/installation/#installation"],"install-with-pip":["documentation/get-started/installation/#install-with-pip"]},"secondary":{},"titles":{"documentation/get-started/installation/#install-with-pip":"Install with pip","documentation/get-started/installation/#installation":"Installation"}},"html":{"autorefs":{"references":[]},"search":{"sections":[{"location":null,"level":1,"title":"Installation","text":"<p>StudPy is written in Python and is published as a Python package. It could be installed with pip or with your favorite package manager.</p>"},{"location":"install-with-pip","level":2,"title":"Install with pip","text":"<pre><code>pip install studpy\n</code></pre> <p>We recommend to use a Python virtual environment when installing with pip.</p> macOS Windows Linux <pre><code>python3 -m venv .venv\nsource .venv/bin/activate\npip install studpy\n</code></pre> <pre><code>python -m venv .venv\n.venv\\Scripts\\activate\npip install studpy\n</code></pre> <pre><code>python3 -m venv .venv\nsource .venv/bin/activate\npip install studpy\n</code></pre>"}]},"tags":{"mappings":[],"listings":[],"search_cleanup":false}}},"hash":10390060708164701825}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"data":{"route":{"source":"documentation/key-concepts/sim_runner.md","destination":"documentation/key-concepts/sim_runner/index.html","url":"documentation/key-concepts/sim_runner/"},"markdown":{"meta":{"icon":"lucide/settings"},"content":"<h1 id=\"simulation-runner\">Simulation Runner<a class=\"headerlink\" href=\"#simulation-runner\" title=\"Permanent link\">¶</a></h1>\n<h2 id=\"overview\">Overview<a class=\"headerlink\" href=\"#overview\" title=\"Permanent link\">¶</a></h2>\n<p>The <code>SimRunner</code> is the object responsible for <strong>running a simulation</strong>, including any associated pre- and post-processing actions.</p>\n<p>It operates with:</p>\n<ul>\n<li>an <strong>Execution context</strong>: the locations of engine distributions and the runner runtime assets.</li>\n<li>an <strong>Execution configuration</strong>: whether the main simulation is launched as a script or a command, which options and arguments are used, the encoding of input files, and which pre- and post-processing actions should be executed.</li>\n</ul>\n<p><img alt=\"\" src=\"../sim_runner_2.png\" /></p>\n<h2 id=\"runner-file-workspace-and-context-path-variables\">Runner File Workspace and Context Path Variables<a class=\"headerlink\" href=\"#runner-file-workspace-and-context-path-variables\" title=\"Permanent link\">¶</a></h2>\n<p>During the runner execution, 4 folders are created:</p>\n<ul>\n<li>an <strong>input files</strong> folder: input files (for third parties and scripts) </li>\n<li>an <strong>output files</strong> folder, outputs files (from third parties and scripts) (theorically)</li>\n<li>a <strong>log files</strong> folder: third parties and scripts logs</li>\n<li>a <strong>temporary</strong> folder: for convenience in scripts</li>\n</ul>\n<p>Some of context path variables are accessible:</p>\n<ul>\n<li>for <strong>templating in configurations</strong> (command, ...) through <strong>{} string templating</strong></li>\n<li>in the <strong>pre/main/post scripts</strong> if they exists througt <strong>environment variables</strong></li>\n</ul>\n<p>Those variable are:</p>\n<ul>\n<li><code>INPUTS_FOLDER_PATH</code>: the inputs folder</li>\n<li><code>OUTPUTS_FOLDER_PATH</code>: the outputs folder</li>\n<li><code>TMP_FOLDER_PATH</code>: the temporary folder</li>\n<li><code>MAIN_INPUT_PATH</code>: the main input absolute path</li>\n</ul>\n<p>Example in a <code>sim_runner_exec_config</code> configuration yaml file:</p>\n<p><div class=\"language-yaml highlight\"><pre><span></span><code><span id=\"__span-0-1\"><a id=\"__codelineno-0-1\" name=\"__codelineno-0-1\" href=\"#__codelineno-0-1\"></a><span class=\"nt\">main_input_file_replace_templates</span><span class=\"p\">:</span>\n</span><span id=\"__span-0-2\"><a id=\"__codelineno-0-2\" name=\"__codelineno-0-2\" href=\"#__codelineno-0-2\"></a><span class=\"w\"> </span><span class=\"c1\"># inputs</span>\n</span><span id=\"__span-0-3\"><a id=\"__codelineno-0-3\" name=\"__codelineno-0-3\" href=\"#__codelineno-0-3\"></a><span class=\"w\"> </span><span class=\"s\">\"MESH_FILENAME=</span><span class=\"nv\"> </span><span class=\"s\">\"</span><span class=\"p p-Indicator\">:</span><span class=\"w\"> </span><span class=\"s\">\"MESH_FILENAME=</span><span class=\"nv\"> </span><span class=\"s\">{INPUTS_FOLDER_PATH}/\"</span>\n</span></code></pre></div>\nExample in a pre script:</p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-1-1\"><a id=\"__codelineno-1-1\" name=\"__codelineno-1-1\" href=\"#__codelineno-1-1\"></a><span class=\"n\">INPUTS_FOLDER_PATH</span> <span class=\"o\">=</span> <span class=\"n\">Path</span><span class=\"p\">(</span><span class=\"n\">os</span><span class=\"o\">.</span><span class=\"n\">getenv</span><span class=\"p\">(</span><span class=\"s2\">\"INPUTS_FOLDER_PATH\"</span><span class=\"p\">))</span>\n</span><span id=\"__span-1-2\"><a id=\"__codelineno-1-2\" name=\"__codelineno-1-2\" href=\"#__codelineno-1-2\"></a><span class=\"n\">OUTPUTS_FOLDER_PATH</span> <span class=\"o\">=</span> <span class=\"n\">Path</span><span class=\"p\">(</span><span class=\"n\">os</span><span class=\"o\">.</span><span class=\"n\">getenv</span><span class=\"p\">(</span><span class=\"s2\">\"OUTPUTS_FOLDER_PATH\"</span><span class=\"p\">))</span>\n</span></code></pre></div>\n<h2 id=\"sim-runner-configuration\">Sim Runner Configuration<a class=\"headerlink\" href=\"#sim-runner-configuration\" title=\"Permanent link\">¶</a></h2>\n<p>Example of yaml conf file <code>sim_runner_exec_config.yaml</code>:</p>\n<div class=\"language-yaml highlight\"><pre><span></span><code><span id=\"__span-2-1\"><a id=\"__codelineno-2-1\" name=\"__codelineno-2-1\" href=\"#__codelineno-2-1\"></a><span class=\"nt\">main</span><span class=\"p\">:</span>\n</span><span id=\"__span-2-2\"><a id=\"__codelineno-2-2\" name=\"__codelineno-2-2\" href=\"#__codelineno-2-2\"></a><span class=\"w\"> </span><span class=\"nt\">type</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s\">\"command\"</span>\n</span><span id=\"__span-2-3\"><a id=\"__codelineno-2-3\" name=\"__codelineno-2-3\" href=\"#__codelineno-2-3\"></a><span class=\"w\"> </span><span class=\"nt\">command_template</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s\">\"ls</span><span class=\"nv\"> </span><span class=\"s\">{INPUTS_FOLDER_PATH}\"</span>\n</span><span id=\"__span-2-4\"><a id=\"__codelineno-2-4\" name=\"__codelineno-2-4\" href=\"#__codelineno-2-4\"></a>\n</span><span id=\"__span-2-5\"><a id=\"__codelineno-2-5\" name=\"__codelineno-2-5\" href=\"#__codelineno-2-5\"></a><span class=\"nt\">post</span><span class=\"p\">:</span>\n</span><span id=\"__span-2-6\"><a id=\"__codelineno-2-6\" name=\"__codelineno-2-6\" href=\"#__codelineno-2-6\"></a><span class=\"w\"> </span><span class=\"nt\">type</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s\">\"script\"</span>\n</span></code></pre></div>\n<h3 id=\"simrunnerexecconfig\">SimRunnerExecConfig<a class=\"headerlink\" href=\"#simrunnerexecconfig\" title=\"Permanent link\">¶</a></h3>\n<div class=\"language-text highlight\"><pre><span></span><code>Configuration of the execution plan of a **simulation** with pre / main / post steps.\n</code></pre></div>\n<table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Type</th>\n<th>Req.</th>\n<th>Default</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>main</code></td>\n<td><a href=\"#execcommandconfig\">ExecCommandConfig</a> or <a href=\"#execscriptconfig\">ExecScriptConfig</a></td>\n<td>✅</td>\n<td></td>\n</tr>\n<tr>\n<td><code>main_input_file_replace_templates</code></td>\n<td><code>dict[str, str]</code> or <code>None</code></td>\n<td></td>\n<td><code>None</code></td>\n</tr>\n<tr>\n<td><code>input_encoding</code></td>\n<td><code>str</code> or <code>None</code></td>\n<td></td>\n<td><code>None</code></td>\n</tr>\n<tr>\n<td><code>pre</code></td>\n<td><a href=\"#execscriptconfig\">ExecScriptConfig</a> or <code>None</code></td>\n<td></td>\n<td><code>None</code></td>\n</tr>\n<tr>\n<td><code>post</code></td>\n<td><a href=\"#execscriptconfig\">ExecScriptConfig</a> or <code>None</code></td>\n<td></td>\n<td><code>None</code></td>\n</tr>\n</tbody>\n</table>\n<p><code>main</code> : <strong>Main</strong> configuration, defining the command or script to run</p>\n<p><code>main_input_file_replace_templates</code> : Dict of old/new strings to replace in the main input file of the simulation, <em>context path variables templating</em> could be used</p>\n<p><code>input_encoding</code> : Encoding used when reading input files</p>\n<p><code>pre</code> : Pre actions configuration</p>\n<p><code>post</code> : Post actions configuration</p>\n<h3 id=\"execcommandconfig\">ExecCommandConfig<a class=\"headerlink\" href=\"#execcommandconfig\" title=\"Permanent link\">¶</a></h3>\n<table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Type</th>\n<th>Req.</th>\n<th>Default</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>type</code></td>\n<td><code>Literal[\"command\"]</code></td>\n<td></td>\n<td><code>\"command\"</code></td>\n</tr>\n<tr>\n<td><code>command_template</code></td>\n<td><code>str</code></td>\n<td>✅</td>\n<td></td>\n</tr>\n<tr>\n<td><code>cwd</code></td>\n<td><code>Literal[\"tmp_folder_path\", \"folder_path\", \"inputs_folder_path\", \"outputs_folder_path\"]</code></td>\n<td></td>\n<td><code>\"tmp_folder_path\"</code></td>\n</tr>\n<tr>\n<td><code>env_templates</code></td>\n<td><code>dict[str, str]</code> or <code>None</code></td>\n<td></td>\n<td><code>None</code></td>\n</tr>\n<tr>\n<td><code>auto_move_outputs</code></td>\n<td><code>bool</code></td>\n<td></td>\n<td><code>False</code></td>\n</tr>\n</tbody>\n</table>\n<p><code>command_template</code> : Command to execute, <em>context path variables templating</em> could be used</p>\n<p><code>cwd</code> : Curent working directory of the command execution</p>\n<p><code>env_templates</code> : Dict of environnement variables, <em>context path variables templating</em> could be used</p>\n<p><code>auto_move_outputs</code> : Activate the automatic identification and move of output files from inputs to outputs file workspace folders</p>\n<h3 id=\"execscriptconfig\">ExecScriptConfig<a class=\"headerlink\" href=\"#execscriptconfig\" title=\"Permanent link\">¶</a></h3>\n<table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Type</th>\n<th>Req.</th>\n<th>Default</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>type</code></td>\n<td><code>Literal[\"script\"]</code></td>\n<td></td>\n<td><code>\"script\"</code></td>\n</tr>\n<tr>\n<td><code>cwd</code></td>\n<td><code>Literal[\"tmp_folder_path\", \"folder_path\", \"inputs_folder_path\", \"outputs_folder_path\"]</code></td>\n<td></td>\n<td><code>\"outputs_folder_path\"</code></td>\n</tr>\n<tr>\n<td><code>env_templates</code></td>\n<td><code>dict[str, str]</code> or <code>None</code></td>\n<td></td>\n<td><code>None</code></td>\n</tr>\n<tr>\n<td><code>auto_move_outputs</code></td>\n<td><code>bool</code></td>\n<td></td>\n<td><code>False</code></td>\n</tr>\n</tbody>\n</table>\n<p><code>cwd</code> : Curent working directory of the script execution</p>\n<p><code>env_templates</code> : Dict of environnement variables, <em>context path variables templating</em> could be used</p>\n<p><code>auto_move_outputs</code> : Activate the automatic identification and move of output files from inputs to outputs file workspace folders</p>","toc":[{"title":"Simulation Runner","content":"Simulation Runner","id":"simulation-runner","url":"#simulation-runner","children":[{"title":"Overview","content":"Overview","id":"overview","url":"#overview","children":[],"level":2},{"title":"Runner File Workspace and Context Path Variables","content":"Runner File Workspace and Context Path Variables","id":"runner-file-workspace-and-context-path-variables","url":"#runner-file-workspace-and-context-path-variables","children":[],"level":2},{"title":"Sim Runner Configuration","content":"Sim Runner Configuration","id":"sim-runner-configuration","url":"#sim-runner-configuration","children":[{"title":"SimRunnerExecConfig","content":"SimRunnerExecConfig","id":"simrunnerexecconfig","url":"#simrunnerexecconfig","children":[],"level":3},{"title":"ExecCommandConfig","content":"ExecCommandConfig","id":"execcommandconfig","url":"#execcommandconfig","children":[],"level":3},{"title":"ExecScriptConfig","content":"ExecScriptConfig","id":"execscriptconfig","url":"#execscriptconfig","children":[],"level":3}],"level":2}],"level":1}]},"title":"Simulation Runner","registrations":{"primary":{"sim-runner-configuration":["documentation/key-concepts/sim_runner/#sim-runner-configuration"],"execscriptconfig":["documentation/key-concepts/sim_runner/#execscriptconfig"],"overview":["documentation/key-concepts/sim_runner/#overview"],"runner-file-workspace-and-context-path-variables":["documentation/key-concepts/sim_runner/#runner-file-workspace-and-context-path-variables"],"execcommandconfig":["documentation/key-concepts/sim_runner/#execcommandconfig"],"simulation-runner":["documentation/key-concepts/sim_runner/#simulation-runner"],"simrunnerexecconfig":["documentation/key-concepts/sim_runner/#simrunnerexecconfig"]},"secondary":{},"titles":{"documentation/key-concepts/sim_runner/#execcommandconfig":"ExecCommandConfig","documentation/key-concepts/sim_runner/#overview":"Overview","documentation/key-concepts/sim_runner/#simrunnerexecconfig":"SimRunnerExecConfig","documentation/key-concepts/sim_runner/#sim-runner-configuration":"Sim Runner Configuration","documentation/key-concepts/sim_runner/#execscriptconfig":"ExecScriptConfig","documentation/key-concepts/sim_runner/#runner-file-workspace-and-context-path-variables":"Runner File Workspace and Context Path Variables","documentation/key-concepts/sim_runner/#simulation-runner":"Simulation Runner"}},"html":{"autorefs":{"references":[]},"search":{"sections":[{"location":null,"level":1,"title":"Simulation Runner","text":""},{"location":"overview","level":2,"title":"Overview","text":"<p>The <code>SimRunner</code> is the object responsible for running a simulation, including any associated pre- and post-processing actions.</p> <p>It operates with:</p> <ul> <li>an Execution context: the locations of engine distributions and the runner runtime assets.</li> <li>an Execution configuration: whether the main simulation is launched as a script or a command, which options and arguments are used, the encoding of input files, and which pre- and post-processing actions should be executed.</li> </ul> <p></p>"},{"location":"runner-file-workspace-and-context-path-variables","level":2,"title":"Runner File Workspace and Context Path Variables","text":"<p>During the runner execution, 4 folders are created:</p> <ul> <li>an input files folder: input files (for third parties and scripts) </li> <li>an output files folder, outputs files (from third parties and scripts) (theorically)</li> <li>a log files folder: third parties and scripts logs</li> <li>a temporary folder: for convenience in scripts</li> </ul> <p>Some of context path variables are accessible:</p> <ul> <li>for templating in configurations (command, ...) through {} string templating</li> <li>in the pre/main/post scripts if they exists througt environment variables</li> </ul> <p>Those variable are:</p> <ul> <li><code>INPUTS_FOLDER_PATH</code>: the inputs folder</li> <li><code>OUTPUTS_FOLDER_PATH</code>: the outputs folder</li> <li><code>TMP_FOLDER_PATH</code>: the temporary folder</li> <li><code>MAIN_INPUT_PATH</code>: the main input absolute path</li> </ul> <p>Example in a <code>sim_runner_exec_config</code> configuration yaml file:</p> <p><pre><code>main_input_file_replace_templates:\n # inputs\n \"MESH_FILENAME= \": \"MESH_FILENAME= {INPUTS_FOLDER_PATH}/\"\n</code></pre> Example in a pre script:</p> <pre><code>INPUTS_FOLDER_PATH = Path(os.getenv(\"INPUTS_FOLDER_PATH\"))\nOUTPUTS_FOLDER_PATH = Path(os.getenv(\"OUTPUTS_FOLDER_PATH\"))\n</code></pre>"},{"location":"sim-runner-configuration","level":2,"title":"Sim Runner Configuration","text":"<p>Example of yaml conf file <code>sim_runner_exec_config.yaml</code>:</p> <pre><code>main:\n type: \"command\"\n command_template: \"ls {INPUTS_FOLDER_PATH}\"\n\npost:\n type: \"script\"\n</code></pre>"},{"location":"simrunnerexecconfig","level":3,"title":"SimRunnerExecConfig","text":"<pre><code>Configuration of the execution plan of a **simulation** with pre / main / post steps.\n</code></pre> Field Type Req. Default <code>main</code> ExecCommandConfig or ExecScriptConfig ✅ <code>main_input_file_replace_templates</code> <code>dict[str, str]</code> or <code>None</code> <code>None</code> <code>input_encoding</code> <code>str</code> or <code>None</code> <code>None</code> <code>pre</code> ExecScriptConfig or <code>None</code> <code>None</code> <code>post</code> ExecScriptConfig or <code>None</code> <code>None</code> <p><code>main</code> : Main configuration, defining the command or script to run</p> <p><code>main_input_file_replace_templates</code> : Dict of old/new strings to replace in the main input file of the simulation, context path variables templating could be used</p> <p><code>input_encoding</code> : Encoding used when reading input files</p> <p><code>pre</code> : Pre actions configuration</p> <p><code>post</code> : Post actions configuration</p>"},{"location":"execcommandconfig","level":3,"title":"ExecCommandConfig","text":"Field Type Req. Default <code>type</code> <code>Literal[\"command\"]</code> <code>\"command\"</code> <code>command_template</code> <code>str</code> ✅ <code>cwd</code> <code>Literal[\"tmp_folder_path\", \"folder_path\", \"inputs_folder_path\", \"outputs_folder_path\"]</code> <code>\"tmp_folder_path\"</code> <code>env_templates</code> <code>dict[str, str]</code> or <code>None</code> <code>None</code> <code>auto_move_outputs</code> <code>bool</code> <code>False</code> <p><code>command_template</code> : Command to execute, context path variables templating could be used</p> <p><code>cwd</code> : Curent working directory of the command execution</p> <p><code>env_templates</code> : Dict of environnement variables, context path variables templating could be used</p> <p><code>auto_move_outputs</code> : Activate the automatic identification and move of output files from inputs to outputs file workspace folders</p>"},{"location":"execscriptconfig","level":3,"title":"ExecScriptConfig","text":"Field Type Req. Default <code>type</code> <code>Literal[\"script\"]</code> <code>\"script\"</code> <code>cwd</code> <code>Literal[\"tmp_folder_path\", \"folder_path\", \"inputs_folder_path\", \"outputs_folder_path\"]</code> <code>\"outputs_folder_path\"</code> <code>env_templates</code> <code>dict[str, str]</code> or <code>None</code> <code>None</code> <code>auto_move_outputs</code> <code>bool</code> <code>False</code> <p><code>cwd</code> : Curent working directory of the script execution</p> <p><code>env_templates</code> : Dict of environnement variables, context path variables templating could be used</p> <p><code>auto_move_outputs</code> : Activate the automatic identification and move of output files from inputs to outputs file workspace folders</p>"}]},"tags":{"mappings":[],"listings":[],"search_cleanup":false}}},"hash":3762537635198172270}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"data":{"route":{"source":"documentation/key-concepts/source_target.md","destination":"documentation/key-concepts/source_target/index.html","url":"documentation/key-concepts/source_target/"},"markdown":{"meta":{"icon":"lucide/square-arrow-right-enter"},"content":"<h1 id=\"source-target\">Source Target<a class=\"headerlink\" href=\"#source-target\" title=\"Permanent link\">¶</a></h1>\n<h2 id=\"overview\">Overview<a class=\"headerlink\" href=\"#overview\" title=\"Permanent link\">¶</a></h2>\n<div class=\"admonition failure\">\n<p class=\"admonition-title\">TODO</p>\n<p>TODO</p>\n</div>","toc":[{"title":"Source Target","content":"Source Target","id":"source-target","url":"#source-target","children":[{"title":"Overview","content":"Overview","id":"overview","url":"#overview","children":[],"level":2}],"level":1}]},"title":"Source Target","registrations":{"primary":{"source-target":["documentation/key-concepts/source_target/#source-target"],"overview":["documentation/key-concepts/source_target/#overview"]},"secondary":{},"titles":{"documentation/key-concepts/source_target/#overview":"Overview","documentation/key-concepts/source_target/#source-target":"Source Target"}},"html":{"autorefs":{"references":[]},"search":{"sections":[{"location":null,"level":1,"title":"Source Target","text":""},{"location":"overview","level":2,"title":"Overview","text":"<p>TODO</p> <p>TODO</p>"}]},"tags":{"mappings":[],"listings":[],"search_cleanup":false}}},"hash":12725794881231025953}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"data":{"route":{"source":"documentation/api/case_builder/TableConfig.md","destination":"documentation/api/case_builder/TableConfig/index.html","url":"documentation/api/case_builder/TableConfig/"},"markdown":{"meta":{"icon":"lucide/cog"},"content":"<h1 id=\"tableconfig\">TableConfig<a class=\"headerlink\" href=\"#tableconfig\" title=\"Permanent link\">¶</a></h1>\n\n\n<div class=\"doc doc-object doc-class\">\n\n\n\n<a id=\"studpy.cases.TableConfig\"></a>\n <div class=\"doc doc-contents first\">\n <p class=\"doc doc-class-bases\">\n Bases: <code><!-- zensical:autoref:0 --></code></p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-children\">\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.TableConfig.check_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">check_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.TableConfig.check_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>if config has <strong>SOURCE</strong> in attributes, raise ValueError</p>\n\n\n </div>\n\n</div>\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.TableConfig.need_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">need_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.TableConfig.need_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>config has <strong>SOURCE</strong> in attributes</p>\n\n\n </div>\n\n</div>\n\n\n\n </div>\n\n </div>\n\n</div>","toc":[{"title":"TableConfig","content":"TableConfig","id":"tableconfig","url":"#tableconfig","children":[{"title":"TableConfig","content":"TableConfig","id":"studpy.cases.TableConfig","url":"#studpy.cases.TableConfig","children":[],"level":2},{"title":"check_target_source","content":"check_target_source","id":"studpy.cases.TableConfig.check_target_source","url":"#studpy.cases.TableConfig.check_target_source","children":[],"level":2},{"title":"need_target_source","content":"need_target_source","id":"studpy.cases.TableConfig.need_target_source","url":"#studpy.cases.TableConfig.need_target_source","children":[],"level":2}],"level":1}]},"title":"TableConfig","registrations":{"primary":{"studpy.cases.TableConfig.need_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.need_target_source"],"
|
|
1
|
+
{"data":{"route":{"source":"documentation/api/case_builder/TableConfig.md","destination":"documentation/api/case_builder/TableConfig/index.html","url":"documentation/api/case_builder/TableConfig/"},"markdown":{"meta":{"icon":"lucide/cog"},"content":"<h1 id=\"tableconfig\">TableConfig<a class=\"headerlink\" href=\"#tableconfig\" title=\"Permanent link\">¶</a></h1>\n\n\n<div class=\"doc doc-object doc-class\">\n\n\n\n<a id=\"studpy.cases.TableConfig\"></a>\n <div class=\"doc doc-contents first\">\n <p class=\"doc doc-class-bases\">\n Bases: <code><!-- zensical:autoref:0 --></code></p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-children\">\n\n\n\n\n\n\n\n\n\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.TableConfig.check_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">check_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.TableConfig.check_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>if config has <strong>SOURCE</strong> in attributes, raise ValueError</p>\n\n\n </div>\n\n</div>\n\n<div class=\"doc doc-object doc-function\">\n\n\n<h2 id=\"studpy.cases.TableConfig.need_target_source\" class=\"doc doc-heading\">\n <code class=\"highlight language-python\"><span class=\"n\">need_target_source</span><span class=\"p\">()</span></code>\n\n<a href=\"#studpy.cases.TableConfig.need_target_source\" class=\"headerlink\" title=\"Permanent link\">¶</a></h2>\n\n\n <div class=\"doc doc-contents \">\n\n <p>config has <strong>SOURCE</strong> in attributes</p>\n\n\n </div>\n\n</div>\n\n\n\n </div>\n\n </div>\n\n</div>","toc":[{"title":"TableConfig","content":"TableConfig","id":"tableconfig","url":"#tableconfig","children":[{"title":"TableConfig","content":"TableConfig","id":"studpy.cases.TableConfig","url":"#studpy.cases.TableConfig","children":[],"level":2},{"title":"check_target_source","content":"check_target_source","id":"studpy.cases.TableConfig.check_target_source","url":"#studpy.cases.TableConfig.check_target_source","children":[],"level":2},{"title":"need_target_source","content":"need_target_source","id":"studpy.cases.TableConfig.need_target_source","url":"#studpy.cases.TableConfig.need_target_source","children":[],"level":2}],"level":1}]},"title":"TableConfig","registrations":{"primary":{"studpy.cases.TableConfig.need_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.need_target_source"],"tableconfig":["documentation/api/case_builder/TableConfig/#tableconfig"],"studpy.cases.TableConfig":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig"],"studpy.cases.TableConfig.check_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.check_target_source"]},"secondary":{"studpy.cases.param_configs.table_config.TableConfig":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig"],"studpy.cases.param_configs.table_config.TableConfig.need_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.need_target_source"],"studpy.cases.GaussianConfig.check_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.check_target_source"],"studpy.cases.GaussianConfig.need_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.need_target_source"],"studpy.cases.param_configs.table_config.TableConfig.check_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.check_target_source"],"studpy.cases.param_configs.param_config_base.ParamConfigBase.need_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.need_target_source"],"studpy.cases.param_configs.TableConfig":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig"],"studpy.cases.param_configs.gaussian_config.GaussianConfig.check_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.check_target_source"],"studpy.cases.param_configs.gaussian_config.GaussianConfig.need_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.need_target_source"],"studpy.cases.param_configs.param_config_base.ParamConfigBase.check_target_source":["documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.check_target_source"]},"titles":{"documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.need_target_source":"<code class=\"highlight language-python\"><span class=\"n\">need_target_source</span><span class=\"p\">()</span></code>","documentation/api/case_builder/TableConfig/#tableconfig":"TableConfig","documentation/api/case_builder/TableConfig/#studpy.cases.TableConfig.check_target_source":"<code class=\"highlight language-python\"><span class=\"n\">check_target_source</span><span class=\"p\">()</span></code>"}},"html":{"autorefs":{"references":[{"attributes":[{"name":"identifier","value":"studpy.cases.param_configs.param_config_base.ParamConfigBase"},{"name":"backlink-type","value":"subclassed-by"},{"name":"backlink-anchor","value":"studpy.cases.TableConfig"},{"name":"optional","value":""},{"name":"hover","value":""}],"title":"ParamConfigBase"}]},"search":{"sections":[{"location":null,"level":1,"title":"TableConfig","text":"<p> Bases: <code>ParamConfigBase</code></p>"},{"location":"studpy.cases.TableConfig.check_target_source","level":2,"title":"<code>check_target_source()</code>","text":"<p>if config has SOURCE in attributes, raise ValueError</p>"},{"location":"studpy.cases.TableConfig.need_target_source","level":2,"title":"<code>need_target_source()</code>","text":"<p>config has SOURCE in attributes</p>"}]},"tags":{"mappings":[],"listings":[],"search_cleanup":false}}},"hash":7626372675007810581}
|