simstack 2.0.1__py3-none-any.whl
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.
- simstack/__init__.py +0 -0
- simstack/_version.py +24 -0
- simstack/core/__init__.py +0 -0
- simstack/core/artifacts.py +406 -0
- simstack/core/asnyc_helper.py +14 -0
- simstack/core/config_file.py +60 -0
- simstack/core/context.py +283 -0
- simstack/core/definitions.py +22 -0
- simstack/core/engine.py +115 -0
- simstack/core/find_simstack_modules.py +41 -0
- simstack/core/hash.py +179 -0
- simstack/core/node.py +1137 -0
- simstack/core/node_claim.py +31 -0
- simstack/core/node_runner.py +362 -0
- simstack/core/process_results.py +102 -0
- simstack/core/recompute_artifacts.py +117 -0
- simstack/core/reset_db.py +12 -0
- simstack/core/resource_assignment.py +222 -0
- simstack/core/resources.py +90 -0
- simstack/core/route_table.py +24 -0
- simstack/core/run_docker.py +109 -0
- simstack/core/run_node.py +71 -0
- simstack/core/runner.py +169 -0
- simstack/core/services/__init__.py +11 -0
- simstack/core/services/base_service.py +191 -0
- simstack/core/services/file_transfer_service.py +117 -0
- simstack/core/services/git_restart_service.py +12 -0
- simstack/core/services/git_uv_update_service.py +105 -0
- simstack/core/services/node_execution_service.py +182 -0
- simstack/core/services/resource_branch_monitor_service.py +71 -0
- simstack/core/services/runner_cleanup_service.py +149 -0
- simstack/core/services/runner_manager.py +163 -0
- simstack/core/services/runner_status_service.py +10 -0
- simstack/core/services/slurm_status_service.py +67 -0
- simstack/core/services/stop_check_service.py +27 -0
- simstack/core/services/timeout_restart_service.py +26 -0
- simstack/core/simstack_result.py +39 -0
- simstack/core/submit_node.py +217 -0
- simstack/core/task_id.py +22 -0
- simstack/methods/__init__.py +0 -0
- simstack/methods/archive_files.py +292 -0
- simstack/methods/fire_and_forget_runner.py +113 -0
- simstack/methods/generate_test.py +125 -0
- simstack/methods/get_file.py +26 -0
- simstack/methods/mass_runner.py +154 -0
- simstack/methods/multiple_executor.py +307 -0
- simstack/methods/switch_git.py +16 -0
- simstack/methods/upload_helpers.py +81 -0
- simstack/models/__init__.py +74 -0
- simstack/models/array_list.py +21 -0
- simstack/models/array_storage.py +83 -0
- simstack/models/artifact_models.py +127 -0
- simstack/models/base_lists.py +51 -0
- simstack/models/base_types.py +209 -0
- simstack/models/charts_artifact.py +690 -0
- simstack/models/dataset.py +451 -0
- simstack/models/dataset_metadata.py +390 -0
- simstack/models/datasettuple.py +587 -0
- simstack/models/file_instance.py +150 -0
- simstack/models/file_list.py +45 -0
- simstack/models/files.py +424 -0
- simstack/models/fire_and_forget_result.py +19 -0
- simstack/models/images2d.py +113 -0
- simstack/models/log_entry_model.py +37 -0
- simstack/models/models.py +52 -0
- simstack/models/named_data_reference.py +36 -0
- simstack/models/node_registry.py +96 -0
- simstack/models/pandas_model.py +239 -0
- simstack/models/parameters.py +402 -0
- simstack/models/pickle_models.py +300 -0
- simstack/models/project.py +13 -0
- simstack/models/resource_assignment.py +170 -0
- simstack/models/resource_definition.py +125 -0
- simstack/models/runner_model.py +39 -0
- simstack/models/simple_table.py +79 -0
- simstack/models/simstack_model.py +97 -0
- simstack/models/slurm_info.py +17 -0
- simstack/models/table_artifact.py +87 -0
- simstack/models/tag.py +12 -0
- simstack/models/unused_test_file.py +5 -0
- simstack/simstack_marker.com +1 -0
- simstack/static/docs/.buildinfo +4 -0
- simstack/static/docs/_images/GUI Concept.webp +0 -0
- simstack/static/docs/_modules/index.html +434 -0
- simstack/static/docs/_modules/simstack/core/artifacts.html +743 -0
- simstack/static/docs/_modules/simstack/core/asnyc_helper.html +330 -0
- simstack/static/docs/_modules/simstack/core/config_file.html +379 -0
- simstack/static/docs/_modules/simstack/core/definitions.html +341 -0
- simstack/static/docs/_modules/simstack/core/engine.html +437 -0
- simstack/static/docs/_modules/simstack/core/find_simstack_modules.html +360 -0
- simstack/static/docs/_modules/simstack/core/hash.html +528 -0
- simstack/static/docs/_modules/simstack/core/node.html +1392 -0
- simstack/static/docs/_modules/simstack/core/node_claim.html +347 -0
- simstack/static/docs/_modules/simstack/core/node_runner.html +711 -0
- simstack/static/docs/_modules/simstack/core/process_results.html +418 -0
- simstack/static/docs/_modules/simstack/core/recompute_artifacts.html +433 -0
- simstack/static/docs/_modules/simstack/core/reset_db.html +328 -0
- simstack/static/docs/_modules/simstack/core/resource_assignment.html +553 -0
- simstack/static/docs/_modules/simstack/core/resources.html +424 -0
- simstack/static/docs/_modules/simstack/core/route_table.html +349 -0
- simstack/static/docs/_modules/simstack/core/run_docker.html +425 -0
- simstack/static/docs/_modules/simstack/core/run_node.html +390 -0
- simstack/static/docs/_modules/simstack/core/runner.html +491 -0
- simstack/static/docs/_modules/simstack/core/services/base_service.html +522 -0
- simstack/static/docs/_modules/simstack/core/services/file_transfer_service.html +436 -0
- simstack/static/docs/_modules/simstack/core/services/git_restart_service.html +331 -0
- simstack/static/docs/_modules/simstack/core/services/git_uv_update_service.html +427 -0
- simstack/static/docs/_modules/simstack/core/services/node_execution_service.html +507 -0
- simstack/static/docs/_modules/simstack/core/services/resource_branch_monitor_service.html +390 -0
- simstack/static/docs/_modules/simstack/core/services/runner_cleanup_service.html +468 -0
- simstack/static/docs/_modules/simstack/core/services/runner_manager.html +485 -0
- simstack/static/docs/_modules/simstack/core/services/runner_status_service.html +329 -0
- simstack/static/docs/_modules/simstack/core/services/slurm_status_service.html +386 -0
- simstack/static/docs/_modules/simstack/core/services/stop_check_service.html +346 -0
- simstack/static/docs/_modules/simstack/core/services/timeout_restart_service.html +345 -0
- simstack/static/docs/_modules/simstack/core/simstack_result.html +355 -0
- simstack/static/docs/_modules/simstack/core/submit_node.html +536 -0
- simstack/static/docs/_modules/simstack/core/task_id.html +344 -0
- simstack/static/docs/_modules/simstack/methods/archive_files.html +598 -0
- simstack/static/docs/_modules/simstack/methods/fire_and_forget_runner.html +432 -0
- simstack/static/docs/_modules/simstack/methods/generate_test.html +443 -0
- simstack/static/docs/_modules/simstack/methods/get_file.html +342 -0
- simstack/static/docs/_modules/simstack/methods/mass_runner.html +476 -0
- simstack/static/docs/_modules/simstack/methods/multiple_executor.html +674 -0
- simstack/static/docs/_modules/simstack/methods/switch_git.html +332 -0
- simstack/static/docs/_modules/simstack/methods/upload_helpers.html +403 -0
- simstack/static/docs/_modules/simstack/models/array_list.html +337 -0
- simstack/static/docs/_modules/simstack/models/array_storage.html +417 -0
- simstack/static/docs/_modules/simstack/models/base_lists.html +374 -0
- simstack/static/docs/_modules/simstack/models/base_types.html +588 -0
- simstack/static/docs/_modules/simstack/models/charts_artifact.html +1035 -0
- simstack/static/docs/_modules/simstack/models/dataset.html +866 -0
- simstack/static/docs/_modules/simstack/models/dataset_metadata.html +711 -0
- simstack/static/docs/_modules/simstack/models/datasettuple.html +1005 -0
- simstack/static/docs/_modules/simstack/models/file_instance.html +472 -0
- simstack/static/docs/_modules/simstack/models/file_list.html +367 -0
- simstack/static/docs/_modules/simstack/models/files.html +773 -0
- simstack/static/docs/_modules/simstack/models/fire_and_forget_result.html +335 -0
- simstack/static/docs/_modules/simstack/models/images2d.html +447 -0
- simstack/static/docs/_modules/simstack/models/log_entry_model.html +356 -0
- simstack/static/docs/_modules/simstack/models/models.html +374 -0
- simstack/static/docs/_modules/simstack/models/named_data_reference.html +355 -0
- simstack/static/docs/_modules/simstack/models/node_registry.html +415 -0
- simstack/static/docs/_modules/simstack/models/pandas_model.html +570 -0
- simstack/static/docs/_modules/simstack/models/parameters.html +739 -0
- simstack/static/docs/_modules/simstack/models/pickle_models.html +631 -0
- simstack/static/docs/_modules/simstack/models/project.html +329 -0
- simstack/static/docs/_modules/simstack/models/resource_assignment.html +501 -0
- simstack/static/docs/_modules/simstack/models/resource_definition.html +477 -0
- simstack/static/docs/_modules/simstack/models/runner_model.html +361 -0
- simstack/static/docs/_modules/simstack/models/simple_table.html +413 -0
- simstack/static/docs/_modules/simstack/models/simstack_model.html +416 -0
- simstack/static/docs/_modules/simstack/models/slurm_info.html +333 -0
- simstack/static/docs/_modules/simstack/models/table_artifact.html +406 -0
- simstack/static/docs/_modules/simstack/models/tag.html +328 -0
- simstack/static/docs/_modules/simstack/tables/model_table.html +519 -0
- simstack/static/docs/_modules/simstack/tables/node_children.html +538 -0
- simstack/static/docs/_modules/simstack/tables/node_table.html +854 -0
- simstack/static/docs/_modules/simstack/tables/table_builder.html +642 -0
- simstack/static/docs/_modules/simstack/util/async_zip_utils.html +337 -0
- simstack/static/docs/_modules/simstack/util/b64mixin.html +339 -0
- simstack/static/docs/_modules/simstack/util/cleaned_json_schema.html +336 -0
- simstack/static/docs/_modules/simstack/util/config_reader.html +498 -0
- simstack/static/docs/_modules/simstack/util/custom_model_dump.html +391 -0
- simstack/static/docs/_modules/simstack/util/database_information.html +488 -0
- simstack/static/docs/_modules/simstack/util/db.html +1392 -0
- simstack/static/docs/_modules/simstack/util/db_logger.html +448 -0
- simstack/static/docs/_modules/simstack/util/default_from_dict.html +376 -0
- simstack/static/docs/_modules/simstack/util/directory_iterator.html +553 -0
- simstack/static/docs/_modules/simstack/util/docstring_parser.html +526 -0
- simstack/static/docs/_modules/simstack/util/file_hashing.html +394 -0
- simstack/static/docs/_modules/simstack/util/file_transfer_client.html +791 -0
- simstack/static/docs/_modules/simstack/util/files.html +733 -0
- simstack/static/docs/_modules/simstack/util/find_python_files.html +349 -0
- simstack/static/docs/_modules/simstack/util/generate_ui_schema.html +396 -0
- simstack/static/docs/_modules/simstack/util/generic_list_mixin.html +487 -0
- simstack/static/docs/_modules/simstack/util/get_module_path.html +336 -0
- simstack/static/docs/_modules/simstack/util/git_pull.html +381 -0
- simstack/static/docs/_modules/simstack/util/git_repository_status.html +411 -0
- simstack/static/docs/_modules/simstack/util/import_module.html +377 -0
- simstack/static/docs/_modules/simstack/util/importer.html +637 -0
- simstack/static/docs/_modules/simstack/util/init_data_source.html +357 -0
- simstack/static/docs/_modules/simstack/util/make_graph.html +423 -0
- simstack/static/docs/_modules/simstack/util/make_table.html +1171 -0
- simstack/static/docs/_modules/simstack/util/mappings.html +378 -0
- simstack/static/docs/_modules/simstack/util/minimal_route_finder.html +388 -0
- simstack/static/docs/_modules/simstack/util/mock_db.html +472 -0
- simstack/static/docs/_modules/simstack/util/module_path_checker.html +354 -0
- simstack/static/docs/_modules/simstack/util/object_list_mixin.html +649 -0
- simstack/static/docs/_modules/simstack/util/path_manager.html +566 -0
- simstack/static/docs/_modules/simstack/util/project_root_finder.html +357 -0
- simstack/static/docs/_modules/simstack/util/queue_watcher.html +593 -0
- simstack/static/docs/_modules/simstack/util/resource_config.html +532 -0
- simstack/static/docs/_modules/simstack/util/route_finder.html +390 -0
- simstack/static/docs/_modules/simstack/util/runner_util.html +487 -0
- simstack/static/docs/_modules/simstack/util/runner_utils.html +468 -0
- simstack/static/docs/_modules/simstack/util/safe_code_executor.html +510 -0
- simstack/static/docs/_modules/simstack/util/sample_config.html +414 -0
- simstack/static/docs/_modules/simstack/util/sensitive_content_filter.html +364 -0
- simstack/static/docs/_modules/simstack/util/setup_logging.html +365 -0
- simstack/static/docs/_modules/simstack/util/submit_to_watchdog.html +425 -0
- simstack/static/docs/_modules/simstack/util/toml_reader.html +482 -0
- simstack/static/docs/_modules/simstack/util/transform_file_name.html +357 -0
- simstack/static/docs/_modules/simstack/util/ui_tools.html +541 -0
- simstack/static/docs/_sources/architecture.rst.txt +25 -0
- simstack/static/docs/_sources/array_lists.rst.txt +60 -0
- simstack/static/docs/_sources/ci_pipeline.rst.txt +34 -0
- simstack/static/docs/_sources/data.rst.txt +175 -0
- simstack/static/docs/_sources/database_migrations.rst.txt +310 -0
- simstack/static/docs/_sources/datasets.rst.txt +93 -0
- simstack/static/docs/_sources/developer_guide.rst.txt +25 -0
- simstack/static/docs/_sources/docker_nodes.rst.txt +149 -0
- simstack/static/docs/_sources/files.rst.txt +159 -0
- simstack/static/docs/_sources/fire_and_forget_runner.rst.txt +67 -0
- simstack/static/docs/_sources/index.rst.txt +25 -0
- simstack/static/docs/_sources/installation.rst.txt +213 -0
- simstack/static/docs/_sources/lists.rst.txt +111 -0
- simstack/static/docs/_sources/mass_runner.rst.txt +91 -0
- simstack/static/docs/_sources/misc.rst.txt +106 -0
- simstack/static/docs/_sources/overview.rst.txt +91 -0
- simstack/static/docs/_sources/recovery.rst.txt +38 -0
- simstack/static/docs/_sources/resource_config.rst.txt +141 -0
- simstack/static/docs/_sources/simstack/modules/modules.rst.txt +7 -0
- simstack/static/docs/_sources/simstack/modules/simstack.core.rst.txt +205 -0
- simstack/static/docs/_sources/simstack/modules/simstack.core.services.rst.txt +109 -0
- simstack/static/docs/_sources/simstack/modules/simstack.methods.rst.txt +77 -0
- simstack/static/docs/_sources/simstack/modules/simstack.models.rst.txt +261 -0
- simstack/static/docs/_sources/simstack/modules/simstack.rst.txt +22 -0
- simstack/static/docs/_sources/simstack/modules/simstack.tables.rst.txt +45 -0
- simstack/static/docs/_sources/simstack/modules/simstack.util.rst.txt +381 -0
- simstack/static/docs/_sources/submit.rst.txt +141 -0
- simstack/static/docs/_sources/tables.rst.txt +50 -0
- simstack/static/docs/_sources/testing_complex_nodes.rst.txt +92 -0
- simstack/static/docs/_sources/ui_documentation.rst.txt +272 -0
- simstack/static/docs/_sources/workflows.rst.txt +446 -0
- simstack/static/docs/_static/base-stemmer.js +476 -0
- simstack/static/docs/_static/basic.css +906 -0
- simstack/static/docs/_static/cobalt2-theme.css +1 -0
- simstack/static/docs/_static/debug.css +69 -0
- simstack/static/docs/_static/docs-build-badge.css +51 -0
- simstack/static/docs/_static/docs-build-badge.js +51 -0
- simstack/static/docs/_static/doctools.js +150 -0
- simstack/static/docs/_static/documentation_options.js +13 -0
- simstack/static/docs/_static/english-stemmer.js +1066 -0
- simstack/static/docs/_static/file.png +0 -0
- simstack/static/docs/_static/language_data.js +13 -0
- simstack/static/docs/_static/minus.png +0 -0
- simstack/static/docs/_static/plus.png +0 -0
- simstack/static/docs/_static/pygments.css +250 -0
- simstack/static/docs/_static/scripts/furo-extensions.js +0 -0
- simstack/static/docs/_static/scripts/furo.js +3 -0
- simstack/static/docs/_static/scripts/furo.js.LICENSE.txt +7 -0
- simstack/static/docs/_static/scripts/furo.js.map +1 -0
- simstack/static/docs/_static/searchtools.js +693 -0
- simstack/static/docs/_static/skeleton.css +296 -0
- simstack/static/docs/_static/sphinx_highlight.js +159 -0
- simstack/static/docs/_static/styles/furo-extensions.css +2 -0
- simstack/static/docs/_static/styles/furo-extensions.css.map +1 -0
- simstack/static/docs/_static/styles/furo.css +2 -0
- simstack/static/docs/_static/styles/furo.css.map +1 -0
- simstack/static/docs/architecture.html +340 -0
- simstack/static/docs/array_lists.html +678 -0
- simstack/static/docs/ci_pipeline.html +385 -0
- simstack/static/docs/data.html +545 -0
- simstack/static/docs/database_migrations.html +652 -0
- simstack/static/docs/datasets.html +1268 -0
- simstack/static/docs/developer_guide.html +359 -0
- simstack/static/docs/docker_nodes.html +503 -0
- simstack/static/docs/files.html +718 -0
- simstack/static/docs/fire_and_forget_runner.html +641 -0
- simstack/static/docs/genindex.html +6390 -0
- simstack/static/docs/index.html +516 -0
- simstack/static/docs/installation.html +553 -0
- simstack/static/docs/lists.html +478 -0
- simstack/static/docs/mass_runner.html +481 -0
- simstack/static/docs/misc.html +454 -0
- simstack/static/docs/objects.inv +0 -0
- simstack/static/docs/overview.html +469 -0
- simstack/static/docs/py-modindex.html +1111 -0
- simstack/static/docs/recovery.html +371 -0
- simstack/static/docs/resource_config.html +590 -0
- simstack/static/docs/search.html +327 -0
- simstack/static/docs/searchindex.js +1 -0
- simstack/static/docs/simstack/modules/modules.html +489 -0
- simstack/static/docs/simstack/modules/simstack.core.html +1883 -0
- simstack/static/docs/simstack/modules/simstack.core.services.html +698 -0
- simstack/static/docs/simstack/modules/simstack.html +3060 -0
- simstack/static/docs/simstack/modules/simstack.methods.html +1150 -0
- simstack/static/docs/simstack/modules/simstack.models.html +13113 -0
- simstack/static/docs/simstack/modules/simstack.tables.html +635 -0
- simstack/static/docs/simstack/modules/simstack.util.html +3320 -0
- simstack/static/docs/submit.html +487 -0
- simstack/static/docs/tables.html +539 -0
- simstack/static/docs/testing_complex_nodes.html +458 -0
- simstack/static/docs/ui_documentation.html +788 -0
- simstack/static/docs/workflows.html +766 -0
- simstack/tables/__init__.py +0 -0
- simstack/tables/model_table.py +191 -0
- simstack/tables/node_children.py +219 -0
- simstack/tables/node_table.py +517 -0
- simstack/tables/table_builder.py +314 -0
- simstack/util/__init__.py +0 -0
- simstack/util/async_zip_utils.py +18 -0
- simstack/util/b64mixin.py +23 -0
- simstack/util/cleaned_json_schema.py +20 -0
- simstack/util/config_reader.py +179 -0
- simstack/util/custom_model_dump.py +75 -0
- simstack/util/database_information.py +160 -0
- simstack/util/db.py +1013 -0
- simstack/util/db_logger.py +117 -0
- simstack/util/default_from_dict.py +57 -0
- simstack/util/directory_iterator.py +216 -0
- simstack/util/docstring_parser.py +186 -0
- simstack/util/file_hashing.py +72 -0
- simstack/util/file_transfer_client.py +427 -0
- simstack/util/files.py +396 -0
- simstack/util/find_python_files.py +33 -0
- simstack/util/generate_ui_schema.py +80 -0
- simstack/util/generic_list_mixin.py +120 -0
- simstack/util/geometry_utils.py +118 -0
- simstack/util/get_module_path.py +20 -0
- simstack/util/git_pull.py +65 -0
- simstack/util/git_repository_status.py +95 -0
- simstack/util/import_module.py +63 -0
- simstack/util/importer.py +312 -0
- simstack/util/init_data_source.py +41 -0
- simstack/util/make_graph.py +107 -0
- simstack/util/make_table.py +837 -0
- simstack/util/mappings.py +41 -0
- simstack/util/minimal_route_finder.py +72 -0
- simstack/util/mock_db.py +144 -0
- simstack/util/module_path_checker.py +38 -0
- simstack/util/object_list_mixin.py +282 -0
- simstack/util/path_manager.py +223 -0
- simstack/util/project_root_finder.py +41 -0
- simstack/util/queue_watcher.py +262 -0
- simstack/util/resource_config.py +198 -0
- simstack/util/route_finder.py +74 -0
- simstack/util/runner_util.py +166 -0
- simstack/util/runner_utils.py +143 -0
- simstack/util/safe_code_executor.py +194 -0
- simstack/util/sample_config.py +98 -0
- simstack/util/sensitive_content_filter.py +48 -0
- simstack/util/setup_logging.py +49 -0
- simstack/util/submit_to_watchdog.py +106 -0
- simstack/util/toml_reader.py +142 -0
- simstack/util/transform_file_name.py +41 -0
- simstack/util/ui_tools.py +213 -0
- simstack-2.0.1.dist-info/METADATA +454 -0
- simstack-2.0.1.dist-info/RECORD +354 -0
- simstack-2.0.1.dist-info/WHEEL +5 -0
- simstack-2.0.1.dist-info/entry_points.txt +12 -0
- simstack-2.0.1.dist-info/licenses/LICENSE +21 -0
- simstack-2.0.1.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,1883 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="no-js" lang="en" data-content_root="../../">
|
|
3
|
+
<head><meta charset="utf-8">
|
|
4
|
+
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
5
|
+
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
6
|
+
<link rel="index" title="Index" href="../../genindex.html"><link rel="search" title="Search" href="../../search.html"><link rel="next" title="simstack.core.services package" href="simstack.core.services.html"><link rel="prev" title="simstack package" href="simstack.html">
|
|
7
|
+
|
|
8
|
+
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
|
9
|
+
<title>simstack.core package - SimStack II documentation</title>
|
|
10
|
+
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=d111a655" />
|
|
11
|
+
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=7bdb33bb" />
|
|
12
|
+
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
|
13
|
+
<link rel="stylesheet" type="text/css" href="../../_static/cobalt2-theme.css?v=2d651046" />
|
|
14
|
+
<link rel="stylesheet" type="text/css" href="../../_static/docs-build-badge.css?v=803faff8" />
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
<style>
|
|
20
|
+
body {
|
|
21
|
+
--color-code-background: #f2f2f2;
|
|
22
|
+
--color-code-foreground: #1e1e1e;
|
|
23
|
+
|
|
24
|
+
}
|
|
25
|
+
@media not print {
|
|
26
|
+
body[data-theme="dark"] {
|
|
27
|
+
--color-code-background: #202020;
|
|
28
|
+
--color-code-foreground: #d0d0d0;
|
|
29
|
+
--color-background-primary: #132738;
|
|
30
|
+
--color-background-secondary: #1e3a52;
|
|
31
|
+
--color-foreground-primary: #ffffff;
|
|
32
|
+
--color-foreground-secondary: #bac8d3;
|
|
33
|
+
--color-brand-primary: #22d5ff;
|
|
34
|
+
--color-brand-content: #0088ff;
|
|
35
|
+
|
|
36
|
+
}
|
|
37
|
+
@media (prefers-color-scheme: dark) {
|
|
38
|
+
body:not([data-theme="light"]) {
|
|
39
|
+
--color-code-background: #202020;
|
|
40
|
+
--color-code-foreground: #d0d0d0;
|
|
41
|
+
--color-background-primary: #132738;
|
|
42
|
+
--color-background-secondary: #1e3a52;
|
|
43
|
+
--color-foreground-primary: #ffffff;
|
|
44
|
+
--color-foreground-secondary: #bac8d3;
|
|
45
|
+
--color-brand-primary: #22d5ff;
|
|
46
|
+
--color-brand-content: #0088ff;
|
|
47
|
+
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
</style></head>
|
|
52
|
+
<body>
|
|
53
|
+
|
|
54
|
+
<script>
|
|
55
|
+
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
|
56
|
+
</script>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
60
|
+
<symbol id="svg-toc" viewBox="0 0 24 24">
|
|
61
|
+
<title>Contents</title>
|
|
62
|
+
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
|
63
|
+
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
|
64
|
+
</svg>
|
|
65
|
+
</symbol>
|
|
66
|
+
<symbol id="svg-menu" viewBox="0 0 24 24">
|
|
67
|
+
<title>Menu</title>
|
|
68
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
69
|
+
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
|
70
|
+
<line x1="3" y1="12" x2="21" y2="12"></line>
|
|
71
|
+
<line x1="3" y1="6" x2="21" y2="6"></line>
|
|
72
|
+
<line x1="3" y1="18" x2="21" y2="18"></line>
|
|
73
|
+
</svg>
|
|
74
|
+
</symbol>
|
|
75
|
+
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
|
76
|
+
<title>Expand</title>
|
|
77
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
78
|
+
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
|
79
|
+
<polyline points="9 18 15 12 9 6"></polyline>
|
|
80
|
+
</svg>
|
|
81
|
+
</symbol>
|
|
82
|
+
<symbol id="svg-sun" viewBox="0 0 24 24">
|
|
83
|
+
<title>Light mode</title>
|
|
84
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
85
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
|
86
|
+
<circle cx="12" cy="12" r="5"></circle>
|
|
87
|
+
<line x1="12" y1="1" x2="12" y2="3"></line>
|
|
88
|
+
<line x1="12" y1="21" x2="12" y2="23"></line>
|
|
89
|
+
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
|
90
|
+
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
|
91
|
+
<line x1="1" y1="12" x2="3" y2="12"></line>
|
|
92
|
+
<line x1="21" y1="12" x2="23" y2="12"></line>
|
|
93
|
+
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
|
94
|
+
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
|
95
|
+
</svg>
|
|
96
|
+
</symbol>
|
|
97
|
+
<symbol id="svg-moon" viewBox="0 0 24 24">
|
|
98
|
+
<title>Dark mode</title>
|
|
99
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
100
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
|
101
|
+
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
102
|
+
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
|
103
|
+
</svg>
|
|
104
|
+
</symbol>
|
|
105
|
+
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
|
106
|
+
<title>Auto light/dark, in light mode</title>
|
|
107
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
108
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
|
109
|
+
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
|
110
|
+
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
|
111
|
+
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
|
112
|
+
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
|
113
|
+
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
|
114
|
+
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
|
115
|
+
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
|
116
|
+
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
|
117
|
+
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
|
118
|
+
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
|
119
|
+
<circle cx="14.5" cy="9.55" r="3.6"/>
|
|
120
|
+
</svg>
|
|
121
|
+
</symbol>
|
|
122
|
+
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
|
123
|
+
<title>Auto light/dark, in dark mode</title>
|
|
124
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
125
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
|
126
|
+
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
|
127
|
+
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
|
128
|
+
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
|
129
|
+
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
|
130
|
+
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
|
131
|
+
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
|
132
|
+
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
|
133
|
+
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
|
134
|
+
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
|
135
|
+
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
|
136
|
+
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
|
137
|
+
</svg>
|
|
138
|
+
</symbol>
|
|
139
|
+
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
|
140
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
141
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
|
142
|
+
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
|
143
|
+
<path d="M13.5 6.5l4 4" />
|
|
144
|
+
<path d="M20 21l2 -2l-2 -2" />
|
|
145
|
+
<path d="M17 17l-2 2l2 2" />
|
|
146
|
+
</svg>
|
|
147
|
+
</symbol>
|
|
148
|
+
<symbol id="svg-eye" viewBox="0 0 24 24">
|
|
149
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
150
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
|
151
|
+
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
152
|
+
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
|
153
|
+
<path
|
|
154
|
+
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
|
155
|
+
<path d="M20 21l2 -2l-2 -2" />
|
|
156
|
+
<path d="M17 17l-2 2l2 2" />
|
|
157
|
+
</svg>
|
|
158
|
+
</symbol>
|
|
159
|
+
</svg>
|
|
160
|
+
|
|
161
|
+
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
|
162
|
+
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
|
163
|
+
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
|
164
|
+
<label class="overlay toc-overlay" for="__toc"></label>
|
|
165
|
+
|
|
166
|
+
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<div class="page">
|
|
171
|
+
<header class="mobile-header">
|
|
172
|
+
<div class="header-left">
|
|
173
|
+
<label class="nav-overlay-icon" for="__navigation">
|
|
174
|
+
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
|
175
|
+
</label>
|
|
176
|
+
</div>
|
|
177
|
+
<div class="header-center">
|
|
178
|
+
<a href="../../index.html"><div class="brand">SimStack II documentation</div></a>
|
|
179
|
+
</div>
|
|
180
|
+
<div class="header-right">
|
|
181
|
+
<div class="theme-toggle-container theme-toggle-header">
|
|
182
|
+
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
|
183
|
+
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
184
|
+
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
185
|
+
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
186
|
+
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
187
|
+
</button>
|
|
188
|
+
</div>
|
|
189
|
+
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
|
190
|
+
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
|
191
|
+
</label>
|
|
192
|
+
</div>
|
|
193
|
+
</header>
|
|
194
|
+
<aside class="sidebar-drawer">
|
|
195
|
+
<div class="sidebar-container">
|
|
196
|
+
|
|
197
|
+
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
|
|
201
|
+
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
|
202
|
+
<input type="hidden" name="check_keywords" value="yes">
|
|
203
|
+
<input type="hidden" name="area" value="default">
|
|
204
|
+
</form>
|
|
205
|
+
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
|
206
|
+
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
207
|
+
<ul class="current">
|
|
208
|
+
<li class="toctree-l1"><a class="reference internal" href="../../overview.html">Overview</a></li>
|
|
209
|
+
<li class="toctree-l1"><a class="reference internal" href="../../workflows.html">Workflows</a></li>
|
|
210
|
+
<li class="toctree-l1"><a class="reference internal" href="../../ui_documentation.html">Graphical User Interface</a></li>
|
|
211
|
+
<li class="toctree-l1 has-children"><a class="reference internal" href="../../developer_guide.html">Developer Guide</a><input aria-label="Toggle navigation of Developer Guide" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
|
212
|
+
<li class="toctree-l2"><a class="reference internal" href="../../data.html">Persisting and Visualizing Data</a></li>
|
|
213
|
+
<li class="toctree-l2"><a class="reference internal" href="../../datasets.html">Datasets</a></li>
|
|
214
|
+
<li class="toctree-l2"><a class="reference internal" href="../../lists.html">List Mixins</a></li>
|
|
215
|
+
<li class="toctree-l2"><a class="reference internal" href="../../array_lists.html">Array Lists</a></li>
|
|
216
|
+
<li class="toctree-l2"><a class="reference internal" href="../../tables.html">Tables</a></li>
|
|
217
|
+
<li class="toctree-l2"><a class="reference internal" href="../../files.html">File Management</a></li>
|
|
218
|
+
<li class="toctree-l2"><a class="reference internal" href="../../resource_config.html">Program Execution</a></li>
|
|
219
|
+
<li class="toctree-l2"><a class="reference internal" href="../../mass_runner.html">MassRunner</a></li>
|
|
220
|
+
<li class="toctree-l2"><a class="reference internal" href="../../fire_and_forget_runner.html">FireAndForgetRunner</a></li>
|
|
221
|
+
<li class="toctree-l2"><a class="reference internal" href="../../docker_nodes.html">Creating Docker Containers for SimStack Nodes</a></li>
|
|
222
|
+
<li class="toctree-l2"><a class="reference internal" href="../../testing_complex_nodes.html">Testing Complex Nodes</a></li>
|
|
223
|
+
<li class="toctree-l2"><a class="reference internal" href="../../database_migrations.html">Database Migrations</a></li>
|
|
224
|
+
<li class="toctree-l2"><a class="reference internal" href="../../ci_pipeline.html">CI Pipeline and Documentation Artifacts</a></li>
|
|
225
|
+
<li class="toctree-l2"><a class="reference internal" href="../../misc.html">Miscellaneous</a></li>
|
|
226
|
+
</ul>
|
|
227
|
+
</li>
|
|
228
|
+
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Simstack II Setup</a></li>
|
|
229
|
+
<li class="toctree-l1 current has-children"><a class="reference internal" href="modules.html">simstack</a><input aria-label="Toggle navigation of simstack" checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul class="current">
|
|
230
|
+
<li class="toctree-l2 current has-children"><a class="reference internal" href="simstack.html">simstack package</a><input aria-label="Toggle navigation of simstack package" checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul class="current">
|
|
231
|
+
<li class="toctree-l3 current has-children current-page"><a class="current reference internal" href="#">simstack.core package</a><input aria-label="Toggle navigation of simstack.core package" checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
|
232
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html">simstack.core.services package</a></li>
|
|
233
|
+
</ul>
|
|
234
|
+
</li>
|
|
235
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.methods.html">simstack.methods package</a></li>
|
|
236
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.models.html">simstack.models package</a></li>
|
|
237
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.tables.html">simstack.tables package</a></li>
|
|
238
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.util.html">simstack.util package</a></li>
|
|
239
|
+
</ul>
|
|
240
|
+
</li>
|
|
241
|
+
</ul>
|
|
242
|
+
</li>
|
|
243
|
+
</ul>
|
|
244
|
+
|
|
245
|
+
</div>
|
|
246
|
+
</div>
|
|
247
|
+
|
|
248
|
+
</div>
|
|
249
|
+
|
|
250
|
+
</div>
|
|
251
|
+
</aside>
|
|
252
|
+
<div class="main">
|
|
253
|
+
<div class="content">
|
|
254
|
+
<div class="article-container">
|
|
255
|
+
<a href="#" class="back-to-top muted-link">
|
|
256
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
|
257
|
+
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
|
258
|
+
</svg>
|
|
259
|
+
<span>Back to top</span>
|
|
260
|
+
</a>
|
|
261
|
+
<div class="content-icon-container">
|
|
262
|
+
<div class="view-this-page">
|
|
263
|
+
<a class="muted-link" href="../../_sources/simstack/modules/simstack.core.rst.txt" title="View this page">
|
|
264
|
+
<svg><use href="#svg-eye"></use></svg>
|
|
265
|
+
<span class="visually-hidden">View this page</span>
|
|
266
|
+
</a>
|
|
267
|
+
</div>
|
|
268
|
+
<div class="theme-toggle-container theme-toggle-content">
|
|
269
|
+
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
|
270
|
+
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
271
|
+
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
272
|
+
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
273
|
+
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
274
|
+
</button>
|
|
275
|
+
</div>
|
|
276
|
+
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
|
277
|
+
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
|
278
|
+
</label>
|
|
279
|
+
</div>
|
|
280
|
+
<article role="main" id="furo-main-content">
|
|
281
|
+
<section id="simstack-core-package">
|
|
282
|
+
<h1>simstack.core package<a class="headerlink" href="#simstack-core-package" title="Link to this heading">¶</a></h1>
|
|
283
|
+
<section id="subpackages">
|
|
284
|
+
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading">¶</a></h2>
|
|
285
|
+
<div class="toctree-wrapper compound">
|
|
286
|
+
<ul>
|
|
287
|
+
<li class="toctree-l1"><a class="reference internal" href="simstack.core.services.html">simstack.core.services package</a><ul>
|
|
288
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#submodules">Submodules</a></li>
|
|
289
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.base_service">simstack.core.services.base_service module</a><ul>
|
|
290
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.base_service.BaseService"><code class="docutils literal notranslate"><span class="pre">BaseService</span></code></a><ul>
|
|
291
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.base_service.BaseService.execute"><code class="docutils literal notranslate"><span class="pre">BaseService.execute()</span></code></a></li>
|
|
292
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.base_service.BaseService.start"><code class="docutils literal notranslate"><span class="pre">BaseService.start()</span></code></a></li>
|
|
293
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.base_service.BaseService.stop"><code class="docutils literal notranslate"><span class="pre">BaseService.stop()</span></code></a></li>
|
|
294
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.base_service.BaseService.write_node_event"><code class="docutils literal notranslate"><span class="pre">BaseService.write_node_event()</span></code></a></li>
|
|
295
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.base_service.BaseService.write_resource_event"><code class="docutils literal notranslate"><span class="pre">BaseService.write_resource_event()</span></code></a></li>
|
|
296
|
+
</ul>
|
|
297
|
+
</li>
|
|
298
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.base_service.RestartService"><code class="docutils literal notranslate"><span class="pre">RestartService</span></code></a><ul>
|
|
299
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.base_service.RestartService.trigger_restart"><code class="docutils literal notranslate"><span class="pre">RestartService.trigger_restart()</span></code></a></li>
|
|
300
|
+
</ul>
|
|
301
|
+
</li>
|
|
302
|
+
</ul>
|
|
303
|
+
</li>
|
|
304
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.file_transfer_service">simstack.core.services.file_transfer_service module</a><ul>
|
|
305
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.file_transfer_service.FileTransferService"><code class="docutils literal notranslate"><span class="pre">FileTransferService</span></code></a><ul>
|
|
306
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.file_transfer_service.FileTransferService.execute"><code class="docutils literal notranslate"><span class="pre">FileTransferService.execute()</span></code></a></li>
|
|
307
|
+
</ul>
|
|
308
|
+
</li>
|
|
309
|
+
</ul>
|
|
310
|
+
</li>
|
|
311
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.git_restart_service">simstack.core.services.git_restart_service module</a><ul>
|
|
312
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.git_restart_service.GitRestartService"><code class="docutils literal notranslate"><span class="pre">GitRestartService</span></code></a><ul>
|
|
313
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.git_restart_service.GitRestartService.execute"><code class="docutils literal notranslate"><span class="pre">GitRestartService.execute()</span></code></a></li>
|
|
314
|
+
</ul>
|
|
315
|
+
</li>
|
|
316
|
+
</ul>
|
|
317
|
+
</li>
|
|
318
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.git_uv_update_service">simstack.core.services.git_uv_update_service module</a><ul>
|
|
319
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.git_uv_update_service.GitUvUpdateService"><code class="docutils literal notranslate"><span class="pre">GitUvUpdateService</span></code></a><ul>
|
|
320
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.git_uv_update_service.GitUvUpdateService.execute"><code class="docutils literal notranslate"><span class="pre">GitUvUpdateService.execute()</span></code></a></li>
|
|
321
|
+
</ul>
|
|
322
|
+
</li>
|
|
323
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.git_uv_update_service.get_file_checksum"><code class="docutils literal notranslate"><span class="pre">get_file_checksum()</span></code></a></li>
|
|
324
|
+
</ul>
|
|
325
|
+
</li>
|
|
326
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.node_execution_service">simstack.core.services.node_execution_service module</a><ul>
|
|
327
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.node_execution_service.NodeExecutionService"><code class="docutils literal notranslate"><span class="pre">NodeExecutionService</span></code></a><ul>
|
|
328
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.node_execution_service.NodeExecutionService.execute"><code class="docutils literal notranslate"><span class="pre">NodeExecutionService.execute()</span></code></a></li>
|
|
329
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.node_execution_service.NodeExecutionService.run_node"><code class="docutils literal notranslate"><span class="pre">NodeExecutionService.run_node()</span></code></a></li>
|
|
330
|
+
</ul>
|
|
331
|
+
</li>
|
|
332
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.node_execution_service.run_node_from_registry"><code class="docutils literal notranslate"><span class="pre">run_node_from_registry()</span></code></a></li>
|
|
333
|
+
</ul>
|
|
334
|
+
</li>
|
|
335
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.resource_branch_monitor_service">simstack.core.services.resource_branch_monitor_service module</a><ul>
|
|
336
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.resource_branch_monitor_service.ResourceBranchMonitorService"><code class="docutils literal notranslate"><span class="pre">ResourceBranchMonitorService</span></code></a><ul>
|
|
337
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.resource_branch_monitor_service.ResourceBranchMonitorService.execute"><code class="docutils literal notranslate"><span class="pre">ResourceBranchMonitorService.execute()</span></code></a></li>
|
|
338
|
+
</ul>
|
|
339
|
+
</li>
|
|
340
|
+
</ul>
|
|
341
|
+
</li>
|
|
342
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.runner_cleanup_service">simstack.core.services.runner_cleanup_service module</a><ul>
|
|
343
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.runner_cleanup_service.RunnerCleanupService"><code class="docutils literal notranslate"><span class="pre">RunnerCleanupService</span></code></a><ul>
|
|
344
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.runner_cleanup_service.RunnerCleanupService.execute"><code class="docutils literal notranslate"><span class="pre">RunnerCleanupService.execute()</span></code></a></li>
|
|
345
|
+
</ul>
|
|
346
|
+
</li>
|
|
347
|
+
</ul>
|
|
348
|
+
</li>
|
|
349
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.runner_manager">simstack.core.services.runner_manager module</a><ul>
|
|
350
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.runner_manager.RunnerManager"><code class="docutils literal notranslate"><span class="pre">RunnerManager</span></code></a><ul>
|
|
351
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.runner_manager.RunnerManager.run_nodes_for_resource"><code class="docutils literal notranslate"><span class="pre">RunnerManager.run_nodes_for_resource()</span></code></a></li>
|
|
352
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.runner_manager.RunnerManager.stop_all_services"><code class="docutils literal notranslate"><span class="pre">RunnerManager.stop_all_services()</span></code></a></li>
|
|
353
|
+
</ul>
|
|
354
|
+
</li>
|
|
355
|
+
</ul>
|
|
356
|
+
</li>
|
|
357
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.runner_status_service">simstack.core.services.runner_status_service module</a><ul>
|
|
358
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.runner_status_service.RunnerStatusService"><code class="docutils literal notranslate"><span class="pre">RunnerStatusService</span></code></a><ul>
|
|
359
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.runner_status_service.RunnerStatusService.execute"><code class="docutils literal notranslate"><span class="pre">RunnerStatusService.execute()</span></code></a></li>
|
|
360
|
+
</ul>
|
|
361
|
+
</li>
|
|
362
|
+
</ul>
|
|
363
|
+
</li>
|
|
364
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.slurm_status_service">simstack.core.services.slurm_status_service module</a><ul>
|
|
365
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.slurm_status_service.SlurmStatusService"><code class="docutils literal notranslate"><span class="pre">SlurmStatusService</span></code></a><ul>
|
|
366
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.slurm_status_service.SlurmStatusService.execute"><code class="docutils literal notranslate"><span class="pre">SlurmStatusService.execute()</span></code></a></li>
|
|
367
|
+
</ul>
|
|
368
|
+
</li>
|
|
369
|
+
</ul>
|
|
370
|
+
</li>
|
|
371
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.stop_check_service">simstack.core.services.stop_check_service module</a><ul>
|
|
372
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.stop_check_service.StopCheckService"><code class="docutils literal notranslate"><span class="pre">StopCheckService</span></code></a><ul>
|
|
373
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.stop_check_service.StopCheckService.execute"><code class="docutils literal notranslate"><span class="pre">StopCheckService.execute()</span></code></a></li>
|
|
374
|
+
</ul>
|
|
375
|
+
</li>
|
|
376
|
+
</ul>
|
|
377
|
+
</li>
|
|
378
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services.timeout_restart_service">simstack.core.services.timeout_restart_service module</a><ul>
|
|
379
|
+
<li class="toctree-l3"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.timeout_restart_service.TimeoutRestartService"><code class="docutils literal notranslate"><span class="pre">TimeoutRestartService</span></code></a><ul>
|
|
380
|
+
<li class="toctree-l4"><a class="reference internal" href="simstack.core.services.html#simstack.core.services.timeout_restart_service.TimeoutRestartService.execute"><code class="docutils literal notranslate"><span class="pre">TimeoutRestartService.execute()</span></code></a></li>
|
|
381
|
+
</ul>
|
|
382
|
+
</li>
|
|
383
|
+
</ul>
|
|
384
|
+
</li>
|
|
385
|
+
<li class="toctree-l2"><a class="reference internal" href="simstack.core.services.html#module-simstack.core.services">Module contents</a></li>
|
|
386
|
+
</ul>
|
|
387
|
+
</li>
|
|
388
|
+
</ul>
|
|
389
|
+
</div>
|
|
390
|
+
</section>
|
|
391
|
+
<section id="submodules">
|
|
392
|
+
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
|
|
393
|
+
</section>
|
|
394
|
+
<section id="module-simstack.core.artifacts">
|
|
395
|
+
<span id="simstack-core-artifacts-module"></span><h2>simstack.core.artifacts module<a class="headerlink" href="#module-simstack.core.artifacts" title="Link to this heading">¶</a></h2>
|
|
396
|
+
<dl class="py class">
|
|
397
|
+
<dt class="sig sig-object py" id="simstack.core.artifacts.ArtifactArguments">
|
|
398
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.artifacts.</span></span><span class="sig-name descname"><span class="pre">ArtifactArguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ObjectId</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/artifacts.html#ArtifactArguments"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.artifacts.ArtifactArguments" title="Link to this definition">¶</a></dt>
|
|
399
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
400
|
+
<dl class="py method">
|
|
401
|
+
<dt class="sig sig-object py" id="simstack.core.artifacts.ArtifactArguments.add_attributes">
|
|
402
|
+
<span class="sig-name descname"><span class="pre">add_attributes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/artifacts.html#ArtifactArguments.add_attributes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.artifacts.ArtifactArguments.add_attributes" title="Link to this definition">¶</a></dt>
|
|
403
|
+
<dd></dd></dl>
|
|
404
|
+
|
|
405
|
+
</dd></dl>
|
|
406
|
+
|
|
407
|
+
<dl class="py function">
|
|
408
|
+
<dt class="sig sig-object py" id="simstack.core.artifacts.create_artifacts">
|
|
409
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.artifacts.</span></span><span class="sig-name descname"><span class="pre">create_artifacts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">artifact_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#simstack.core.artifacts.ArtifactArguments" title="simstack.core.artifacts.ArtifactArguments"><span class="pre">ArtifactArguments</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">node_registry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><span class="pre">NodeRegistry</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">ObjectId</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/simstack/core/artifacts.html#create_artifacts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.artifacts.create_artifacts" title="Link to this definition">¶</a></dt>
|
|
410
|
+
<dd></dd></dl>
|
|
411
|
+
|
|
412
|
+
<dl class="py function">
|
|
413
|
+
<dt class="sig sig-object py" id="simstack.core.artifacts.find_all_artifacts">
|
|
414
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.artifacts.</span></span><span class="sig-name descname"><span class="pre">find_all_artifacts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node_registry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><span class="pre">NodeRegistry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.util.html#simstack.util.db.Database" title="simstack.util.db.Database"><span class="pre">Database</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.artifact_models.ArtifactModel" title="simstack.models.artifact_models.ArtifactModel"><span class="pre">ArtifactModel</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/simstack/core/artifacts.html#find_all_artifacts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.artifacts.find_all_artifacts" title="Link to this definition">¶</a></dt>
|
|
415
|
+
<dd></dd></dl>
|
|
416
|
+
|
|
417
|
+
<dl class="py function">
|
|
418
|
+
<dt class="sig sig-object py" id="simstack.core.artifacts.find_artifact_mappings">
|
|
419
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.artifacts.</span></span><span class="sig-name descname"><span class="pre">find_artifact_mappings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node_registry_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.util.html#simstack.util.db.Database" title="simstack.util.db.Database"><span class="pre">Database</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.artifact_models.ArtifactMapping" title="simstack.models.artifact_models.ArtifactMapping"><span class="pre">ArtifactMapping</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/simstack/core/artifacts.html#find_artifact_mappings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.artifacts.find_artifact_mappings" title="Link to this definition">¶</a></dt>
|
|
420
|
+
<dd></dd></dl>
|
|
421
|
+
|
|
422
|
+
<dl class="py function">
|
|
423
|
+
<dt class="sig sig-object py" id="simstack.core.artifacts.find_artifacts">
|
|
424
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.artifacts.</span></span><span class="sig-name descname"><span class="pre">find_artifacts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model_class</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.charts_artifact.AGAreaSeriesConfig.type" title="simstack.models.charts_artifact.AGAreaSeriesConfig.type"><span class="pre">type</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.artifact_models.ArtifactModel" title="simstack.models.artifact_models.ArtifactModel"><span class="pre">ArtifactModel</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.artifact_models.ArtifactModel" title="simstack.models.artifact_models.ArtifactModel"><span class="pre">ArtifactModel</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/simstack/core/artifacts.html#find_artifacts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.artifacts.find_artifacts" title="Link to this definition">¶</a></dt>
|
|
425
|
+
<dd><p>Custom find function for polymorphic models</p>
|
|
426
|
+
</dd></dl>
|
|
427
|
+
|
|
428
|
+
<dl class="py function">
|
|
429
|
+
<dt class="sig sig-object py" id="simstack.core.artifacts.register_artifact_mapping">
|
|
430
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.artifacts.</span></span><span class="sig-name descname"><span class="pre">register_artifact_mapping</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">artifact_mapping</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.artifact_models.ArtifactMapping" title="simstack.models.artifact_models.ArtifactMapping"><span class="pre">ArtifactMapping</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="simstack.models.html#simstack.models.artifact_models.ArtifactMapping" title="simstack.models.artifact_models.ArtifactMapping"><span class="pre">ArtifactMapping</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/artifacts.html#register_artifact_mapping"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.artifacts.register_artifact_mapping" title="Link to this definition">¶</a></dt>
|
|
431
|
+
<dd></dd></dl>
|
|
432
|
+
|
|
433
|
+
<dl class="py function">
|
|
434
|
+
<dt class="sig sig-object py" id="simstack.core.artifacts.save_artifact_model">
|
|
435
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.artifacts.</span></span><span class="sig-name descname"><span class="pre">save_artifact_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">artifact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.artifact_models.ArtifactModel" title="simstack.models.artifact_models.ArtifactModel"><span class="pre">ArtifactModel</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="simstack.models.html#simstack.models.artifact_models.ArtifactModel" title="simstack.models.artifact_models.ArtifactModel"><span class="pre">ArtifactModel</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/artifacts.html#save_artifact_model"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.artifacts.save_artifact_model" title="Link to this definition">¶</a></dt>
|
|
436
|
+
<dd><p>Custom save function for polymorphic models</p>
|
|
437
|
+
<p>If the item is a List type, it will also save any unsaved nested items.</p>
|
|
438
|
+
</dd></dl>
|
|
439
|
+
|
|
440
|
+
</section>
|
|
441
|
+
<section id="module-simstack.core.asnyc_helper">
|
|
442
|
+
<span id="simstack-core-asnyc-helper-module"></span><h2>simstack.core.asnyc_helper module<a class="headerlink" href="#module-simstack.core.asnyc_helper" title="Link to this heading">¶</a></h2>
|
|
443
|
+
<dl class="py function">
|
|
444
|
+
<dt class="sig sig-object py" id="simstack.core.asnyc_helper.async_helper">
|
|
445
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.asnyc_helper.</span></span><span class="sig-name descname"><span class="pre">async_helper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/asnyc_helper.html#async_helper"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.asnyc_helper.async_helper" title="Link to this definition">¶</a></dt>
|
|
446
|
+
<dd></dd></dl>
|
|
447
|
+
|
|
448
|
+
</section>
|
|
449
|
+
<section id="module-simstack.core.config_file">
|
|
450
|
+
<span id="simstack-core-config-file-module"></span><h2>simstack.core.config_file module<a class="headerlink" href="#module-simstack.core.config_file" title="Link to this heading">¶</a></h2>
|
|
451
|
+
<dl class="py class">
|
|
452
|
+
<dt class="sig sig-object py" id="simstack.core.config_file.SimstackConfig">
|
|
453
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.config_file.</span></span><span class="sig-name descname"><span class="pre">SimstackConfig</span></span><a class="reference internal" href="../../_modules/simstack/core/config_file.html#SimstackConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.config_file.SimstackConfig" title="Link to this definition">¶</a></dt>
|
|
454
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
455
|
+
<p>Singleton class that manages the path to a configuration file.</p>
|
|
456
|
+
<p>This class ensures only one instance exists throughout the application
|
|
457
|
+
and provides a centralized way to access the configuration file path.</p>
|
|
458
|
+
<dl class="py property">
|
|
459
|
+
<dt class="sig sig-object py" id="simstack.core.config_file.SimstackConfig.config_file_path">
|
|
460
|
+
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">config_file_path</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#simstack.core.config_file.SimstackConfig.config_file_path" title="Link to this definition">¶</a></dt>
|
|
461
|
+
<dd><p>Get the current configuration file path.</p>
|
|
462
|
+
</dd></dl>
|
|
463
|
+
|
|
464
|
+
</dd></dl>
|
|
465
|
+
|
|
466
|
+
<dl class="py function">
|
|
467
|
+
<dt class="sig sig-object py" id="simstack.core.config_file.get_config_file">
|
|
468
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.config_file.</span></span><span class="sig-name descname"><span class="pre">get_config_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#simstack.core.config_file.SimstackConfig" title="simstack.core.config_file.SimstackConfig"><span class="pre">SimstackConfig</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/config_file.html#get_config_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.config_file.get_config_file" title="Link to this definition">¶</a></dt>
|
|
469
|
+
<dd><p>Get the singleton ConfigManager instance.</p>
|
|
470
|
+
<dl class="field-list simple">
|
|
471
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
472
|
+
<dd class="field-odd"><p>The ConfigManager singleton instance</p>
|
|
473
|
+
</dd>
|
|
474
|
+
</dl>
|
|
475
|
+
</dd></dl>
|
|
476
|
+
|
|
477
|
+
</section>
|
|
478
|
+
<section id="module-simstack.core.context">
|
|
479
|
+
<span id="simstack-core-context-module"></span><h2>simstack.core.context module<a class="headerlink" href="#module-simstack.core.context" title="Link to this heading">¶</a></h2>
|
|
480
|
+
</section>
|
|
481
|
+
<section id="module-simstack.core.definitions">
|
|
482
|
+
<span id="simstack-core-definitions-module"></span><h2>simstack.core.definitions module<a class="headerlink" href="#module-simstack.core.definitions" title="Link to this heading">¶</a></h2>
|
|
483
|
+
<dl class="py class">
|
|
484
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.DBType">
|
|
485
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.definitions.</span></span><span class="sig-name descname"><span class="pre">DBType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/definitions.html#DBType"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.definitions.DBType" title="Link to this definition">¶</a></dt>
|
|
486
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
|
487
|
+
<dl class="py attribute">
|
|
488
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.DBType.IN_MEMORY">
|
|
489
|
+
<span class="sig-name descname"><span class="pre">IN_MEMORY</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'in_memory'</span></span><a class="headerlink" href="#simstack.core.definitions.DBType.IN_MEMORY" title="Link to this definition">¶</a></dt>
|
|
490
|
+
<dd></dd></dl>
|
|
491
|
+
|
|
492
|
+
<dl class="py attribute">
|
|
493
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.DBType.MONGODB">
|
|
494
|
+
<span class="sig-name descname"><span class="pre">MONGODB</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mongodb'</span></span><a class="headerlink" href="#simstack.core.definitions.DBType.MONGODB" title="Link to this definition">¶</a></dt>
|
|
495
|
+
<dd></dd></dl>
|
|
496
|
+
|
|
497
|
+
<dl class="py attribute">
|
|
498
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.DBType.POSTGRES">
|
|
499
|
+
<span class="sig-name descname"><span class="pre">POSTGRES</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'postgres'</span></span><a class="headerlink" href="#simstack.core.definitions.DBType.POSTGRES" title="Link to this definition">¶</a></dt>
|
|
500
|
+
<dd></dd></dl>
|
|
501
|
+
|
|
502
|
+
<dl class="py attribute">
|
|
503
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.DBType.SQLITE">
|
|
504
|
+
<span class="sig-name descname"><span class="pre">SQLITE</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sqlite'</span></span><a class="headerlink" href="#simstack.core.definitions.DBType.SQLITE" title="Link to this definition">¶</a></dt>
|
|
505
|
+
<dd></dd></dl>
|
|
506
|
+
|
|
507
|
+
<dl class="py attribute">
|
|
508
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.DBType.WITH_PATH">
|
|
509
|
+
<span class="sig-name descname"><span class="pre">WITH_PATH</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'with_path'</span></span><a class="headerlink" href="#simstack.core.definitions.DBType.WITH_PATH" title="Link to this definition">¶</a></dt>
|
|
510
|
+
<dd></dd></dl>
|
|
511
|
+
|
|
512
|
+
</dd></dl>
|
|
513
|
+
|
|
514
|
+
<dl class="py class">
|
|
515
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.TaskStatus">
|
|
516
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.definitions.</span></span><span class="sig-name descname"><span class="pre">TaskStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/definitions.html#TaskStatus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.definitions.TaskStatus" title="Link to this definition">¶</a></dt>
|
|
517
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
|
518
|
+
<dl class="py attribute">
|
|
519
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.TaskStatus.COMPLETED">
|
|
520
|
+
<span class="sig-name descname"><span class="pre">COMPLETED</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'completed'</span></span><a class="headerlink" href="#simstack.core.definitions.TaskStatus.COMPLETED" title="Link to this definition">¶</a></dt>
|
|
521
|
+
<dd></dd></dl>
|
|
522
|
+
|
|
523
|
+
<dl class="py attribute">
|
|
524
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.TaskStatus.FAILED">
|
|
525
|
+
<span class="sig-name descname"><span class="pre">FAILED</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'failed'</span></span><a class="headerlink" href="#simstack.core.definitions.TaskStatus.FAILED" title="Link to this definition">¶</a></dt>
|
|
526
|
+
<dd></dd></dl>
|
|
527
|
+
|
|
528
|
+
<dl class="py attribute">
|
|
529
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.TaskStatus.RECOVERED">
|
|
530
|
+
<span class="sig-name descname"><span class="pre">RECOVERED</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'recovered'</span></span><a class="headerlink" href="#simstack.core.definitions.TaskStatus.RECOVERED" title="Link to this definition">¶</a></dt>
|
|
531
|
+
<dd></dd></dl>
|
|
532
|
+
|
|
533
|
+
<dl class="py attribute">
|
|
534
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.TaskStatus.RETRIEVED">
|
|
535
|
+
<span class="sig-name descname"><span class="pre">RETRIEVED</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'retrieved'</span></span><a class="headerlink" href="#simstack.core.definitions.TaskStatus.RETRIEVED" title="Link to this definition">¶</a></dt>
|
|
536
|
+
<dd></dd></dl>
|
|
537
|
+
|
|
538
|
+
<dl class="py attribute">
|
|
539
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.TaskStatus.RUNNING">
|
|
540
|
+
<span class="sig-name descname"><span class="pre">RUNNING</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'running'</span></span><a class="headerlink" href="#simstack.core.definitions.TaskStatus.RUNNING" title="Link to this definition">¶</a></dt>
|
|
541
|
+
<dd></dd></dl>
|
|
542
|
+
|
|
543
|
+
<dl class="py attribute">
|
|
544
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.TaskStatus.SLURM_QUEUED">
|
|
545
|
+
<span class="sig-name descname"><span class="pre">SLURM_QUEUED</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slurm_queued'</span></span><a class="headerlink" href="#simstack.core.definitions.TaskStatus.SLURM_QUEUED" title="Link to this definition">¶</a></dt>
|
|
546
|
+
<dd></dd></dl>
|
|
547
|
+
|
|
548
|
+
<dl class="py attribute">
|
|
549
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.TaskStatus.SLURM_RUNNING">
|
|
550
|
+
<span class="sig-name descname"><span class="pre">SLURM_RUNNING</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slurm_running'</span></span><a class="headerlink" href="#simstack.core.definitions.TaskStatus.SLURM_RUNNING" title="Link to this definition">¶</a></dt>
|
|
551
|
+
<dd></dd></dl>
|
|
552
|
+
|
|
553
|
+
<dl class="py attribute">
|
|
554
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.TaskStatus.SUBMITTED">
|
|
555
|
+
<span class="sig-name descname"><span class="pre">SUBMITTED</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'submitted'</span></span><a class="headerlink" href="#simstack.core.definitions.TaskStatus.SUBMITTED" title="Link to this definition">¶</a></dt>
|
|
556
|
+
<dd></dd></dl>
|
|
557
|
+
|
|
558
|
+
<dl class="py attribute">
|
|
559
|
+
<dt class="sig sig-object py" id="simstack.core.definitions.TaskStatus.TIME_OUT">
|
|
560
|
+
<span class="sig-name descname"><span class="pre">TIME_OUT</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeout'</span></span><a class="headerlink" href="#simstack.core.definitions.TaskStatus.TIME_OUT" title="Link to this definition">¶</a></dt>
|
|
561
|
+
<dd></dd></dl>
|
|
562
|
+
|
|
563
|
+
</dd></dl>
|
|
564
|
+
|
|
565
|
+
</section>
|
|
566
|
+
<section id="module-simstack.core.engine">
|
|
567
|
+
<span id="simstack-core-engine-module"></span><h2>simstack.core.engine module<a class="headerlink" href="#module-simstack.core.engine" title="Link to this heading">¶</a></h2>
|
|
568
|
+
<dl class="py class">
|
|
569
|
+
<dt class="sig sig-object py" id="simstack.core.engine.AIOEngineProxy">
|
|
570
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.engine.</span></span><span class="sig-name descname"><span class="pre">AIOEngineProxy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">motor.motor_asyncio.AsyncIOMotorClient</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">database</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'test'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/engine.html#AIOEngineProxy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.engine.AIOEngineProxy" title="Link to this definition">¶</a></dt>
|
|
571
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">AIOEngine</span></code></p>
|
|
572
|
+
<p>A proxy engine that inherits all behavior from AIOEngine but overrides <cite>save</cite>.</p>
|
|
573
|
+
<p>The overridden <cite>save</cite> will:
|
|
574
|
+
- If the model has a <cite>save</cite> member function, call it with the engine instance.
|
|
575
|
+
- Else, if any direct part/attribute of the model has a <cite>save</cite> member function, call those with the engine instance.
|
|
576
|
+
- Otherwise, fall back to the original AIOEngine.save implementation.</p>
|
|
577
|
+
<p>Notes:
|
|
578
|
+
- Supports single model instances or iterables of model instances (list/tuple/set).
|
|
579
|
+
- Avoids recursion by delegating to super().save for the fallback.</p>
|
|
580
|
+
<dl class="py method">
|
|
581
|
+
<dt class="sig sig-object py" id="simstack.core.engine.AIOEngineProxy.save">
|
|
582
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">save</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="reference internal" href="../../_modules/simstack/core/engine.html#AIOEngineProxy.save"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.engine.AIOEngineProxy.save" title="Link to this definition">¶</a></dt>
|
|
583
|
+
<dd><p>Persist an instance to the database</p>
|
|
584
|
+
<p>This method behaves as an ‘upsert’ operation. If a document already exists
|
|
585
|
+
with the same primary key, it will be overwritten.</p>
|
|
586
|
+
<p>All the other models referenced by this instance will be saved as well.</p>
|
|
587
|
+
<dl class="field-list simple">
|
|
588
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
589
|
+
<dd class="field-odd"><ul class="simple">
|
|
590
|
+
<li><p><strong>instance</strong> – instance to persist</p></li>
|
|
591
|
+
<li><p><strong>session</strong> – An optional session to use for the operation. If not provided, an
|
|
592
|
+
internal session will be used to persist the instance and
|
|
593
|
+
sub-instances.</p></li>
|
|
594
|
+
</ul>
|
|
595
|
+
</dd>
|
|
596
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
597
|
+
<dd class="field-even"><p>the saved instance</p>
|
|
598
|
+
</dd>
|
|
599
|
+
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
|
600
|
+
<dd class="field-odd"><p><strong>DuplicateKeyError</strong> – the instance is duplicated according to a unique index.</p>
|
|
601
|
+
</dd>
|
|
602
|
+
</dl>
|
|
603
|
+
<div class="admonition note">
|
|
604
|
+
<p class="admonition-title">Note</p>
|
|
605
|
+
<p>The save operation actually modify the instance argument in place. However,
|
|
606
|
+
the instance is still returned for convenience.</p>
|
|
607
|
+
</div>
|
|
608
|
+
<p><!—
|
|
609
|
+
#noqa: DAR401 TypeError
|
|
610
|
+
#noqa: DAR402 DuplicateKeyError
|
|
611
|
+
–></p>
|
|
612
|
+
</dd></dl>
|
|
613
|
+
|
|
614
|
+
<dl class="py method">
|
|
615
|
+
<dt class="sig sig-object py" id="simstack.core.engine.AIOEngineProxy.save_unchecked">
|
|
616
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">save_unchecked</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="reference internal" href="../../_modules/simstack/core/engine.html#AIOEngineProxy.save_unchecked"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.engine.AIOEngineProxy.save_unchecked" title="Link to this definition">¶</a></dt>
|
|
617
|
+
<dd><p>Save without checking for custom save methods.
|
|
618
|
+
This is a direct call to the original AIOEngine.save.</p>
|
|
619
|
+
</dd></dl>
|
|
620
|
+
|
|
621
|
+
</dd></dl>
|
|
622
|
+
|
|
623
|
+
</section>
|
|
624
|
+
<section id="module-simstack.core.find_simstack_modules">
|
|
625
|
+
<span id="simstack-core-find-simstack-modules-module"></span><h2>simstack.core.find_simstack_modules module<a class="headerlink" href="#module-simstack.core.find_simstack_modules" title="Link to this heading">¶</a></h2>
|
|
626
|
+
<dl class="py function">
|
|
627
|
+
<dt class="sig sig-object py" id="simstack.core.find_simstack_modules.find_simstack_modules">
|
|
628
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.find_simstack_modules.</span></span><span class="sig-name descname"><span class="pre">find_simstack_modules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/find_simstack_modules.html#find_simstack_modules"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.find_simstack_modules.find_simstack_modules" title="Link to this definition">¶</a></dt>
|
|
629
|
+
<dd><p>Find all packages and modules within the simstack package.</p>
|
|
630
|
+
</dd></dl>
|
|
631
|
+
|
|
632
|
+
<dl class="py function">
|
|
633
|
+
<dt class="sig sig-object py" id="simstack.core.find_simstack_modules.walk_packages">
|
|
634
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.find_simstack_modules.</span></span><span class="sig-name descname"><span class="pre">walk_packages</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">all_modules</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/find_simstack_modules.html#walk_packages"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.find_simstack_modules.walk_packages" title="Link to this definition">¶</a></dt>
|
|
635
|
+
<dd><p>Walk through all packages and modules.</p>
|
|
636
|
+
</dd></dl>
|
|
637
|
+
|
|
638
|
+
</section>
|
|
639
|
+
<section id="module-simstack.core.hash">
|
|
640
|
+
<span id="simstack-core-hash-module"></span><h2>simstack.core.hash module<a class="headerlink" href="#module-simstack.core.hash" title="Link to this heading">¶</a></h2>
|
|
641
|
+
<dl class="py class">
|
|
642
|
+
<dt class="sig sig-object py" id="simstack.core.hash.ComplexHash">
|
|
643
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.hash.</span></span><span class="sig-name descname"><span class="pre">ComplexHash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/hash.html#ComplexHash"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.ComplexHash" title="Link to this definition">¶</a></dt>
|
|
644
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
645
|
+
<dl class="py method">
|
|
646
|
+
<dt class="sig sig-object py" id="simstack.core.hash.ComplexHash.complex_hash">
|
|
647
|
+
<span class="sig-name descname"><span class="pre">complex_hash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#ComplexHash.complex_hash"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.ComplexHash.complex_hash" title="Link to this definition">¶</a></dt>
|
|
648
|
+
<dd></dd></dl>
|
|
649
|
+
|
|
650
|
+
<dl class="py method">
|
|
651
|
+
<dt class="sig sig-object py" id="simstack.core.hash.ComplexHash.hash_class">
|
|
652
|
+
<span class="sig-name descname"><span class="pre">hash_class</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls_obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#ComplexHash.hash_class"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.ComplexHash.hash_class" title="Link to this definition">¶</a></dt>
|
|
653
|
+
<dd></dd></dl>
|
|
654
|
+
|
|
655
|
+
<dl class="py method">
|
|
656
|
+
<dt class="sig sig-object py" id="simstack.core.hash.ComplexHash.hash_dict">
|
|
657
|
+
<span class="sig-name descname"><span class="pre">hash_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#ComplexHash.hash_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.ComplexHash.hash_dict" title="Link to this definition">¶</a></dt>
|
|
658
|
+
<dd></dd></dl>
|
|
659
|
+
|
|
660
|
+
</dd></dl>
|
|
661
|
+
|
|
662
|
+
<dl class="py function">
|
|
663
|
+
<dt class="sig sig-object py" id="simstack.core.hash.complex_hash_function">
|
|
664
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.hash.</span></span><span class="sig-name descname"><span class="pre">complex_hash_function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#complex_hash_function"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.complex_hash_function" title="Link to this definition">¶</a></dt>
|
|
665
|
+
<dd></dd></dl>
|
|
666
|
+
|
|
667
|
+
<dl class="py function">
|
|
668
|
+
<dt class="sig sig-object py" id="simstack.core.hash.hash_class_def">
|
|
669
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.hash.</span></span><span class="sig-name descname"><span class="pre">hash_class_def</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.charts_artifact.AGAreaSeriesConfig.type" title="simstack.models.charts_artifact.AGAreaSeriesConfig.type"><span class="pre">type</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#hash_class_def"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.hash_class_def" title="Link to this definition">¶</a></dt>
|
|
670
|
+
<dd></dd></dl>
|
|
671
|
+
|
|
672
|
+
<dl class="py function">
|
|
673
|
+
<dt class="sig sig-object py" id="simstack.core.hash.hash_function_body">
|
|
674
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.hash.</span></span><span class="sig-name descname"><span class="pre">hash_function_body</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#hash_function_body"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.hash_function_body" title="Link to this definition">¶</a></dt>
|
|
675
|
+
<dd></dd></dl>
|
|
676
|
+
|
|
677
|
+
<dl class="py function">
|
|
678
|
+
<dt class="sig sig-object py" id="simstack.core.hash.hash_iterable">
|
|
679
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.hash.</span></span><span class="sig-name descname"><span class="pre">hash_iterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iterable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#hash_iterable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.hash_iterable" title="Link to this definition">¶</a></dt>
|
|
680
|
+
<dd></dd></dl>
|
|
681
|
+
|
|
682
|
+
<dl class="py function">
|
|
683
|
+
<dt class="sig sig-object py" id="simstack.core.hash.hash_non_callable_members">
|
|
684
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.hash.</span></span><span class="sig-name descname"><span class="pre">hash_non_callable_members</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#hash_non_callable_members"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.hash_non_callable_members" title="Link to this definition">¶</a></dt>
|
|
685
|
+
<dd></dd></dl>
|
|
686
|
+
|
|
687
|
+
<dl class="py function">
|
|
688
|
+
<dt class="sig sig-object py" id="simstack.core.hash.hash_value">
|
|
689
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.hash.</span></span><span class="sig-name descname"><span class="pre">hash_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#hash_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.hash_value" title="Link to this definition">¶</a></dt>
|
|
690
|
+
<dd></dd></dl>
|
|
691
|
+
|
|
692
|
+
<dl class="py function">
|
|
693
|
+
<dt class="sig sig-object py" id="simstack.core.hash.is_iterable">
|
|
694
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.hash.</span></span><span class="sig-name descname"><span class="pre">is_iterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#is_iterable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.is_iterable" title="Link to this definition">¶</a></dt>
|
|
695
|
+
<dd></dd></dl>
|
|
696
|
+
|
|
697
|
+
<dl class="py function">
|
|
698
|
+
<dt class="sig sig-object py" id="simstack.core.hash.is_primitive_type">
|
|
699
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.hash.</span></span><span class="sig-name descname"><span class="pre">is_primitive_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../../_modules/simstack/core/hash.html#is_primitive_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.hash.is_primitive_type" title="Link to this definition">¶</a></dt>
|
|
700
|
+
<dd></dd></dl>
|
|
701
|
+
|
|
702
|
+
</section>
|
|
703
|
+
<section id="module-simstack.core.node">
|
|
704
|
+
<span id="simstack-core-node-module"></span><h2>simstack.core.node module<a class="headerlink" href="#module-simstack.core.node" title="Link to this heading">¶</a></h2>
|
|
705
|
+
<dl class="py class">
|
|
706
|
+
<dt class="sig sig-object py" id="simstack.core.node.Node">
|
|
707
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.node.</span></span><span class="sig-name descname"><span class="pre">Node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/node.html#Node"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.Node" title="Link to this definition">¶</a></dt>
|
|
708
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
709
|
+
<p>represents a computational task or node in the workflow, managing its lifecycle,
|
|
710
|
+
execution environment, and interactions with the database. This class helps in
|
|
711
|
+
defining tasks, storing their details, and ensuring they are executed either
|
|
712
|
+
locally or remotely, with their statuses tracked within a shared database
|
|
713
|
+
context.</p>
|
|
714
|
+
<dl class="field-list simple">
|
|
715
|
+
<dt class="field-odd">Variables<span class="colon">:</span></dt>
|
|
716
|
+
<dd class="field-odd"><ul class="simple">
|
|
717
|
+
<li><p><strong>name</strong> – The name of the function associated with the node.</p></li>
|
|
718
|
+
<li><p><strong>custom_name</strong> – A custom name for the node, generated if not specified.</p></li>
|
|
719
|
+
<li><p><strong>registry_entry</strong> – The registry entry associated with the node in the database.</p></li>
|
|
720
|
+
<li><p><strong>parent_id</strong> – The parent node’s unique identifier, if applicable.</p></li>
|
|
721
|
+
<li><p><strong>parameters</strong> – Additional parameters for the node.</p></li>
|
|
722
|
+
<li><p><strong>_func</strong> – The function represented by the node.</p></li>
|
|
723
|
+
</ul>
|
|
724
|
+
</dd>
|
|
725
|
+
</dl>
|
|
726
|
+
<dl class="py method">
|
|
727
|
+
<dt class="sig sig-object py" id="simstack.core.node.Node.execute_node_locally">
|
|
728
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">execute_node_locally</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Model</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult" title="simstack.core.simstack_result.SimstackResult"><span class="pre">SimstackResult</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#Node.execute_node_locally"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.Node.execute_node_locally" title="Link to this definition">¶</a></dt>
|
|
729
|
+
<dd><p>Executes a specified node in the current context locally, either asynchronously or
|
|
730
|
+
synchronously, managing task status updates, directory changes, and result persistence.</p>
|
|
731
|
+
<p>This method handles the execution of a computational task represented as a “node”. It
|
|
732
|
+
manages the task’s status transitions, file system operations for managing working
|
|
733
|
+
directories, and handling output results, including their persistence in a database.
|
|
734
|
+
The method supports both asynchronous and synchronous node execution. It verifies
|
|
735
|
+
results, handles exceptions, and manages task metadata updates.</p>
|
|
736
|
+
<dl class="simple">
|
|
737
|
+
<dt>Nodes can either return</dt><dd><ul class="simple">
|
|
738
|
+
<li><p>a single <cite>Model</cite> instance</p></li>
|
|
739
|
+
<li><p>a <cite>SimstackResult</cite> instance</p></li>
|
|
740
|
+
<li><p>None (for failure).</p></li>
|
|
741
|
+
<li><p>a boolean value (for failure or success if there are no results)</p></li>
|
|
742
|
+
</ul>
|
|
743
|
+
</dd>
|
|
744
|
+
</dl>
|
|
745
|
+
<p>There is a try-except block around the actual execution of the node which generates a log entry
|
|
746
|
+
“node function error for node” that catches all uncaught exceptions within the node. These error are
|
|
747
|
+
not propagated, but the task status is set to TaskStatus.FAILED.</p>
|
|
748
|
+
<dl class="field-list simple">
|
|
749
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
750
|
+
<dd class="field-odd"><p><strong>self</strong> – Instance of the class invoking this method.</p>
|
|
751
|
+
</dd>
|
|
752
|
+
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
753
|
+
<dd class="field-even"><p><strong>Exception</strong> – for failures of the Simstack logic</p>
|
|
754
|
+
</dd>
|
|
755
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
756
|
+
<dd class="field-odd"><p>The processed result of the node execution. Depending on the task’s output,
|
|
757
|
+
it could be of the type <cite>Model</cite>, <cite>SimstackResult</cite>, or be None if no valid result
|
|
758
|
+
was produced.</p>
|
|
759
|
+
</dd>
|
|
760
|
+
</dl>
|
|
761
|
+
</dd></dl>
|
|
762
|
+
|
|
763
|
+
<dl class="py method">
|
|
764
|
+
<dt class="sig sig-object py" id="simstack.core.node.Node.get_node_registry">
|
|
765
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">get_node_registry</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#simstack.core.definitions.TaskStatus" title="simstack.core.definitions.TaskStatus"><span class="pre">TaskStatus</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#Node.get_node_registry"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.Node.get_node_registry" title="Link to this definition">¶</a></dt>
|
|
766
|
+
<dd><p>Reads or initializes the task registry entry in the database.</p>
|
|
767
|
+
<p>This method ensures that a task entry exists in the database for the
|
|
768
|
+
current task. It computes hashes of its arguments and function,
|
|
769
|
+
checks if a database entry already matches these hashes, and creates
|
|
770
|
+
a new entry if no match is found. If the database is not connected,
|
|
771
|
+
an exception is raised.</p>
|
|
772
|
+
<dl class="field-list simple">
|
|
773
|
+
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
|
774
|
+
<dd class="field-odd"><p><strong>ValueError</strong> – if the database is not connected.</p>
|
|
775
|
+
</dd>
|
|
776
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
777
|
+
<dd class="field-even"><p>Status of the task retrieved or created.</p>
|
|
778
|
+
</dd>
|
|
779
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
780
|
+
<dd class="field-odd"><p><a class="reference internal" href="#simstack.core.definitions.TaskStatus" title="simstack.core.definitions.TaskStatus">TaskStatus</a></p>
|
|
781
|
+
</dd>
|
|
782
|
+
</dl>
|
|
783
|
+
</dd></dl>
|
|
784
|
+
|
|
785
|
+
<dl class="py property">
|
|
786
|
+
<dt class="sig sig-object py" id="simstack.core.node.Node.id">
|
|
787
|
+
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">id</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ObjectId</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#simstack.core.node.Node.id" title="Link to this definition">¶</a></dt>
|
|
788
|
+
<dd></dd></dl>
|
|
789
|
+
|
|
790
|
+
<dl class="py method">
|
|
791
|
+
<dt class="sig sig-object py" id="simstack.core.node.Node.load_results">
|
|
792
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">load_results</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Model</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult" title="simstack.core.simstack_result.SimstackResult"><span class="pre">SimstackResult</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#Node.load_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.Node.load_results" title="Link to this definition">¶</a></dt>
|
|
793
|
+
<dd><p>Loads the results associated with a specific task from the database. This
|
|
794
|
+
method verifies whether the task has valid result identifiers. If valid
|
|
795
|
+
identifiers (results_id and results_table_name) exist, it attempts to fetch
|
|
796
|
+
the outputs.</p>
|
|
797
|
+
<p>If the task status is not TaskStatus.COMPLETED None is returned which results in a RuntimeError
|
|
798
|
+
If the results are not found or if the retrieval process fails, a <cite>ValueError</cite> is raised.</p>
|
|
799
|
+
<dl class="field-list simple">
|
|
800
|
+
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
|
801
|
+
<dd class="field-odd"><p><strong>ValueError</strong> – If the task has completed but lacks output identifiers
|
|
802
|
+
(<cite>results_id</cite> or <cite>results_table_name</cite>), or if there is any error
|
|
803
|
+
during the process of loading the results.</p>
|
|
804
|
+
</dd>
|
|
805
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
806
|
+
<dd class="field-even"><p>The retrieved task outputs from the database.</p>
|
|
807
|
+
</dd>
|
|
808
|
+
</dl>
|
|
809
|
+
</dd></dl>
|
|
810
|
+
|
|
811
|
+
<dl class="py method">
|
|
812
|
+
<dt class="sig sig-object py" id="simstack.core.node.Node.make_registry_entry">
|
|
813
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">make_registry_entry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function_hash</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg_hash</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><span class="pre">NodeRegistry</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#Node.make_registry_entry"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.Node.make_registry_entry" title="Link to this definition">¶</a></dt>
|
|
814
|
+
<dd><p>Creates a registry entry for the node in the database.</p>
|
|
815
|
+
<p>This method is used to create a new entry in the database for the node,
|
|
816
|
+
including its inputs and outputs. It ensures that the task is properly
|
|
817
|
+
registered with all necessary details.</p>
|
|
818
|
+
<dl class="field-list simple">
|
|
819
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
820
|
+
<dd class="field-odd"><p><a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry">NodeRegistry</a></p>
|
|
821
|
+
</dd>
|
|
822
|
+
</dl>
|
|
823
|
+
</dd></dl>
|
|
824
|
+
|
|
825
|
+
<dl class="py method">
|
|
826
|
+
<dt class="sig sig-object py" id="simstack.core.node.Node.process_results">
|
|
827
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">process_results</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#simstack.core.definitions.TaskStatus" title="simstack.core.definitions.TaskStatus"><span class="pre">TaskStatus</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#Node.process_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.Node.process_results" title="Link to this definition">¶</a></dt>
|
|
828
|
+
<dd></dd></dl>
|
|
829
|
+
|
|
830
|
+
<dl class="py method">
|
|
831
|
+
<dt class="sig sig-object py" id="simstack.core.node.Node.run_somewhere">
|
|
832
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">run_somewhere</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Model</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult" title="simstack.core.simstack_result.SimstackResult"><span class="pre">SimstackResult</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#Node.run_somewhere"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.Node.run_somewhere" title="Link to this definition">¶</a></dt>
|
|
833
|
+
<dd><p>Executes the task either locally or on a remote resource. This function ensures that
|
|
834
|
+
if the task is meant to execute on a remote resource, it waits for the task to complete
|
|
835
|
+
remotely and fetches its results. If the task executes locally, it directly runs the task
|
|
836
|
+
and retrieves the results.</p>
|
|
837
|
+
<p>If any exception occurs during the execution, the status is updated to <cite>FAILED</cite>
|
|
838
|
+
and the exception is logged.</p>
|
|
839
|
+
<dl class="field-list simple">
|
|
840
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
841
|
+
<dd class="field-odd"><p>A single Model or a list of Model instances of the task results or None. If the task
|
|
842
|
+
is not completed successfully.</p>
|
|
843
|
+
</dd>
|
|
844
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
845
|
+
<dd class="field-even"><p>Model | <a class="reference internal" href="#simstack.core.simstack_result.SimstackResult" title="simstack.core.simstack_result.SimstackResult">SimstackResult</a></p>
|
|
846
|
+
</dd>
|
|
847
|
+
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
|
848
|
+
<dd class="field-odd"><p><strong>RunTimeError</strong> – When task execution fails due to an unexpected exception.</p>
|
|
849
|
+
</dd>
|
|
850
|
+
</dl>
|
|
851
|
+
</dd></dl>
|
|
852
|
+
|
|
853
|
+
<dl class="py method">
|
|
854
|
+
<dt class="sig sig-object py" id="simstack.core.node.Node.set_status">
|
|
855
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">set_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#simstack.core.definitions.TaskStatus" title="simstack.core.definitions.TaskStatus"><span class="pre">TaskStatus</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#Node.set_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.Node.set_status" title="Link to this definition">¶</a></dt>
|
|
856
|
+
<dd></dd></dl>
|
|
857
|
+
|
|
858
|
+
<dl class="py property">
|
|
859
|
+
<dt class="sig sig-object py" id="simstack.core.node.Node.status">
|
|
860
|
+
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">status</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#simstack.core.definitions.TaskStatus" title="simstack.core.definitions.TaskStatus"><span class="pre">TaskStatus</span></a></span><a class="headerlink" href="#simstack.core.node.Node.status" title="Link to this definition">¶</a></dt>
|
|
861
|
+
<dd></dd></dl>
|
|
862
|
+
|
|
863
|
+
</dd></dl>
|
|
864
|
+
|
|
865
|
+
<dl class="py function">
|
|
866
|
+
<dt class="sig sig-object py" id="simstack.core.node.compute_arg_hash">
|
|
867
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.node.</span></span><span class="sig-name descname"><span class="pre">compute_arg_hash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Model</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#compute_arg_hash"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.compute_arg_hash" title="Link to this definition">¶</a></dt>
|
|
868
|
+
<dd><p>Computes a hash for a list of arguments provided, where each argument
|
|
869
|
+
is an instance of the Model class or can be processed into a hashable
|
|
870
|
+
format. Uses a complex hashing function for the resulting computation.</p>
|
|
871
|
+
<dl class="field-list simple">
|
|
872
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
873
|
+
<dd class="field-odd"><p><strong>args</strong> (<em>List</em><em>[</em><em>Model</em><em>]</em>) – A list of objects where each object must be an instance of the
|
|
874
|
+
Model class. The objects are used to compute their respective
|
|
875
|
+
hash values via a specified complex hashing mechanism.</p>
|
|
876
|
+
</dd>
|
|
877
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
878
|
+
<dd class="field-even"><p><dl class="simple">
|
|
879
|
+
<dt>A string representation of the computed hash for the provided</dt><dd><p>list of arguments.</p>
|
|
880
|
+
</dd>
|
|
881
|
+
</dl>
|
|
882
|
+
</p>
|
|
883
|
+
</dd>
|
|
884
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
885
|
+
<dd class="field-odd"><p>str</p>
|
|
886
|
+
</dd>
|
|
887
|
+
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
888
|
+
<dd class="field-even"><p><strong>TypeError</strong> – If any item in the provided list is not an instance of the
|
|
889
|
+
Model class.</p>
|
|
890
|
+
</dd>
|
|
891
|
+
</dl>
|
|
892
|
+
</dd></dl>
|
|
893
|
+
|
|
894
|
+
<dl class="py function">
|
|
895
|
+
<dt class="sig sig-object py" id="simstack.core.node.default_name_generator">
|
|
896
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.node.</span></span><span class="sig-name descname"><span class="pre">default_name_generator</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#default_name_generator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.default_name_generator" title="Link to this definition">¶</a></dt>
|
|
897
|
+
<dd></dd></dl>
|
|
898
|
+
|
|
899
|
+
<dl class="py function">
|
|
900
|
+
<dt class="sig sig-object py" id="simstack.core.node.hashable_inputs">
|
|
901
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.node.</span></span><span class="sig-name descname"><span class="pre">hashable_inputs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#hashable_inputs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.hashable_inputs" title="Link to this definition">¶</a></dt>
|
|
902
|
+
<dd><p>Get the hashable inputs for the node. This allows exclusion of some fields from the hash.</p>
|
|
903
|
+
<dl class="field-list simple">
|
|
904
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
905
|
+
<dd class="field-odd"><p>The hashable inputs.</p>
|
|
906
|
+
</dd>
|
|
907
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
908
|
+
<dd class="field-even"><p>dict</p>
|
|
909
|
+
</dd>
|
|
910
|
+
</dl>
|
|
911
|
+
</dd></dl>
|
|
912
|
+
|
|
913
|
+
<dl class="py function">
|
|
914
|
+
<dt class="sig sig-object py" id="simstack.core.node.hashable_value">
|
|
915
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.node.</span></span><span class="sig-name descname"><span class="pre">hashable_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#hashable_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.hashable_value" title="Link to this definition">¶</a></dt>
|
|
916
|
+
<dd></dd></dl>
|
|
917
|
+
|
|
918
|
+
<dl class="py function">
|
|
919
|
+
<dt class="sig sig-object py" id="simstack.core.node.node">
|
|
920
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.node.</span></span><span class="sig-name descname"><span class="pre">node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">P</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#node"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.node" title="Link to this definition">¶</a></dt>
|
|
921
|
+
<dt class="sig sig-object py">
|
|
922
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.node.</span></span><span class="sig-name descname"><span class="pre">node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs_node</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">P</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span></dt>
|
|
923
|
+
<dd><p>Decorator to mark a function as a node in the computation graph.
|
|
924
|
+
Supports both synchronous and asynchronous functions.
|
|
925
|
+
Can be used with or without parameters:
|
|
926
|
+
@node
|
|
927
|
+
def func(): …</p>
|
|
928
|
+
<p>@node(name=”example”)
|
|
929
|
+
def func(): …</p>
|
|
930
|
+
</dd></dl>
|
|
931
|
+
|
|
932
|
+
<dl class="py function">
|
|
933
|
+
<dt class="sig sig-object py" id="simstack.core.node.node_from_database">
|
|
934
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.node.</span></span><span class="sig-name descname"><span class="pre">node_from_database</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><span class="pre">NodeRegistry</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#simstack.core.node.Node" title="simstack.core.node.Node"><span class="pre">Node</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node.html#node_from_database"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node.node_from_database" title="Link to this definition">¶</a></dt>
|
|
935
|
+
<dd><p>Constructs an instance of the class from database information encoded in a
|
|
936
|
+
registry entry.</p>
|
|
937
|
+
<p>This method retrieves input arguments and the serialized function from the
|
|
938
|
+
database using information provided in the <cite>registry_entry</cite>. It then deserializes
|
|
939
|
+
the function and initializes a corresponding Node instance, associating it
|
|
940
|
+
with the given registry entry.</p>
|
|
941
|
+
<p>This function can delete the registry_entry !!!
|
|
942
|
+
The only way that registry_entry.function_hash is “NOT INITIALIZED” is when the node
|
|
943
|
+
is created from the frontend. No other node is listening specifically for this registry_entry to complete.
|
|
944
|
+
If a duplicate is found the node from the duplication is returned</p>
|
|
945
|
+
<dl class="field-list simple">
|
|
946
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
947
|
+
<dd class="field-odd"><p><strong>registry_entry</strong> (<a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><em>NodeRegistry</em></a>) – The registry entry containing information necessary to
|
|
948
|
+
reconstruct the Node instance. Includes input table names, function pickled
|
|
949
|
+
as a string, and other metadata.</p>
|
|
950
|
+
</dd>
|
|
951
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
952
|
+
<dd class="field-even"><p>A reconstructed Node instance based on the registry entry, or None if
|
|
953
|
+
the deserialized function is not valid or there was an error.</p>
|
|
954
|
+
</dd>
|
|
955
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
956
|
+
<dd class="field-odd"><p>Optional[<a class="reference internal" href="#simstack.core.node.Node" title="simstack.core.node.Node">Node</a>]</p>
|
|
957
|
+
</dd>
|
|
958
|
+
</dl>
|
|
959
|
+
</dd></dl>
|
|
960
|
+
|
|
961
|
+
</section>
|
|
962
|
+
<section id="module-simstack.core.node_claim">
|
|
963
|
+
<span id="simstack-core-node-claim-module"></span><h2>simstack.core.node_claim module<a class="headerlink" href="#module-simstack.core.node_claim" title="Link to this heading">¶</a></h2>
|
|
964
|
+
<dl class="py function">
|
|
965
|
+
<dt class="sig sig-object py" id="simstack.core.node_claim.claim_submitted_node">
|
|
966
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.node_claim.</span></span><span class="sig-name descname"><span class="pre">claim_submitted_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><span class="pre">NodeRegistry</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node_claim.html#claim_submitted_node"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_claim.claim_submitted_node" title="Link to this definition">¶</a></dt>
|
|
967
|
+
<dd><p>Automatically claim a submitted node for execution or submission.</p>
|
|
968
|
+
</dd></dl>
|
|
969
|
+
|
|
970
|
+
</section>
|
|
971
|
+
<section id="module-simstack.core.node_runner">
|
|
972
|
+
<span id="simstack-core-node-runner-module"></span><h2>simstack.core.node_runner module<a class="headerlink" href="#module-simstack.core.node_runner" title="Link to this heading">¶</a></h2>
|
|
973
|
+
<dl class="py class">
|
|
974
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner">
|
|
975
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.node_runner.</span></span><span class="sig-name descname"><span class="pre">NodeRunner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ObjectId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Logger</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#simstack.core.definitions.TaskStatus" title="simstack.core.definitions.TaskStatus"><span class="pre">TaskStatus</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">TaskStatus.RETRIEVED</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.files.FileStack" title="simstack.models.files.FileStack"><span class="pre">FileStack</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info_files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.files.FileStack" title="simstack.models.files.FileStack"><span class="pre">FileStack</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner" title="Link to this definition">¶</a></dt>
|
|
976
|
+
<dd><p>Bases: <a class="reference internal" href="#simstack.core.simstack_result.SimstackResult" title="simstack.core.simstack_result.SimstackResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimstackResult</span></code></a></p>
|
|
977
|
+
<p>A task runner class that extends SimstackResult for executing subprocess commands and managing task execution.</p>
|
|
978
|
+
<p>This class provides functionality for running shell commands, collecting output files, and managing
|
|
979
|
+
task status with comprehensive logging capabilities. It acts as a bridge between the Simstack node
|
|
980
|
+
execution environment and external processes, ensuring that output, errors, and informational files
|
|
981
|
+
are correctly captured and associated with the task.</p>
|
|
982
|
+
<dl class="py attribute">
|
|
983
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.task_id">
|
|
984
|
+
<span class="sig-name descname"><span class="pre">task_id</span></span><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.task_id" title="Link to this definition">¶</a></dt>
|
|
985
|
+
<dd><p>Unique identifier for the task, typically a string representation of an ObjectId.</p>
|
|
986
|
+
<dl class="field-list simple">
|
|
987
|
+
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
|
988
|
+
<dd class="field-odd"><p>str</p>
|
|
989
|
+
</dd>
|
|
990
|
+
</dl>
|
|
991
|
+
</dd></dl>
|
|
992
|
+
|
|
993
|
+
<dl class="py attribute">
|
|
994
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.name">
|
|
995
|
+
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.name" title="Link to this definition">¶</a></dt>
|
|
996
|
+
<dd><p>Name of the task runner instance, usually derived from the node function name.</p>
|
|
997
|
+
<dl class="field-list simple">
|
|
998
|
+
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
|
999
|
+
<dd class="field-odd"><p>str</p>
|
|
1000
|
+
</dd>
|
|
1001
|
+
</dl>
|
|
1002
|
+
</dd></dl>
|
|
1003
|
+
|
|
1004
|
+
<dl class="py attribute">
|
|
1005
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.logger">
|
|
1006
|
+
<span class="sig-name descname"><span class="pre">logger</span></span><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.logger" title="Link to this definition">¶</a></dt>
|
|
1007
|
+
<dd><p>Logger instance for recording task activities.</p>
|
|
1008
|
+
<dl class="field-list simple">
|
|
1009
|
+
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
|
1010
|
+
<dd class="field-odd"><p>logging.Logger</p>
|
|
1011
|
+
</dd>
|
|
1012
|
+
</dl>
|
|
1013
|
+
</dd></dl>
|
|
1014
|
+
|
|
1015
|
+
<dl class="py attribute">
|
|
1016
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.last_stdout">
|
|
1017
|
+
<span class="sig-name descname"><span class="pre">last_stdout</span></span><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.last_stdout" title="Link to this definition">¶</a></dt>
|
|
1018
|
+
<dd><p>Most recent stdout from subprocess execution.</p>
|
|
1019
|
+
<dl class="field-list simple">
|
|
1020
|
+
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
|
1021
|
+
<dd class="field-odd"><p>str</p>
|
|
1022
|
+
</dd>
|
|
1023
|
+
</dl>
|
|
1024
|
+
</dd></dl>
|
|
1025
|
+
|
|
1026
|
+
<dl class="py attribute">
|
|
1027
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.last_stderr">
|
|
1028
|
+
<span class="sig-name descname"><span class="pre">last_stderr</span></span><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.last_stderr" title="Link to this definition">¶</a></dt>
|
|
1029
|
+
<dd><p>Most recent stderr from subprocess execution.</p>
|
|
1030
|
+
<dl class="field-list simple">
|
|
1031
|
+
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
|
1032
|
+
<dd class="field-odd"><p>str</p>
|
|
1033
|
+
</dd>
|
|
1034
|
+
</dl>
|
|
1035
|
+
</dd></dl>
|
|
1036
|
+
|
|
1037
|
+
<dl class="py attribute">
|
|
1038
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.log_string">
|
|
1039
|
+
<span class="sig-name descname"><span class="pre">log_string</span></span><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.log_string" title="Link to this definition">¶</a></dt>
|
|
1040
|
+
<dd><p>Cumulative log of messages recorded via the <cite>log</cite> method.</p>
|
|
1041
|
+
<dl class="field-list simple">
|
|
1042
|
+
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
|
1043
|
+
<dd class="field-odd"><p>str</p>
|
|
1044
|
+
</dd>
|
|
1045
|
+
</dl>
|
|
1046
|
+
</dd></dl>
|
|
1047
|
+
|
|
1048
|
+
<dl class="py attribute">
|
|
1049
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.info_file_patterns">
|
|
1050
|
+
<span class="sig-name descname"><span class="pre">info_file_patterns</span></span><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.info_file_patterns" title="Link to this definition">¶</a></dt>
|
|
1051
|
+
<dd><p>Set of file patterns (e.g., “<a href="#id1"><span class="problematic" id="id2">*</span></a>.log”) used to collect information files.</p>
|
|
1052
|
+
<dl class="field-list simple">
|
|
1053
|
+
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
|
1054
|
+
<dd class="field-odd"><p>Set[str]</p>
|
|
1055
|
+
</dd>
|
|
1056
|
+
</dl>
|
|
1057
|
+
</dd></dl>
|
|
1058
|
+
|
|
1059
|
+
<dl class="py method">
|
|
1060
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.debug">
|
|
1061
|
+
<span class="sig-name descname"><span class="pre">debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.debug"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.debug" title="Link to this definition">¶</a></dt>
|
|
1062
|
+
<dd><p>Log a debug message with task context.</p>
|
|
1063
|
+
<dl class="field-list simple">
|
|
1064
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1065
|
+
<dd class="field-odd"><p><strong>msg</strong> (<em>str</em>) – Debug message to log</p>
|
|
1066
|
+
</dd>
|
|
1067
|
+
</dl>
|
|
1068
|
+
</dd></dl>
|
|
1069
|
+
|
|
1070
|
+
<dl class="py method">
|
|
1071
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.error">
|
|
1072
|
+
<span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.error" title="Link to this definition">¶</a></dt>
|
|
1073
|
+
<dd><p>Log an error message with task context and exception info.</p>
|
|
1074
|
+
<dl class="field-list simple">
|
|
1075
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1076
|
+
<dd class="field-odd"><p><strong>msg</strong> (<em>str</em>) – Error message to log.</p>
|
|
1077
|
+
</dd>
|
|
1078
|
+
</dl>
|
|
1079
|
+
</dd></dl>
|
|
1080
|
+
|
|
1081
|
+
<dl class="py method">
|
|
1082
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.fail">
|
|
1083
|
+
<span class="sig-name descname"><span class="pre">fail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#simstack.core.node_runner.NodeRunner" title="simstack.core.node_runner.NodeRunner"><span class="pre">NodeRunner</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.fail"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.fail" title="Link to this definition">¶</a></dt>
|
|
1084
|
+
<dd><p>Mark the task as failed and record an error message.</p>
|
|
1085
|
+
<p>This method updates the task status to FAILED, sets the error message,
|
|
1086
|
+
logs the error, and ensures the cumulative log file is created.</p>
|
|
1087
|
+
<dl class="field-list simple">
|
|
1088
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1089
|
+
<dd class="field-odd"><p><strong>msg</strong> (<em>str</em>) – Error message describing the failure.</p>
|
|
1090
|
+
</dd>
|
|
1091
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1092
|
+
<dd class="field-even"><p>Self reference for chaining.</p>
|
|
1093
|
+
</dd>
|
|
1094
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
1095
|
+
<dd class="field-odd"><p><a class="reference internal" href="#simstack.core.node_runner.NodeRunner" title="simstack.core.node_runner.NodeRunner">NodeRunner</a></p>
|
|
1096
|
+
</dd>
|
|
1097
|
+
</dl>
|
|
1098
|
+
</dd></dl>
|
|
1099
|
+
|
|
1100
|
+
<dl class="py method">
|
|
1101
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.from_kwargs">
|
|
1102
|
+
<span class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">from_kwargs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#simstack.core.node_runner.NodeRunner" title="simstack.core.node_runner.NodeRunner"><span class="pre">NodeRunner</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.from_kwargs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.from_kwargs" title="Link to this definition">¶</a></dt>
|
|
1103
|
+
<dd><p>Create a NodeRunner instance from keyword arguments.</p>
|
|
1104
|
+
<p>If ‘node_runner’ is already present in kwargs and is an instance of NodeRunner, it returns it.
|
|
1105
|
+
Otherwise, it initializes a new NodeRunner using ‘name’, ‘task_id’, and optionally ‘logger’ from kwargs.</p>
|
|
1106
|
+
<dl class="field-list simple">
|
|
1107
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1108
|
+
<dd class="field-odd"><p><strong>**kwargs</strong> – Keyword arguments containing ‘node_runner’ or initialization parameters.</p>
|
|
1109
|
+
</dd>
|
|
1110
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1111
|
+
<dd class="field-even"><p>An existing or newly created NodeRunner instance.</p>
|
|
1112
|
+
</dd>
|
|
1113
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
1114
|
+
<dd class="field-odd"><p><a class="reference internal" href="#simstack.core.node_runner.NodeRunner" title="simstack.core.node_runner.NodeRunner">NodeRunner</a></p>
|
|
1115
|
+
</dd>
|
|
1116
|
+
</dl>
|
|
1117
|
+
</dd></dl>
|
|
1118
|
+
|
|
1119
|
+
<dl class="py method">
|
|
1120
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.info">
|
|
1121
|
+
<span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.info" title="Link to this definition">¶</a></dt>
|
|
1122
|
+
<dd><p>Log an info message with task context.</p>
|
|
1123
|
+
<dl class="field-list simple">
|
|
1124
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1125
|
+
<dd class="field-odd"><p><strong>msg</strong> (<em>str</em>) – Info message to log.</p>
|
|
1126
|
+
</dd>
|
|
1127
|
+
</dl>
|
|
1128
|
+
</dd></dl>
|
|
1129
|
+
|
|
1130
|
+
<dl class="py method">
|
|
1131
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.log">
|
|
1132
|
+
<span class="sig-name descname"><span class="pre">log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.log"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.log" title="Link to this definition">¶</a></dt>
|
|
1133
|
+
<dd><p>Log a message and append it to the cumulative log string.</p>
|
|
1134
|
+
<p>This method records a message in the internal <cite>log_string</cite> and also logs it
|
|
1135
|
+
as a debug message using the logger. The cumulative log string can later
|
|
1136
|
+
be saved as a log file when the task finishes.</p>
|
|
1137
|
+
<dl class="field-list simple">
|
|
1138
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1139
|
+
<dd class="field-odd"><p><strong>msg</strong> (<em>str</em>) – Message to log.</p>
|
|
1140
|
+
</dd>
|
|
1141
|
+
</dl>
|
|
1142
|
+
</dd></dl>
|
|
1143
|
+
|
|
1144
|
+
<dl class="py method">
|
|
1145
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.make_info_files">
|
|
1146
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">make_info_files</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cwd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Path</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.make_info_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.make_info_files" title="Link to this definition">¶</a></dt>
|
|
1147
|
+
<dd><p>Collect and process information files based on patterns and explicit file paths.</p>
|
|
1148
|
+
<p>This method processes the provided arguments to identify file patterns and explicit
|
|
1149
|
+
file paths, then collects all matching files into FileStack objects for later use.</p>
|
|
1150
|
+
<dl class="field-list simple">
|
|
1151
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1152
|
+
<dd class="field-odd"><ul class="simple">
|
|
1153
|
+
<li><p><strong>*args</strong> – Variable arguments that can be:
|
|
1154
|
+
- File patterns (strings containing ‘*’)
|
|
1155
|
+
- Explicit file paths (existing readable files)</p></li>
|
|
1156
|
+
<li><p><strong>cwd</strong> (<em>str</em><em> | </em><em>Path</em><em>, </em><em>optional</em>) – The directory where to look for files.
|
|
1157
|
+
Defaults to current directory.</p></li>
|
|
1158
|
+
</ul>
|
|
1159
|
+
</dd>
|
|
1160
|
+
</dl>
|
|
1161
|
+
<div class="admonition note">
|
|
1162
|
+
<p class="admonition-title">Note</p>
|
|
1163
|
+
<p>Files are added to the info_files list as FileStack objects.
|
|
1164
|
+
Only readable files are processed.</p>
|
|
1165
|
+
</div>
|
|
1166
|
+
</dd></dl>
|
|
1167
|
+
|
|
1168
|
+
<dl class="py attribute">
|
|
1169
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.model_config">
|
|
1170
|
+
<span class="sig-name descname"><span class="pre">model_config</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'extra':</span> <span class="pre">'allow'}</span></span><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.model_config" title="Link to this definition">¶</a></dt>
|
|
1171
|
+
<dd><p>Represents the results from a Simstack operation.</p>
|
|
1172
|
+
<p>This class serves to encapsulate the status, messages, and files resulting
|
|
1173
|
+
from a Simstack operation. It provides structured attributes for the error
|
|
1174
|
+
message, operation message, and categorized files, ensuring clarity in the
|
|
1175
|
+
representation of these aspects. It also supports additional fields through
|
|
1176
|
+
flexible configuration.</p>
|
|
1177
|
+
<dl class="field-list simple">
|
|
1178
|
+
<dt class="field-odd">Variables<span class="colon">:</span></dt>
|
|
1179
|
+
<dd class="field-odd"><ul class="simple">
|
|
1180
|
+
<li><p><strong>status</strong> – Indicates the status of the task, defaulting to <cite>TaskStatus.COMPLETED</cite>.</p></li>
|
|
1181
|
+
<li><p><strong>error_message</strong> – Optionally stores an error message if the task encountered issues.</p></li>
|
|
1182
|
+
<li><p><strong>message</strong> – An optional general message providing additional information about the task.</p></li>
|
|
1183
|
+
<li><p><strong>files</strong> – A list of <cite>FileStack</cite> objects that represent the primary files involved in
|
|
1184
|
+
the operation. Defaults to an empty list.</p></li>
|
|
1185
|
+
<li><p><strong>info_files</strong> – A list of <cite>FileStack</cite> objects that provide additional or informational
|
|
1186
|
+
files pertaining to the operation. Defaults to an empty list. These files are shown in the results
|
|
1187
|
+
but not passed to the calling function</p></li>
|
|
1188
|
+
</ul>
|
|
1189
|
+
</dd>
|
|
1190
|
+
</dl>
|
|
1191
|
+
</dd></dl>
|
|
1192
|
+
|
|
1193
|
+
<dl class="py method">
|
|
1194
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.submit_to_watchdog">
|
|
1195
|
+
<span class="sig-name descname"><span class="pre">submit_to_watchdog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">command</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.submit_to_watchdog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.submit_to_watchdog" title="Link to this definition">¶</a></dt>
|
|
1196
|
+
<dd><p>Submit a command to an external watchdog process for execution.</p>
|
|
1197
|
+
<p>This method prepares the necessary files and environment to submit a command
|
|
1198
|
+
to a watchdog process that will handle its execution. It uses a specified queue directory
|
|
1199
|
+
to manage job files and signals.</p>
|
|
1200
|
+
<dl class="field-list simple">
|
|
1201
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1202
|
+
<dd class="field-odd"><ul class="simple">
|
|
1203
|
+
<li><p><strong>name</strong> (<em>str</em>) – Name identifier for the watchdog job (used for log file naming).</p></li>
|
|
1204
|
+
<li><p><strong>command</strong> (<em>str</em>) – Command to be executed by the watchdog.</p></li>
|
|
1205
|
+
</ul>
|
|
1206
|
+
</dd>
|
|
1207
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1208
|
+
<dd class="field-even"><p>True if the submission and execution were successful, False otherwise.</p>
|
|
1209
|
+
</dd>
|
|
1210
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
1211
|
+
<dd class="field-odd"><p>bool</p>
|
|
1212
|
+
</dd>
|
|
1213
|
+
</dl>
|
|
1214
|
+
<div class="admonition note">
|
|
1215
|
+
<p class="admonition-title">Note</p>
|
|
1216
|
+
<ul class="simple">
|
|
1217
|
+
<li><p>The method sets the task status to FAILED if the submission or execution fails.</p></li>
|
|
1218
|
+
<li><p>Job logs are automatically added to the info_files collection.</p></li>
|
|
1219
|
+
</ul>
|
|
1220
|
+
</div>
|
|
1221
|
+
</dd></dl>
|
|
1222
|
+
|
|
1223
|
+
<dl class="py method">
|
|
1224
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.subprocess">
|
|
1225
|
+
<span class="sig-name descname"><span class="pre">subprocess</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">command</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cwd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.subprocess"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.subprocess" title="Link to this definition">¶</a></dt>
|
|
1226
|
+
<dd><p>Execute a shell command as a subprocess and capture its output.</p>
|
|
1227
|
+
<p>This method runs a shell command, captures stdout and stderr, creates a log file
|
|
1228
|
+
with the execution details, and adds the log file to the info_files collection.</p>
|
|
1229
|
+
<dl class="field-list simple">
|
|
1230
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1231
|
+
<dd class="field-odd"><ul class="simple">
|
|
1232
|
+
<li><p><strong>name</strong> (<em>str</em>) – Name identifier for the subprocess (used for log file naming)</p></li>
|
|
1233
|
+
<li><p><strong>command</strong> (<em>str</em>) – Shell command to execute</p></li>
|
|
1234
|
+
<li><p><strong>cwd</strong> (<em>str</em><em>, </em><em>optional</em>) – Working directory for command execution. Defaults to current directory.</p></li>
|
|
1235
|
+
</ul>
|
|
1236
|
+
</dd>
|
|
1237
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1238
|
+
<dd class="field-even"><p>True if the subprocess completed successfully (return code 0), False otherwise</p>
|
|
1239
|
+
</dd>
|
|
1240
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
1241
|
+
<dd class="field-odd"><p>bool</p>
|
|
1242
|
+
</dd>
|
|
1243
|
+
</dl>
|
|
1244
|
+
<div class="admonition note">
|
|
1245
|
+
<p class="admonition-title">Note</p>
|
|
1246
|
+
<ul class="simple">
|
|
1247
|
+
<li><p>Creates a log file named “{name}.log” containing command details and output</p></li>
|
|
1248
|
+
<li><p>Updates last_stdout and last_stderr attributes with the most recent output</p></li>
|
|
1249
|
+
<li><p>Log file is automatically added to info_files collection</p></li>
|
|
1250
|
+
</ul>
|
|
1251
|
+
</div>
|
|
1252
|
+
</dd></dl>
|
|
1253
|
+
|
|
1254
|
+
<dl class="py method">
|
|
1255
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.succeed">
|
|
1256
|
+
<span class="sig-name descname"><span class="pre">succeed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#simstack.core.node_runner.NodeRunner" title="simstack.core.node_runner.NodeRunner"><span class="pre">NodeRunner</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.succeed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.succeed" title="Link to this definition">¶</a></dt>
|
|
1257
|
+
<dd><p>Mark the task as successfully completed.</p>
|
|
1258
|
+
<p>This method updates the task status to COMPLETED, sets an optional
|
|
1259
|
+
success message, logs the success, and ensures the cumulative log file is created.</p>
|
|
1260
|
+
<dl class="field-list simple">
|
|
1261
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1262
|
+
<dd class="field-odd"><p><strong>msg</strong> (<em>str</em><em>, </em><em>optional</em>) – Success message. Defaults to “”.</p>
|
|
1263
|
+
</dd>
|
|
1264
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1265
|
+
<dd class="field-even"><p>Self reference for chaining.</p>
|
|
1266
|
+
</dd>
|
|
1267
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
1268
|
+
<dd class="field-odd"><p><a class="reference internal" href="#simstack.core.node_runner.NodeRunner" title="simstack.core.node_runner.NodeRunner">NodeRunner</a></p>
|
|
1269
|
+
</dd>
|
|
1270
|
+
</dl>
|
|
1271
|
+
</dd></dl>
|
|
1272
|
+
|
|
1273
|
+
<dl class="py method">
|
|
1274
|
+
<dt class="sig sig-object py" id="simstack.core.node_runner.NodeRunner.warning">
|
|
1275
|
+
<span class="sig-name descname"><span class="pre">warning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/node_runner.html#NodeRunner.warning"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.node_runner.NodeRunner.warning" title="Link to this definition">¶</a></dt>
|
|
1276
|
+
<dd><p>Log a warning message with task context.</p>
|
|
1277
|
+
<dl class="field-list simple">
|
|
1278
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1279
|
+
<dd class="field-odd"><p><strong>msg</strong> (<em>str</em>) – Warning message to log.</p>
|
|
1280
|
+
</dd>
|
|
1281
|
+
</dl>
|
|
1282
|
+
</dd></dl>
|
|
1283
|
+
|
|
1284
|
+
</dd></dl>
|
|
1285
|
+
|
|
1286
|
+
</section>
|
|
1287
|
+
<section id="module-simstack.core.process_results">
|
|
1288
|
+
<span id="simstack-core-process-results-module"></span><h2>simstack.core.process_results module<a class="headerlink" href="#module-simstack.core.process_results" title="Link to this heading">¶</a></h2>
|
|
1289
|
+
<dl class="py function">
|
|
1290
|
+
<dt class="sig sig-object py" id="simstack.core.process_results.process_result_helper">
|
|
1291
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.process_results.</span></span><span class="sig-name descname"><span class="pre">process_result_helper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult" title="simstack.core.simstack_result.SimstackResult"><span class="pre">SimstackResult</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Model</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="simstack.models.html#simstack.models.base_types.BooleanData" title="simstack.models.base_types.BooleanData"><span class="pre">BooleanData</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'NA'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.named_data_reference.NamedDataReference" title="simstack.models.named_data_reference.NamedDataReference"><span class="pre">NamedDataReference</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Model</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/simstack/core/process_results.html#process_result_helper"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.process_results.process_result_helper" title="Link to this definition">¶</a></dt>
|
|
1292
|
+
<dd><p>Computes the results_references and returns a List[Model].
|
|
1293
|
+
It works if the result is a SimstackResult, a single Model or a bool.</p>
|
|
1294
|
+
</dd></dl>
|
|
1295
|
+
|
|
1296
|
+
</section>
|
|
1297
|
+
<section id="module-simstack.core.recompute_artifacts">
|
|
1298
|
+
<span id="simstack-core-recompute-artifacts-module"></span><h2>simstack.core.recompute_artifacts module<a class="headerlink" href="#module-simstack.core.recompute_artifacts" title="Link to this heading">¶</a></h2>
|
|
1299
|
+
<dl class="py function">
|
|
1300
|
+
<dt class="sig sig-object py" id="simstack.core.recompute_artifacts.recompute_artifacts">
|
|
1301
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.recompute_artifacts.</span></span><span class="sig-name descname"><span class="pre">recompute_artifacts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node_registry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><span class="pre">NodeRegistry</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/recompute_artifacts.html#recompute_artifacts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.recompute_artifacts.recompute_artifacts" title="Link to this definition">¶</a></dt>
|
|
1302
|
+
<dd><p>Recomputes artifacts for a node and all its children recursively.</p>
|
|
1303
|
+
<p>First processes all children nodes recursively, then removes and recomputes
|
|
1304
|
+
the current node’s artifacts.</p>
|
|
1305
|
+
<dl class="field-list simple">
|
|
1306
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1307
|
+
<dd class="field-odd"><p><strong>node_registry</strong> (<a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><em>NodeRegistry</em></a>) – The registry entry for the node to process</p>
|
|
1308
|
+
</dd>
|
|
1309
|
+
</dl>
|
|
1310
|
+
</dd></dl>
|
|
1311
|
+
|
|
1312
|
+
</section>
|
|
1313
|
+
<section id="module-simstack.core.reset_db">
|
|
1314
|
+
<span id="simstack-core-reset-db-module"></span><h2>simstack.core.reset_db module<a class="headerlink" href="#module-simstack.core.reset_db" title="Link to this heading">¶</a></h2>
|
|
1315
|
+
<dl class="py function">
|
|
1316
|
+
<dt class="sig sig-object py" id="simstack.core.reset_db.main">
|
|
1317
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.reset_db.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/reset_db.html#main"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.reset_db.main" title="Link to this definition">¶</a></dt>
|
|
1318
|
+
<dd></dd></dl>
|
|
1319
|
+
|
|
1320
|
+
</section>
|
|
1321
|
+
<section id="module-simstack.core.resource_assignment">
|
|
1322
|
+
<span id="simstack-core-resource-assignment-module"></span><h2>simstack.core.resource_assignment module<a class="headerlink" href="#module-simstack.core.resource_assignment" title="Link to this heading">¶</a></h2>
|
|
1323
|
+
<dl class="py class">
|
|
1324
|
+
<dt class="sig sig-object py" id="simstack.core.resource_assignment.ResourceAssignmentResolution">
|
|
1325
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.resource_assignment.</span></span><span class="sig-name descname"><span class="pre">ResourceAssignmentResolution</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.parameters.Parameters" title="simstack.models.parameters.Parameters"><span class="pre">simstack.models.parameters.Parameters</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalized_call_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">matched_rule</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.resource_assignment.ResourceAssignmentRule" title="simstack.models.resource_assignment.ResourceAssignmentRule"><span class="pre">simstack.models.resource_assignment.ResourceAssignmentRule</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/resource_assignment.html#ResourceAssignmentResolution"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resource_assignment.ResourceAssignmentResolution" title="Link to this definition">¶</a></dt>
|
|
1326
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
1327
|
+
<dl class="py attribute">
|
|
1328
|
+
<dt class="sig sig-object py" id="simstack.core.resource_assignment.ResourceAssignmentResolution.matched_rule">
|
|
1329
|
+
<span class="sig-name descname"><span class="pre">matched_rule</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="simstack.models.html#simstack.models.resource_assignment.ResourceAssignmentRule" title="simstack.models.resource_assignment.ResourceAssignmentRule"><span class="pre">ResourceAssignmentRule</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#simstack.core.resource_assignment.ResourceAssignmentResolution.matched_rule" title="Link to this definition">¶</a></dt>
|
|
1330
|
+
<dd></dd></dl>
|
|
1331
|
+
|
|
1332
|
+
<dl class="py attribute">
|
|
1333
|
+
<dt class="sig sig-object py" id="simstack.core.resource_assignment.ResourceAssignmentResolution.normalized_call_path">
|
|
1334
|
+
<span class="sig-name descname"><span class="pre">normalized_call_path</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></span><a class="headerlink" href="#simstack.core.resource_assignment.ResourceAssignmentResolution.normalized_call_path" title="Link to this definition">¶</a></dt>
|
|
1335
|
+
<dd></dd></dl>
|
|
1336
|
+
|
|
1337
|
+
<dl class="py attribute">
|
|
1338
|
+
<dt class="sig sig-object py" id="simstack.core.resource_assignment.ResourceAssignmentResolution.parameters">
|
|
1339
|
+
<span class="sig-name descname"><span class="pre">parameters</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="simstack.models.html#simstack.models.parameters.Parameters" title="simstack.models.parameters.Parameters"><span class="pre">Parameters</span></a></span><a class="headerlink" href="#simstack.core.resource_assignment.ResourceAssignmentResolution.parameters" title="Link to this definition">¶</a></dt>
|
|
1340
|
+
<dd></dd></dl>
|
|
1341
|
+
|
|
1342
|
+
</dd></dl>
|
|
1343
|
+
|
|
1344
|
+
<dl class="py function">
|
|
1345
|
+
<dt class="sig sig-object py" id="simstack.core.resource_assignment.apply_resource_assignment_to_node_registry">
|
|
1346
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.resource_assignment.</span></span><span class="sig-name descname"><span class="pre">apply_resource_assignment_to_node_registry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.util.html#simstack.util.db.Database" title="simstack.util.db.Database"><span class="pre">Database</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">node_registry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><span class="pre">NodeRegistry</span></a></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_parameters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.parameters.Parameters" title="simstack.models.parameters.Parameters"><span class="pre">Parameters</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#simstack.core.resource_assignment.ResourceAssignmentResolution" title="simstack.core.resource_assignment.ResourceAssignmentResolution"><span class="pre">ResourceAssignmentResolution</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/resource_assignment.html#apply_resource_assignment_to_node_registry"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resource_assignment.apply_resource_assignment_to_node_registry" title="Link to this definition">¶</a></dt>
|
|
1347
|
+
<dd></dd></dl>
|
|
1348
|
+
|
|
1349
|
+
<dl class="py function">
|
|
1350
|
+
<dt class="sig sig-object py" id="simstack.core.resource_assignment.empty_slurm_parameters">
|
|
1351
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.resource_assignment.</span></span><span class="sig-name descname"><span class="pre">empty_slurm_parameters</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="simstack.models.html#simstack.models.parameters.SlurmParameters" title="simstack.models.parameters.SlurmParameters"><span class="pre">SlurmParameters</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/resource_assignment.html#empty_slurm_parameters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resource_assignment.empty_slurm_parameters" title="Link to this definition">¶</a></dt>
|
|
1352
|
+
<dd></dd></dl>
|
|
1353
|
+
|
|
1354
|
+
<dl class="py function">
|
|
1355
|
+
<dt class="sig sig-object py" id="simstack.core.resource_assignment.normalize_and_validate_effective_parameters">
|
|
1356
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.resource_assignment.</span></span><span class="sig-name descname"><span class="pre">normalize_and_validate_effective_parameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.parameters.Parameters" title="simstack.models.parameters.Parameters"><span class="pre">Parameters</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/resource_assignment.html#normalize_and_validate_effective_parameters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resource_assignment.normalize_and_validate_effective_parameters" title="Link to this definition">¶</a></dt>
|
|
1357
|
+
<dd></dd></dl>
|
|
1358
|
+
|
|
1359
|
+
<dl class="py function">
|
|
1360
|
+
<dt class="sig sig-object py" id="simstack.core.resource_assignment.normalize_call_path">
|
|
1361
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.resource_assignment.</span></span><span class="sig-name descname"><span class="pre">normalize_call_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">call_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/simstack/core/resource_assignment.html#normalize_call_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resource_assignment.normalize_call_path" title="Link to this definition">¶</a></dt>
|
|
1362
|
+
<dd></dd></dl>
|
|
1363
|
+
|
|
1364
|
+
<dl class="py function">
|
|
1365
|
+
<dt class="sig sig-object py" id="simstack.core.resource_assignment.resolve_resource_assignment">
|
|
1366
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.resource_assignment.</span></span><span class="sig-name descname"><span class="pre">resolve_resource_assignment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.util.html#simstack.util.db.Database" title="simstack.util.db.Database"><span class="pre">Database</span></a></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">call_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_parameters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.parameters.Parameters" title="simstack.models.parameters.Parameters"><span class="pre">Parameters</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_parameters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.parameters.Parameters" title="simstack.models.parameters.Parameters"><span class="pre">Parameters</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#simstack.core.resource_assignment.ResourceAssignmentResolution" title="simstack.core.resource_assignment.ResourceAssignmentResolution"><span class="pre">ResourceAssignmentResolution</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/resource_assignment.html#resolve_resource_assignment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resource_assignment.resolve_resource_assignment" title="Link to this definition">¶</a></dt>
|
|
1367
|
+
<dd></dd></dl>
|
|
1368
|
+
|
|
1369
|
+
</section>
|
|
1370
|
+
<section id="module-simstack.core.resources">
|
|
1371
|
+
<span id="simstack-core-resources-module"></span><h2>simstack.core.resources module<a class="headerlink" href="#module-simstack.core.resources" title="Link to this heading">¶</a></h2>
|
|
1372
|
+
<dl class="py class">
|
|
1373
|
+
<dt class="sig sig-object py" id="simstack.core.resources.AllowedResources">
|
|
1374
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.resources.</span></span><span class="sig-name descname"><span class="pre">AllowedResources</span></span><a class="reference internal" href="../../_modules/simstack/core/resources.html#AllowedResources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resources.AllowedResources" title="Link to this definition">¶</a></dt>
|
|
1375
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
1376
|
+
<p>Singleton class that holds a list of allowed resource strings.</p>
|
|
1377
|
+
<p>This class is problematic because the @node decorator is called before the config is read.
|
|
1378
|
+
@node may contain Parameters which set default values for resources.
|
|
1379
|
+
The solution is to create the AllowedResources singleton class here, and set the resources from
|
|
1380
|
+
context.initialize. Before context.initialize is called, any resource is allowed.</p>
|
|
1381
|
+
<p>However, resources are validated on read, so before any node is executed, the resources must be set.
|
|
1382
|
+
AllowedResources can be set only once.</p>
|
|
1383
|
+
<dl class="py method">
|
|
1384
|
+
<dt class="sig sig-object py" id="simstack.core.resources.AllowedResources.add_resource">
|
|
1385
|
+
<span class="sig-name descname"><span class="pre">add_resource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/resources.html#AllowedResources.add_resource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resources.AllowedResources.add_resource" title="Link to this definition">¶</a></dt>
|
|
1386
|
+
<dd><p>Add a single resource to the list.</p>
|
|
1387
|
+
</dd></dl>
|
|
1388
|
+
|
|
1389
|
+
<dl class="py method">
|
|
1390
|
+
<dt class="sig sig-object py" id="simstack.core.resources.AllowedResources.clear_resources">
|
|
1391
|
+
<span class="sig-name descname"><span class="pre">clear_resources</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/resources.html#AllowedResources.clear_resources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resources.AllowedResources.clear_resources" title="Link to this definition">¶</a></dt>
|
|
1392
|
+
<dd><p>Clear all resources from the list.</p>
|
|
1393
|
+
</dd></dl>
|
|
1394
|
+
|
|
1395
|
+
<dl class="py method">
|
|
1396
|
+
<dt class="sig sig-object py" id="simstack.core.resources.AllowedResources.get_resources">
|
|
1397
|
+
<span class="sig-name descname"><span class="pre">get_resources</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/simstack/core/resources.html#AllowedResources.get_resources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resources.AllowedResources.get_resources" title="Link to this definition">¶</a></dt>
|
|
1398
|
+
<dd><p>Get the list of allowed resources.</p>
|
|
1399
|
+
</dd></dl>
|
|
1400
|
+
|
|
1401
|
+
<dl class="py method">
|
|
1402
|
+
<dt class="sig sig-object py" id="simstack.core.resources.AllowedResources.has_resource">
|
|
1403
|
+
<span class="sig-name descname"><span class="pre">has_resource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../../_modules/simstack/core/resources.html#AllowedResources.has_resource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resources.AllowedResources.has_resource" title="Link to this definition">¶</a></dt>
|
|
1404
|
+
<dd><p>Check if a resource exists in the list.</p>
|
|
1405
|
+
</dd></dl>
|
|
1406
|
+
|
|
1407
|
+
<dl class="py property">
|
|
1408
|
+
<dt class="sig sig-object py" id="simstack.core.resources.AllowedResources.initialized">
|
|
1409
|
+
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">initialized</span></span><a class="headerlink" href="#simstack.core.resources.AllowedResources.initialized" title="Link to this definition">¶</a></dt>
|
|
1410
|
+
<dd></dd></dl>
|
|
1411
|
+
|
|
1412
|
+
<dl class="py method">
|
|
1413
|
+
<dt class="sig sig-object py" id="simstack.core.resources.AllowedResources.remove_resource">
|
|
1414
|
+
<span class="sig-name descname"><span class="pre">remove_resource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/resources.html#AllowedResources.remove_resource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resources.AllowedResources.remove_resource" title="Link to this definition">¶</a></dt>
|
|
1415
|
+
<dd></dd></dl>
|
|
1416
|
+
|
|
1417
|
+
<dl class="py method">
|
|
1418
|
+
<dt class="sig sig-object py" id="simstack.core.resources.AllowedResources.set_resources">
|
|
1419
|
+
<span class="sig-name descname"><span class="pre">set_resources</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resources</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/resources.html#AllowedResources.set_resources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.resources.AllowedResources.set_resources" title="Link to this definition">¶</a></dt>
|
|
1420
|
+
<dd><p>Set the list of allowed resources.</p>
|
|
1421
|
+
</dd></dl>
|
|
1422
|
+
|
|
1423
|
+
</dd></dl>
|
|
1424
|
+
|
|
1425
|
+
</section>
|
|
1426
|
+
<section id="module-simstack.core.route_table">
|
|
1427
|
+
<span id="simstack-core-route-table-module"></span><h2>simstack.core.route_table module<a class="headerlink" href="#module-simstack.core.route_table" title="Link to this heading">¶</a></h2>
|
|
1428
|
+
<dl class="py class">
|
|
1429
|
+
<dt class="sig sig-object py" id="simstack.core.route_table.RouteTable">
|
|
1430
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.route_table.</span></span><span class="sig-name descname"><span class="pre">RouteTable</span></span><a class="reference internal" href="../../_modules/simstack/core/route_table.html#RouteTable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.route_table.RouteTable" title="Link to this definition">¶</a></dt>
|
|
1431
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
1432
|
+
<dl class="py method">
|
|
1433
|
+
<dt class="sig sig-object py" id="simstack.core.route_table.RouteTable.add_route_set">
|
|
1434
|
+
<span class="sig-name descname"><span class="pre">add_route_set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">targets</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/route_table.html#RouteTable.add_route_set"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.route_table.RouteTable.add_route_set" title="Link to this definition">¶</a></dt>
|
|
1435
|
+
<dd></dd></dl>
|
|
1436
|
+
|
|
1437
|
+
<dl class="py method">
|
|
1438
|
+
<dt class="sig sig-object py" id="simstack.core.route_table.RouteTable.clear_routes">
|
|
1439
|
+
<span class="sig-name descname"><span class="pre">clear_routes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/route_table.html#RouteTable.clear_routes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.route_table.RouteTable.clear_routes" title="Link to this definition">¶</a></dt>
|
|
1440
|
+
<dd></dd></dl>
|
|
1441
|
+
|
|
1442
|
+
<dl class="py method">
|
|
1443
|
+
<dt class="sig sig-object py" id="simstack.core.route_table.RouteTable.get_instance">
|
|
1444
|
+
<span class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">get_instance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#simstack.core.route_table.RouteTable" title="simstack.core.route_table.RouteTable"><span class="pre">RouteTable</span></a></span></span><a class="reference internal" href="../../_modules/simstack/core/route_table.html#RouteTable.get_instance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.route_table.RouteTable.get_instance" title="Link to this definition">¶</a></dt>
|
|
1445
|
+
<dd></dd></dl>
|
|
1446
|
+
|
|
1447
|
+
</dd></dl>
|
|
1448
|
+
|
|
1449
|
+
</section>
|
|
1450
|
+
<section id="module-simstack.core.run_docker">
|
|
1451
|
+
<span id="simstack-core-run-docker-module"></span><h2>simstack.core.run_docker module<a class="headerlink" href="#module-simstack.core.run_docker" title="Link to this heading">¶</a></h2>
|
|
1452
|
+
<dl class="py function">
|
|
1453
|
+
<dt class="sig sig-object py" id="simstack.core.run_docker.run_docker">
|
|
1454
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.run_docker.</span></span><span class="sig-name descname"><span class="pre">run_docker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><span class="pre">NodeRegistry</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../../_modules/simstack/core/run_docker.html#run_docker"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.run_docker.run_docker" title="Link to this definition">¶</a></dt>
|
|
1455
|
+
<dd></dd></dl>
|
|
1456
|
+
|
|
1457
|
+
</section>
|
|
1458
|
+
<section id="module-simstack.core.run_node">
|
|
1459
|
+
<span id="simstack-core-run-node-module"></span><h2>simstack.core.run_node module<a class="headerlink" href="#module-simstack.core.run_node" title="Link to this heading">¶</a></h2>
|
|
1460
|
+
<dl class="py function">
|
|
1461
|
+
<dt class="sig sig-object py" id="simstack.core.run_node.run_node_from_id">
|
|
1462
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.run_node.</span></span><span class="sig-name descname"><span class="pre">run_node_from_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_str</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_root</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/run_node.html#run_node_from_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.run_node.run_node_from_id" title="Link to this definition">¶</a></dt>
|
|
1463
|
+
<dd><p>Run a single node by its ID from the database</p>
|
|
1464
|
+
</dd></dl>
|
|
1465
|
+
|
|
1466
|
+
<dl class="py function">
|
|
1467
|
+
<dt class="sig sig-object py" id="simstack.core.run_node.run_node_main">
|
|
1468
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.run_node.</span></span><span class="sig-name descname"><span class="pre">run_node_main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/run_node.html#run_node_main"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.run_node.run_node_main" title="Link to this definition">¶</a></dt>
|
|
1469
|
+
<dd></dd></dl>
|
|
1470
|
+
|
|
1471
|
+
</section>
|
|
1472
|
+
<section id="module-simstack.core.runner">
|
|
1473
|
+
<span id="simstack-core-runner-module"></span><h2>simstack.core.runner module<a class="headerlink" href="#module-simstack.core.runner" title="Link to this heading">¶</a></h2>
|
|
1474
|
+
<dl class="py function">
|
|
1475
|
+
<dt class="sig sig-object py" id="simstack.core.runner.async_main">
|
|
1476
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.runner.</span></span><span class="sig-name descname"><span class="pre">async_main</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Namespace</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/runner.html#async_main"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.runner.async_main" title="Link to this definition">¶</a></dt>
|
|
1477
|
+
<dd><p>Async entry point</p>
|
|
1478
|
+
</dd></dl>
|
|
1479
|
+
|
|
1480
|
+
<dl class="py function">
|
|
1481
|
+
<dt class="sig sig-object py" id="simstack.core.runner.initialize_default_resource">
|
|
1482
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.runner.</span></span><span class="sig-name descname"><span class="pre">initialize_default_resource</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="simstack.models.html#simstack.models.resource_definition.ResourceDefinition" title="simstack.models.resource_definition.ResourceDefinition"><span class="pre">ResourceDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/runner.html#initialize_default_resource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.runner.initialize_default_resource" title="Link to this definition">¶</a></dt>
|
|
1483
|
+
<dd><p>Checks if the current resource is the default one.
|
|
1484
|
+
If so, syncs the node and model tables based on config.toml.</p>
|
|
1485
|
+
</dd></dl>
|
|
1486
|
+
|
|
1487
|
+
<dl class="py function">
|
|
1488
|
+
<dt class="sig sig-object py" id="simstack.core.runner.runner_main">
|
|
1489
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.runner.</span></span><span class="sig-name descname"><span class="pre">runner_main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/runner.html#runner_main"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.runner.runner_main" title="Link to this definition">¶</a></dt>
|
|
1490
|
+
<dd></dd></dl>
|
|
1491
|
+
|
|
1492
|
+
</section>
|
|
1493
|
+
<section id="module-simstack.core.simstack_result">
|
|
1494
|
+
<span id="simstack-core-simstack-result-module"></span><h2>simstack.core.simstack_result module<a class="headerlink" href="#module-simstack.core.simstack_result" title="Link to this heading">¶</a></h2>
|
|
1495
|
+
<dl class="py class">
|
|
1496
|
+
<dt class="sig sig-object py" id="simstack.core.simstack_result.SimstackResult">
|
|
1497
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.simstack_result.</span></span><span class="sig-name descname"><span class="pre">SimstackResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#simstack.core.definitions.TaskStatus" title="simstack.core.definitions.TaskStatus"><span class="pre">TaskStatus</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">TaskStatus.RETRIEVED</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.files.FileStack" title="simstack.models.files.FileStack"><span class="pre">FileStack</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info_files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.files.FileStack" title="simstack.models.files.FileStack"><span class="pre">FileStack</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**extra_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/simstack/core/simstack_result.html#SimstackResult"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.simstack_result.SimstackResult" title="Link to this definition">¶</a></dt>
|
|
1498
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></p>
|
|
1499
|
+
<dl class="py attribute">
|
|
1500
|
+
<dt class="sig sig-object py" id="simstack.core.simstack_result.SimstackResult.error_message">
|
|
1501
|
+
<span class="sig-name descname"><span class="pre">error_message</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#simstack.core.simstack_result.SimstackResult.error_message" title="Link to this definition">¶</a></dt>
|
|
1502
|
+
<dd></dd></dl>
|
|
1503
|
+
|
|
1504
|
+
<dl class="py attribute">
|
|
1505
|
+
<dt class="sig sig-object py" id="simstack.core.simstack_result.SimstackResult.files">
|
|
1506
|
+
<span class="sig-name descname"><span class="pre">files</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.files.FileStack" title="simstack.models.files.FileStack"><span class="pre">FileStack</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#simstack.core.simstack_result.SimstackResult.files" title="Link to this definition">¶</a></dt>
|
|
1507
|
+
<dd></dd></dl>
|
|
1508
|
+
|
|
1509
|
+
<dl class="py attribute">
|
|
1510
|
+
<dt class="sig sig-object py" id="simstack.core.simstack_result.SimstackResult.info_files">
|
|
1511
|
+
<span class="sig-name descname"><span class="pre">info_files</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="simstack.models.html#simstack.models.files.FileStack" title="simstack.models.files.FileStack"><span class="pre">FileStack</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#simstack.core.simstack_result.SimstackResult.info_files" title="Link to this definition">¶</a></dt>
|
|
1512
|
+
<dd></dd></dl>
|
|
1513
|
+
|
|
1514
|
+
<dl class="py attribute">
|
|
1515
|
+
<dt class="sig sig-object py" id="simstack.core.simstack_result.SimstackResult.message">
|
|
1516
|
+
<span class="sig-name descname"><span class="pre">message</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#simstack.core.simstack_result.SimstackResult.message" title="Link to this definition">¶</a></dt>
|
|
1517
|
+
<dd></dd></dl>
|
|
1518
|
+
|
|
1519
|
+
<dl class="py attribute">
|
|
1520
|
+
<dt class="sig sig-object py" id="simstack.core.simstack_result.SimstackResult.model_config">
|
|
1521
|
+
<span class="sig-name descname"><span class="pre">model_config</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'extra':</span> <span class="pre">'allow'}</span></span><a class="headerlink" href="#simstack.core.simstack_result.SimstackResult.model_config" title="Link to this definition">¶</a></dt>
|
|
1522
|
+
<dd><p>Represents the results from a Simstack operation.</p>
|
|
1523
|
+
<p>This class serves to encapsulate the status, messages, and files resulting
|
|
1524
|
+
from a Simstack operation. It provides structured attributes for the error
|
|
1525
|
+
message, operation message, and categorized files, ensuring clarity in the
|
|
1526
|
+
representation of these aspects. It also supports additional fields through
|
|
1527
|
+
flexible configuration.</p>
|
|
1528
|
+
<dl class="field-list simple">
|
|
1529
|
+
<dt class="field-odd">Variables<span class="colon">:</span></dt>
|
|
1530
|
+
<dd class="field-odd"><ul class="simple">
|
|
1531
|
+
<li><p><strong>status</strong> – Indicates the status of the task, defaulting to <cite>TaskStatus.COMPLETED</cite>.</p></li>
|
|
1532
|
+
<li><p><strong>error_message</strong> – Optionally stores an error message if the task encountered issues.</p></li>
|
|
1533
|
+
<li><p><strong>message</strong> – An optional general message providing additional information about the task.</p></li>
|
|
1534
|
+
<li><p><strong>files</strong> – A list of <cite>FileStack</cite> objects that represent the primary files involved in
|
|
1535
|
+
the operation. Defaults to an empty list.</p></li>
|
|
1536
|
+
<li><p><strong>info_files</strong> – A list of <cite>FileStack</cite> objects that provide additional or informational
|
|
1537
|
+
files pertaining to the operation. Defaults to an empty list. These files are shown in the results
|
|
1538
|
+
but not passed to the calling function</p></li>
|
|
1539
|
+
</ul>
|
|
1540
|
+
</dd>
|
|
1541
|
+
</dl>
|
|
1542
|
+
</dd></dl>
|
|
1543
|
+
|
|
1544
|
+
<dl class="py attribute">
|
|
1545
|
+
<dt class="sig sig-object py" id="simstack.core.simstack_result.SimstackResult.status">
|
|
1546
|
+
<span class="sig-name descname"><span class="pre">status</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#simstack.core.definitions.TaskStatus" title="simstack.core.definitions.TaskStatus"><span class="pre">TaskStatus</span></a></span><a class="headerlink" href="#simstack.core.simstack_result.SimstackResult.status" title="Link to this definition">¶</a></dt>
|
|
1547
|
+
<dd></dd></dl>
|
|
1548
|
+
|
|
1549
|
+
</dd></dl>
|
|
1550
|
+
|
|
1551
|
+
</section>
|
|
1552
|
+
<section id="module-simstack.core.submit_node">
|
|
1553
|
+
<span id="simstack-core-submit-node-module"></span><h2>simstack.core.submit_node module<a class="headerlink" href="#module-simstack.core.submit_node" title="Link to this heading">¶</a></h2>
|
|
1554
|
+
<dl class="py function">
|
|
1555
|
+
<dt class="sig sig-object py" id="simstack.core.submit_node.make_executable">
|
|
1556
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.submit_node.</span></span><span class="sig-name descname"><span class="pre">make_executable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PathLike</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/submit_node.html#make_executable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.submit_node.make_executable" title="Link to this definition">¶</a></dt>
|
|
1557
|
+
<dd></dd></dl>
|
|
1558
|
+
|
|
1559
|
+
<dl class="py function">
|
|
1560
|
+
<dt class="sig sig-object py" id="simstack.core.submit_node.submit_node">
|
|
1561
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">simstack.core.submit_node.</span></span><span class="sig-name descname"><span class="pre">submit_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="simstack.models.html#simstack.models.node_registry.NodeRegistry" title="simstack.models.node_registry.NodeRegistry"><span class="pre">NodeRegistry</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../../_modules/simstack/core/submit_node.html#submit_node"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.submit_node.submit_node" title="Link to this definition">¶</a></dt>
|
|
1562
|
+
<dd><p>Submit a node to the SLURM queue</p>
|
|
1563
|
+
</dd></dl>
|
|
1564
|
+
|
|
1565
|
+
</section>
|
|
1566
|
+
<section id="module-simstack.core.task_id">
|
|
1567
|
+
<span id="simstack-core-task-id-module"></span><h2>simstack.core.task_id module<a class="headerlink" href="#module-simstack.core.task_id" title="Link to this heading">¶</a></h2>
|
|
1568
|
+
<dl class="py function">
|
|
1569
|
+
<dt class="sig sig-object py" id="simstack.core.task_id.clear_task_id">
|
|
1570
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.task_id.</span></span><span class="sig-name descname"><span class="pre">clear_task_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/task_id.html#clear_task_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.task_id.clear_task_id" title="Link to this definition">¶</a></dt>
|
|
1571
|
+
<dd><p>Clear the current task ID.</p>
|
|
1572
|
+
</dd></dl>
|
|
1573
|
+
|
|
1574
|
+
<dl class="py function">
|
|
1575
|
+
<dt class="sig sig-object py" id="simstack.core.task_id.get_task_id">
|
|
1576
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.task_id.</span></span><span class="sig-name descname"><span class="pre">get_task_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ObjectId</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/task_id.html#get_task_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.task_id.get_task_id" title="Link to this definition">¶</a></dt>
|
|
1577
|
+
<dd><p>Get the current task ID.</p>
|
|
1578
|
+
</dd></dl>
|
|
1579
|
+
|
|
1580
|
+
<dl class="py function">
|
|
1581
|
+
<dt class="sig sig-object py" id="simstack.core.task_id.set_task_id">
|
|
1582
|
+
<span class="sig-prename descclassname"><span class="pre">simstack.core.task_id.</span></span><span class="sig-name descname"><span class="pre">set_task_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ObjectId</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/simstack/core/task_id.html#set_task_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#simstack.core.task_id.set_task_id" title="Link to this definition">¶</a></dt>
|
|
1583
|
+
<dd><p>Set the current task ID.</p>
|
|
1584
|
+
</dd></dl>
|
|
1585
|
+
|
|
1586
|
+
</section>
|
|
1587
|
+
<section id="module-simstack.core">
|
|
1588
|
+
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-simstack.core" title="Link to this heading">¶</a></h2>
|
|
1589
|
+
</section>
|
|
1590
|
+
</section>
|
|
1591
|
+
|
|
1592
|
+
</article>
|
|
1593
|
+
</div>
|
|
1594
|
+
<footer>
|
|
1595
|
+
|
|
1596
|
+
<div class="related-pages">
|
|
1597
|
+
<a class="next-page" href="simstack.core.services.html">
|
|
1598
|
+
<div class="page-info">
|
|
1599
|
+
<div class="context">
|
|
1600
|
+
<span>Next</span>
|
|
1601
|
+
</div>
|
|
1602
|
+
<div class="title">simstack.core.services package</div>
|
|
1603
|
+
</div>
|
|
1604
|
+
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
|
1605
|
+
</a>
|
|
1606
|
+
<a class="prev-page" href="simstack.html">
|
|
1607
|
+
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
|
1608
|
+
<div class="page-info">
|
|
1609
|
+
<div class="context">
|
|
1610
|
+
<span>Previous</span>
|
|
1611
|
+
</div>
|
|
1612
|
+
|
|
1613
|
+
<div class="title">simstack package</div>
|
|
1614
|
+
|
|
1615
|
+
</div>
|
|
1616
|
+
</a>
|
|
1617
|
+
</div>
|
|
1618
|
+
<div class="bottom-of-page">
|
|
1619
|
+
<div class="left-details">
|
|
1620
|
+
<div class="copyright">
|
|
1621
|
+
Copyright © 2026, Wolfgang Wenzel
|
|
1622
|
+
</div>
|
|
1623
|
+
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
|
1624
|
+
|
|
1625
|
+
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
|
1626
|
+
|
|
1627
|
+
</div>
|
|
1628
|
+
<div class="right-details">
|
|
1629
|
+
|
|
1630
|
+
</div>
|
|
1631
|
+
</div>
|
|
1632
|
+
|
|
1633
|
+
</footer>
|
|
1634
|
+
</div>
|
|
1635
|
+
<aside class="toc-drawer">
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
<div class="toc-sticky toc-scroll">
|
|
1639
|
+
<div class="toc-title-container">
|
|
1640
|
+
<span class="toc-title">
|
|
1641
|
+
On this page
|
|
1642
|
+
</span>
|
|
1643
|
+
</div>
|
|
1644
|
+
<div class="toc-tree-container">
|
|
1645
|
+
<div class="toc-tree">
|
|
1646
|
+
<ul>
|
|
1647
|
+
<li><a class="reference internal" href="#">simstack.core package</a><ul>
|
|
1648
|
+
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
|
1649
|
+
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
|
1650
|
+
<li><a class="reference internal" href="#module-simstack.core.artifacts">simstack.core.artifacts module</a><ul>
|
|
1651
|
+
<li><a class="reference internal" href="#simstack.core.artifacts.ArtifactArguments"><code class="docutils literal notranslate"><span class="pre">ArtifactArguments</span></code></a><ul>
|
|
1652
|
+
<li><a class="reference internal" href="#simstack.core.artifacts.ArtifactArguments.add_attributes"><code class="docutils literal notranslate"><span class="pre">ArtifactArguments.add_attributes()</span></code></a></li>
|
|
1653
|
+
</ul>
|
|
1654
|
+
</li>
|
|
1655
|
+
<li><a class="reference internal" href="#simstack.core.artifacts.create_artifacts"><code class="docutils literal notranslate"><span class="pre">create_artifacts()</span></code></a></li>
|
|
1656
|
+
<li><a class="reference internal" href="#simstack.core.artifacts.find_all_artifacts"><code class="docutils literal notranslate"><span class="pre">find_all_artifacts()</span></code></a></li>
|
|
1657
|
+
<li><a class="reference internal" href="#simstack.core.artifacts.find_artifact_mappings"><code class="docutils literal notranslate"><span class="pre">find_artifact_mappings()</span></code></a></li>
|
|
1658
|
+
<li><a class="reference internal" href="#simstack.core.artifacts.find_artifacts"><code class="docutils literal notranslate"><span class="pre">find_artifacts()</span></code></a></li>
|
|
1659
|
+
<li><a class="reference internal" href="#simstack.core.artifacts.register_artifact_mapping"><code class="docutils literal notranslate"><span class="pre">register_artifact_mapping()</span></code></a></li>
|
|
1660
|
+
<li><a class="reference internal" href="#simstack.core.artifacts.save_artifact_model"><code class="docutils literal notranslate"><span class="pre">save_artifact_model()</span></code></a></li>
|
|
1661
|
+
</ul>
|
|
1662
|
+
</li>
|
|
1663
|
+
<li><a class="reference internal" href="#module-simstack.core.asnyc_helper">simstack.core.asnyc_helper module</a><ul>
|
|
1664
|
+
<li><a class="reference internal" href="#simstack.core.asnyc_helper.async_helper"><code class="docutils literal notranslate"><span class="pre">async_helper()</span></code></a></li>
|
|
1665
|
+
</ul>
|
|
1666
|
+
</li>
|
|
1667
|
+
<li><a class="reference internal" href="#module-simstack.core.config_file">simstack.core.config_file module</a><ul>
|
|
1668
|
+
<li><a class="reference internal" href="#simstack.core.config_file.SimstackConfig"><code class="docutils literal notranslate"><span class="pre">SimstackConfig</span></code></a><ul>
|
|
1669
|
+
<li><a class="reference internal" href="#simstack.core.config_file.SimstackConfig.config_file_path"><code class="docutils literal notranslate"><span class="pre">SimstackConfig.config_file_path</span></code></a></li>
|
|
1670
|
+
</ul>
|
|
1671
|
+
</li>
|
|
1672
|
+
<li><a class="reference internal" href="#simstack.core.config_file.get_config_file"><code class="docutils literal notranslate"><span class="pre">get_config_file()</span></code></a></li>
|
|
1673
|
+
</ul>
|
|
1674
|
+
</li>
|
|
1675
|
+
<li><a class="reference internal" href="#module-simstack.core.context">simstack.core.context module</a></li>
|
|
1676
|
+
<li><a class="reference internal" href="#module-simstack.core.definitions">simstack.core.definitions module</a><ul>
|
|
1677
|
+
<li><a class="reference internal" href="#simstack.core.definitions.DBType"><code class="docutils literal notranslate"><span class="pre">DBType</span></code></a><ul>
|
|
1678
|
+
<li><a class="reference internal" href="#simstack.core.definitions.DBType.IN_MEMORY"><code class="docutils literal notranslate"><span class="pre">DBType.IN_MEMORY</span></code></a></li>
|
|
1679
|
+
<li><a class="reference internal" href="#simstack.core.definitions.DBType.MONGODB"><code class="docutils literal notranslate"><span class="pre">DBType.MONGODB</span></code></a></li>
|
|
1680
|
+
<li><a class="reference internal" href="#simstack.core.definitions.DBType.POSTGRES"><code class="docutils literal notranslate"><span class="pre">DBType.POSTGRES</span></code></a></li>
|
|
1681
|
+
<li><a class="reference internal" href="#simstack.core.definitions.DBType.SQLITE"><code class="docutils literal notranslate"><span class="pre">DBType.SQLITE</span></code></a></li>
|
|
1682
|
+
<li><a class="reference internal" href="#simstack.core.definitions.DBType.WITH_PATH"><code class="docutils literal notranslate"><span class="pre">DBType.WITH_PATH</span></code></a></li>
|
|
1683
|
+
</ul>
|
|
1684
|
+
</li>
|
|
1685
|
+
<li><a class="reference internal" href="#simstack.core.definitions.TaskStatus"><code class="docutils literal notranslate"><span class="pre">TaskStatus</span></code></a><ul>
|
|
1686
|
+
<li><a class="reference internal" href="#simstack.core.definitions.TaskStatus.COMPLETED"><code class="docutils literal notranslate"><span class="pre">TaskStatus.COMPLETED</span></code></a></li>
|
|
1687
|
+
<li><a class="reference internal" href="#simstack.core.definitions.TaskStatus.FAILED"><code class="docutils literal notranslate"><span class="pre">TaskStatus.FAILED</span></code></a></li>
|
|
1688
|
+
<li><a class="reference internal" href="#simstack.core.definitions.TaskStatus.RECOVERED"><code class="docutils literal notranslate"><span class="pre">TaskStatus.RECOVERED</span></code></a></li>
|
|
1689
|
+
<li><a class="reference internal" href="#simstack.core.definitions.TaskStatus.RETRIEVED"><code class="docutils literal notranslate"><span class="pre">TaskStatus.RETRIEVED</span></code></a></li>
|
|
1690
|
+
<li><a class="reference internal" href="#simstack.core.definitions.TaskStatus.RUNNING"><code class="docutils literal notranslate"><span class="pre">TaskStatus.RUNNING</span></code></a></li>
|
|
1691
|
+
<li><a class="reference internal" href="#simstack.core.definitions.TaskStatus.SLURM_QUEUED"><code class="docutils literal notranslate"><span class="pre">TaskStatus.SLURM_QUEUED</span></code></a></li>
|
|
1692
|
+
<li><a class="reference internal" href="#simstack.core.definitions.TaskStatus.SLURM_RUNNING"><code class="docutils literal notranslate"><span class="pre">TaskStatus.SLURM_RUNNING</span></code></a></li>
|
|
1693
|
+
<li><a class="reference internal" href="#simstack.core.definitions.TaskStatus.SUBMITTED"><code class="docutils literal notranslate"><span class="pre">TaskStatus.SUBMITTED</span></code></a></li>
|
|
1694
|
+
<li><a class="reference internal" href="#simstack.core.definitions.TaskStatus.TIME_OUT"><code class="docutils literal notranslate"><span class="pre">TaskStatus.TIME_OUT</span></code></a></li>
|
|
1695
|
+
</ul>
|
|
1696
|
+
</li>
|
|
1697
|
+
</ul>
|
|
1698
|
+
</li>
|
|
1699
|
+
<li><a class="reference internal" href="#module-simstack.core.engine">simstack.core.engine module</a><ul>
|
|
1700
|
+
<li><a class="reference internal" href="#simstack.core.engine.AIOEngineProxy"><code class="docutils literal notranslate"><span class="pre">AIOEngineProxy</span></code></a><ul>
|
|
1701
|
+
<li><a class="reference internal" href="#simstack.core.engine.AIOEngineProxy.save"><code class="docutils literal notranslate"><span class="pre">AIOEngineProxy.save()</span></code></a></li>
|
|
1702
|
+
<li><a class="reference internal" href="#simstack.core.engine.AIOEngineProxy.save_unchecked"><code class="docutils literal notranslate"><span class="pre">AIOEngineProxy.save_unchecked()</span></code></a></li>
|
|
1703
|
+
</ul>
|
|
1704
|
+
</li>
|
|
1705
|
+
</ul>
|
|
1706
|
+
</li>
|
|
1707
|
+
<li><a class="reference internal" href="#module-simstack.core.find_simstack_modules">simstack.core.find_simstack_modules module</a><ul>
|
|
1708
|
+
<li><a class="reference internal" href="#simstack.core.find_simstack_modules.find_simstack_modules"><code class="docutils literal notranslate"><span class="pre">find_simstack_modules()</span></code></a></li>
|
|
1709
|
+
<li><a class="reference internal" href="#simstack.core.find_simstack_modules.walk_packages"><code class="docutils literal notranslate"><span class="pre">walk_packages()</span></code></a></li>
|
|
1710
|
+
</ul>
|
|
1711
|
+
</li>
|
|
1712
|
+
<li><a class="reference internal" href="#module-simstack.core.hash">simstack.core.hash module</a><ul>
|
|
1713
|
+
<li><a class="reference internal" href="#simstack.core.hash.ComplexHash"><code class="docutils literal notranslate"><span class="pre">ComplexHash</span></code></a><ul>
|
|
1714
|
+
<li><a class="reference internal" href="#simstack.core.hash.ComplexHash.complex_hash"><code class="docutils literal notranslate"><span class="pre">ComplexHash.complex_hash()</span></code></a></li>
|
|
1715
|
+
<li><a class="reference internal" href="#simstack.core.hash.ComplexHash.hash_class"><code class="docutils literal notranslate"><span class="pre">ComplexHash.hash_class()</span></code></a></li>
|
|
1716
|
+
<li><a class="reference internal" href="#simstack.core.hash.ComplexHash.hash_dict"><code class="docutils literal notranslate"><span class="pre">ComplexHash.hash_dict()</span></code></a></li>
|
|
1717
|
+
</ul>
|
|
1718
|
+
</li>
|
|
1719
|
+
<li><a class="reference internal" href="#simstack.core.hash.complex_hash_function"><code class="docutils literal notranslate"><span class="pre">complex_hash_function()</span></code></a></li>
|
|
1720
|
+
<li><a class="reference internal" href="#simstack.core.hash.hash_class_def"><code class="docutils literal notranslate"><span class="pre">hash_class_def()</span></code></a></li>
|
|
1721
|
+
<li><a class="reference internal" href="#simstack.core.hash.hash_function_body"><code class="docutils literal notranslate"><span class="pre">hash_function_body()</span></code></a></li>
|
|
1722
|
+
<li><a class="reference internal" href="#simstack.core.hash.hash_iterable"><code class="docutils literal notranslate"><span class="pre">hash_iterable()</span></code></a></li>
|
|
1723
|
+
<li><a class="reference internal" href="#simstack.core.hash.hash_non_callable_members"><code class="docutils literal notranslate"><span class="pre">hash_non_callable_members()</span></code></a></li>
|
|
1724
|
+
<li><a class="reference internal" href="#simstack.core.hash.hash_value"><code class="docutils literal notranslate"><span class="pre">hash_value()</span></code></a></li>
|
|
1725
|
+
<li><a class="reference internal" href="#simstack.core.hash.is_iterable"><code class="docutils literal notranslate"><span class="pre">is_iterable()</span></code></a></li>
|
|
1726
|
+
<li><a class="reference internal" href="#simstack.core.hash.is_primitive_type"><code class="docutils literal notranslate"><span class="pre">is_primitive_type()</span></code></a></li>
|
|
1727
|
+
</ul>
|
|
1728
|
+
</li>
|
|
1729
|
+
<li><a class="reference internal" href="#module-simstack.core.node">simstack.core.node module</a><ul>
|
|
1730
|
+
<li><a class="reference internal" href="#simstack.core.node.Node"><code class="docutils literal notranslate"><span class="pre">Node</span></code></a><ul>
|
|
1731
|
+
<li><a class="reference internal" href="#simstack.core.node.Node.execute_node_locally"><code class="docutils literal notranslate"><span class="pre">Node.execute_node_locally()</span></code></a></li>
|
|
1732
|
+
<li><a class="reference internal" href="#simstack.core.node.Node.get_node_registry"><code class="docutils literal notranslate"><span class="pre">Node.get_node_registry()</span></code></a></li>
|
|
1733
|
+
<li><a class="reference internal" href="#simstack.core.node.Node.id"><code class="docutils literal notranslate"><span class="pre">Node.id</span></code></a></li>
|
|
1734
|
+
<li><a class="reference internal" href="#simstack.core.node.Node.load_results"><code class="docutils literal notranslate"><span class="pre">Node.load_results()</span></code></a></li>
|
|
1735
|
+
<li><a class="reference internal" href="#simstack.core.node.Node.make_registry_entry"><code class="docutils literal notranslate"><span class="pre">Node.make_registry_entry()</span></code></a></li>
|
|
1736
|
+
<li><a class="reference internal" href="#simstack.core.node.Node.process_results"><code class="docutils literal notranslate"><span class="pre">Node.process_results()</span></code></a></li>
|
|
1737
|
+
<li><a class="reference internal" href="#simstack.core.node.Node.run_somewhere"><code class="docutils literal notranslate"><span class="pre">Node.run_somewhere()</span></code></a></li>
|
|
1738
|
+
<li><a class="reference internal" href="#simstack.core.node.Node.set_status"><code class="docutils literal notranslate"><span class="pre">Node.set_status()</span></code></a></li>
|
|
1739
|
+
<li><a class="reference internal" href="#simstack.core.node.Node.status"><code class="docutils literal notranslate"><span class="pre">Node.status</span></code></a></li>
|
|
1740
|
+
</ul>
|
|
1741
|
+
</li>
|
|
1742
|
+
<li><a class="reference internal" href="#simstack.core.node.compute_arg_hash"><code class="docutils literal notranslate"><span class="pre">compute_arg_hash()</span></code></a></li>
|
|
1743
|
+
<li><a class="reference internal" href="#simstack.core.node.default_name_generator"><code class="docutils literal notranslate"><span class="pre">default_name_generator()</span></code></a></li>
|
|
1744
|
+
<li><a class="reference internal" href="#simstack.core.node.hashable_inputs"><code class="docutils literal notranslate"><span class="pre">hashable_inputs()</span></code></a></li>
|
|
1745
|
+
<li><a class="reference internal" href="#simstack.core.node.hashable_value"><code class="docutils literal notranslate"><span class="pre">hashable_value()</span></code></a></li>
|
|
1746
|
+
<li><a class="reference internal" href="#simstack.core.node.node"><code class="docutils literal notranslate"><span class="pre">node()</span></code></a></li>
|
|
1747
|
+
<li><a class="reference internal" href="#simstack.core.node.node_from_database"><code class="docutils literal notranslate"><span class="pre">node_from_database()</span></code></a></li>
|
|
1748
|
+
</ul>
|
|
1749
|
+
</li>
|
|
1750
|
+
<li><a class="reference internal" href="#module-simstack.core.node_claim">simstack.core.node_claim module</a><ul>
|
|
1751
|
+
<li><a class="reference internal" href="#simstack.core.node_claim.claim_submitted_node"><code class="docutils literal notranslate"><span class="pre">claim_submitted_node()</span></code></a></li>
|
|
1752
|
+
</ul>
|
|
1753
|
+
</li>
|
|
1754
|
+
<li><a class="reference internal" href="#module-simstack.core.node_runner">simstack.core.node_runner module</a><ul>
|
|
1755
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner"><code class="docutils literal notranslate"><span class="pre">NodeRunner</span></code></a><ul>
|
|
1756
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.task_id"><code class="docutils literal notranslate"><span class="pre">NodeRunner.task_id</span></code></a></li>
|
|
1757
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.name"><code class="docutils literal notranslate"><span class="pre">NodeRunner.name</span></code></a></li>
|
|
1758
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.logger"><code class="docutils literal notranslate"><span class="pre">NodeRunner.logger</span></code></a></li>
|
|
1759
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.last_stdout"><code class="docutils literal notranslate"><span class="pre">NodeRunner.last_stdout</span></code></a></li>
|
|
1760
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.last_stderr"><code class="docutils literal notranslate"><span class="pre">NodeRunner.last_stderr</span></code></a></li>
|
|
1761
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.log_string"><code class="docutils literal notranslate"><span class="pre">NodeRunner.log_string</span></code></a></li>
|
|
1762
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.info_file_patterns"><code class="docutils literal notranslate"><span class="pre">NodeRunner.info_file_patterns</span></code></a></li>
|
|
1763
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.debug"><code class="docutils literal notranslate"><span class="pre">NodeRunner.debug()</span></code></a></li>
|
|
1764
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.error"><code class="docutils literal notranslate"><span class="pre">NodeRunner.error()</span></code></a></li>
|
|
1765
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.fail"><code class="docutils literal notranslate"><span class="pre">NodeRunner.fail()</span></code></a></li>
|
|
1766
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.from_kwargs"><code class="docutils literal notranslate"><span class="pre">NodeRunner.from_kwargs()</span></code></a></li>
|
|
1767
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.info"><code class="docutils literal notranslate"><span class="pre">NodeRunner.info()</span></code></a></li>
|
|
1768
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.log"><code class="docutils literal notranslate"><span class="pre">NodeRunner.log()</span></code></a></li>
|
|
1769
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.make_info_files"><code class="docutils literal notranslate"><span class="pre">NodeRunner.make_info_files()</span></code></a></li>
|
|
1770
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.model_config"><code class="docutils literal notranslate"><span class="pre">NodeRunner.model_config</span></code></a></li>
|
|
1771
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.submit_to_watchdog"><code class="docutils literal notranslate"><span class="pre">NodeRunner.submit_to_watchdog()</span></code></a></li>
|
|
1772
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.subprocess"><code class="docutils literal notranslate"><span class="pre">NodeRunner.subprocess()</span></code></a></li>
|
|
1773
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.succeed"><code class="docutils literal notranslate"><span class="pre">NodeRunner.succeed()</span></code></a></li>
|
|
1774
|
+
<li><a class="reference internal" href="#simstack.core.node_runner.NodeRunner.warning"><code class="docutils literal notranslate"><span class="pre">NodeRunner.warning()</span></code></a></li>
|
|
1775
|
+
</ul>
|
|
1776
|
+
</li>
|
|
1777
|
+
</ul>
|
|
1778
|
+
</li>
|
|
1779
|
+
<li><a class="reference internal" href="#module-simstack.core.process_results">simstack.core.process_results module</a><ul>
|
|
1780
|
+
<li><a class="reference internal" href="#simstack.core.process_results.process_result_helper"><code class="docutils literal notranslate"><span class="pre">process_result_helper()</span></code></a></li>
|
|
1781
|
+
</ul>
|
|
1782
|
+
</li>
|
|
1783
|
+
<li><a class="reference internal" href="#module-simstack.core.recompute_artifacts">simstack.core.recompute_artifacts module</a><ul>
|
|
1784
|
+
<li><a class="reference internal" href="#simstack.core.recompute_artifacts.recompute_artifacts"><code class="docutils literal notranslate"><span class="pre">recompute_artifacts()</span></code></a></li>
|
|
1785
|
+
</ul>
|
|
1786
|
+
</li>
|
|
1787
|
+
<li><a class="reference internal" href="#module-simstack.core.reset_db">simstack.core.reset_db module</a><ul>
|
|
1788
|
+
<li><a class="reference internal" href="#simstack.core.reset_db.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
|
|
1789
|
+
</ul>
|
|
1790
|
+
</li>
|
|
1791
|
+
<li><a class="reference internal" href="#module-simstack.core.resource_assignment">simstack.core.resource_assignment module</a><ul>
|
|
1792
|
+
<li><a class="reference internal" href="#simstack.core.resource_assignment.ResourceAssignmentResolution"><code class="docutils literal notranslate"><span class="pre">ResourceAssignmentResolution</span></code></a><ul>
|
|
1793
|
+
<li><a class="reference internal" href="#simstack.core.resource_assignment.ResourceAssignmentResolution.matched_rule"><code class="docutils literal notranslate"><span class="pre">ResourceAssignmentResolution.matched_rule</span></code></a></li>
|
|
1794
|
+
<li><a class="reference internal" href="#simstack.core.resource_assignment.ResourceAssignmentResolution.normalized_call_path"><code class="docutils literal notranslate"><span class="pre">ResourceAssignmentResolution.normalized_call_path</span></code></a></li>
|
|
1795
|
+
<li><a class="reference internal" href="#simstack.core.resource_assignment.ResourceAssignmentResolution.parameters"><code class="docutils literal notranslate"><span class="pre">ResourceAssignmentResolution.parameters</span></code></a></li>
|
|
1796
|
+
</ul>
|
|
1797
|
+
</li>
|
|
1798
|
+
<li><a class="reference internal" href="#simstack.core.resource_assignment.apply_resource_assignment_to_node_registry"><code class="docutils literal notranslate"><span class="pre">apply_resource_assignment_to_node_registry()</span></code></a></li>
|
|
1799
|
+
<li><a class="reference internal" href="#simstack.core.resource_assignment.empty_slurm_parameters"><code class="docutils literal notranslate"><span class="pre">empty_slurm_parameters()</span></code></a></li>
|
|
1800
|
+
<li><a class="reference internal" href="#simstack.core.resource_assignment.normalize_and_validate_effective_parameters"><code class="docutils literal notranslate"><span class="pre">normalize_and_validate_effective_parameters()</span></code></a></li>
|
|
1801
|
+
<li><a class="reference internal" href="#simstack.core.resource_assignment.normalize_call_path"><code class="docutils literal notranslate"><span class="pre">normalize_call_path()</span></code></a></li>
|
|
1802
|
+
<li><a class="reference internal" href="#simstack.core.resource_assignment.resolve_resource_assignment"><code class="docutils literal notranslate"><span class="pre">resolve_resource_assignment()</span></code></a></li>
|
|
1803
|
+
</ul>
|
|
1804
|
+
</li>
|
|
1805
|
+
<li><a class="reference internal" href="#module-simstack.core.resources">simstack.core.resources module</a><ul>
|
|
1806
|
+
<li><a class="reference internal" href="#simstack.core.resources.AllowedResources"><code class="docutils literal notranslate"><span class="pre">AllowedResources</span></code></a><ul>
|
|
1807
|
+
<li><a class="reference internal" href="#simstack.core.resources.AllowedResources.add_resource"><code class="docutils literal notranslate"><span class="pre">AllowedResources.add_resource()</span></code></a></li>
|
|
1808
|
+
<li><a class="reference internal" href="#simstack.core.resources.AllowedResources.clear_resources"><code class="docutils literal notranslate"><span class="pre">AllowedResources.clear_resources()</span></code></a></li>
|
|
1809
|
+
<li><a class="reference internal" href="#simstack.core.resources.AllowedResources.get_resources"><code class="docutils literal notranslate"><span class="pre">AllowedResources.get_resources()</span></code></a></li>
|
|
1810
|
+
<li><a class="reference internal" href="#simstack.core.resources.AllowedResources.has_resource"><code class="docutils literal notranslate"><span class="pre">AllowedResources.has_resource()</span></code></a></li>
|
|
1811
|
+
<li><a class="reference internal" href="#simstack.core.resources.AllowedResources.initialized"><code class="docutils literal notranslate"><span class="pre">AllowedResources.initialized</span></code></a></li>
|
|
1812
|
+
<li><a class="reference internal" href="#simstack.core.resources.AllowedResources.remove_resource"><code class="docutils literal notranslate"><span class="pre">AllowedResources.remove_resource()</span></code></a></li>
|
|
1813
|
+
<li><a class="reference internal" href="#simstack.core.resources.AllowedResources.set_resources"><code class="docutils literal notranslate"><span class="pre">AllowedResources.set_resources()</span></code></a></li>
|
|
1814
|
+
</ul>
|
|
1815
|
+
</li>
|
|
1816
|
+
</ul>
|
|
1817
|
+
</li>
|
|
1818
|
+
<li><a class="reference internal" href="#module-simstack.core.route_table">simstack.core.route_table module</a><ul>
|
|
1819
|
+
<li><a class="reference internal" href="#simstack.core.route_table.RouteTable"><code class="docutils literal notranslate"><span class="pre">RouteTable</span></code></a><ul>
|
|
1820
|
+
<li><a class="reference internal" href="#simstack.core.route_table.RouteTable.add_route_set"><code class="docutils literal notranslate"><span class="pre">RouteTable.add_route_set()</span></code></a></li>
|
|
1821
|
+
<li><a class="reference internal" href="#simstack.core.route_table.RouteTable.clear_routes"><code class="docutils literal notranslate"><span class="pre">RouteTable.clear_routes()</span></code></a></li>
|
|
1822
|
+
<li><a class="reference internal" href="#simstack.core.route_table.RouteTable.get_instance"><code class="docutils literal notranslate"><span class="pre">RouteTable.get_instance()</span></code></a></li>
|
|
1823
|
+
</ul>
|
|
1824
|
+
</li>
|
|
1825
|
+
</ul>
|
|
1826
|
+
</li>
|
|
1827
|
+
<li><a class="reference internal" href="#module-simstack.core.run_docker">simstack.core.run_docker module</a><ul>
|
|
1828
|
+
<li><a class="reference internal" href="#simstack.core.run_docker.run_docker"><code class="docutils literal notranslate"><span class="pre">run_docker()</span></code></a></li>
|
|
1829
|
+
</ul>
|
|
1830
|
+
</li>
|
|
1831
|
+
<li><a class="reference internal" href="#module-simstack.core.run_node">simstack.core.run_node module</a><ul>
|
|
1832
|
+
<li><a class="reference internal" href="#simstack.core.run_node.run_node_from_id"><code class="docutils literal notranslate"><span class="pre">run_node_from_id()</span></code></a></li>
|
|
1833
|
+
<li><a class="reference internal" href="#simstack.core.run_node.run_node_main"><code class="docutils literal notranslate"><span class="pre">run_node_main()</span></code></a></li>
|
|
1834
|
+
</ul>
|
|
1835
|
+
</li>
|
|
1836
|
+
<li><a class="reference internal" href="#module-simstack.core.runner">simstack.core.runner module</a><ul>
|
|
1837
|
+
<li><a class="reference internal" href="#simstack.core.runner.async_main"><code class="docutils literal notranslate"><span class="pre">async_main()</span></code></a></li>
|
|
1838
|
+
<li><a class="reference internal" href="#simstack.core.runner.initialize_default_resource"><code class="docutils literal notranslate"><span class="pre">initialize_default_resource()</span></code></a></li>
|
|
1839
|
+
<li><a class="reference internal" href="#simstack.core.runner.runner_main"><code class="docutils literal notranslate"><span class="pre">runner_main()</span></code></a></li>
|
|
1840
|
+
</ul>
|
|
1841
|
+
</li>
|
|
1842
|
+
<li><a class="reference internal" href="#module-simstack.core.simstack_result">simstack.core.simstack_result module</a><ul>
|
|
1843
|
+
<li><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult"><code class="docutils literal notranslate"><span class="pre">SimstackResult</span></code></a><ul>
|
|
1844
|
+
<li><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult.error_message"><code class="docutils literal notranslate"><span class="pre">SimstackResult.error_message</span></code></a></li>
|
|
1845
|
+
<li><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult.files"><code class="docutils literal notranslate"><span class="pre">SimstackResult.files</span></code></a></li>
|
|
1846
|
+
<li><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult.info_files"><code class="docutils literal notranslate"><span class="pre">SimstackResult.info_files</span></code></a></li>
|
|
1847
|
+
<li><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult.message"><code class="docutils literal notranslate"><span class="pre">SimstackResult.message</span></code></a></li>
|
|
1848
|
+
<li><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult.model_config"><code class="docutils literal notranslate"><span class="pre">SimstackResult.model_config</span></code></a></li>
|
|
1849
|
+
<li><a class="reference internal" href="#simstack.core.simstack_result.SimstackResult.status"><code class="docutils literal notranslate"><span class="pre">SimstackResult.status</span></code></a></li>
|
|
1850
|
+
</ul>
|
|
1851
|
+
</li>
|
|
1852
|
+
</ul>
|
|
1853
|
+
</li>
|
|
1854
|
+
<li><a class="reference internal" href="#module-simstack.core.submit_node">simstack.core.submit_node module</a><ul>
|
|
1855
|
+
<li><a class="reference internal" href="#simstack.core.submit_node.make_executable"><code class="docutils literal notranslate"><span class="pre">make_executable()</span></code></a></li>
|
|
1856
|
+
<li><a class="reference internal" href="#simstack.core.submit_node.submit_node"><code class="docutils literal notranslate"><span class="pre">submit_node()</span></code></a></li>
|
|
1857
|
+
</ul>
|
|
1858
|
+
</li>
|
|
1859
|
+
<li><a class="reference internal" href="#module-simstack.core.task_id">simstack.core.task_id module</a><ul>
|
|
1860
|
+
<li><a class="reference internal" href="#simstack.core.task_id.clear_task_id"><code class="docutils literal notranslate"><span class="pre">clear_task_id()</span></code></a></li>
|
|
1861
|
+
<li><a class="reference internal" href="#simstack.core.task_id.get_task_id"><code class="docutils literal notranslate"><span class="pre">get_task_id()</span></code></a></li>
|
|
1862
|
+
<li><a class="reference internal" href="#simstack.core.task_id.set_task_id"><code class="docutils literal notranslate"><span class="pre">set_task_id()</span></code></a></li>
|
|
1863
|
+
</ul>
|
|
1864
|
+
</li>
|
|
1865
|
+
<li><a class="reference internal" href="#module-simstack.core">Module contents</a></li>
|
|
1866
|
+
</ul>
|
|
1867
|
+
</li>
|
|
1868
|
+
</ul>
|
|
1869
|
+
|
|
1870
|
+
</div>
|
|
1871
|
+
</div>
|
|
1872
|
+
</div>
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
</aside>
|
|
1876
|
+
</div>
|
|
1877
|
+
</div><script src="../../_static/documentation_options.js?v=5929fcd5"></script>
|
|
1878
|
+
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
|
|
1879
|
+
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
|
1880
|
+
<script src="../../_static/scripts/furo.js?v=46bd48cc"></script>
|
|
1881
|
+
<script data-docs-built-at="2026-07-17 10:50:10 UTC" src="../../_static/docs-build-badge.js?v=57cb9fc6"></script>
|
|
1882
|
+
</body>
|
|
1883
|
+
</html>
|