simml 0.2.2__tar.gz → 0.2.3__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {simml-0.2.2 → simml-0.2.3}/.forgejo/workflows/release.yaml +9 -1
- {simml-0.2.2 → simml-0.2.3}/PKG-INFO +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/10450421714888733546 +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/15737098405526994950 +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/16320204955390203082 +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/16573716167777710331 +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/16902395006599565135 +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/2019565748748266768 +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/2978276451654752160 +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/5237708670763707462 +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/5293021849445158554 +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/9582269429869240455 +1 -1
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/autorefs.json +11421 -11421
- simml-0.2.3/docs/.cache/mkdocstrings.json +1 -0
- {simml-0.2.2 → simml-0.2.3}/docs/zensical.toml +1 -1
- {simml-0.2.2 → simml-0.2.3}/pyproject.toml +1 -1
- simml-0.2.2/docs/.cache/mkdocstrings.json +0 -1
- {simml-0.2.2 → simml-0.2.3}/.gitignore +0 -0
- {simml-0.2.2 → simml-0.2.3}/README.md +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/.gitignore +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/.cache/objects.inv +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/docs/assets/image.png +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/docs/documentation/_Get-Started/01-installation.md +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/docs/documentation/_Get-Started/02-minimal-example.md +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/docs/documentation/_Get-Started/03-license.md +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/docs/documentation/__Key-Concepts/01-overview.md +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/docs/index.md +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/docs/stylesheets/extra.css +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/overrides/.icons/lucide-lab/fox-face-tail.svg +0 -0
- {simml-0.2.2 → simml-0.2.3}/docs/overrides/partials/header.html +0 -0
- {simml-0.2.2 → simml-0.2.3}/simplydoc/.forgejo/workflows/release.yaml +0 -0
- {simml-0.2.2 → simml-0.2.3}/simplydoc/.gitignore +0 -0
- {simml-0.2.2 → simml-0.2.3}/simplydoc/README.dev.md +0 -0
- {simml-0.2.2 → simml-0.2.3}/simplydoc/README.md +0 -0
- {simml-0.2.2 → simml-0.2.3}/simplydoc/pyproject.toml +0 -0
- {simml-0.2.2 → simml-0.2.3}/simplydoc/report.html +0 -0
- {simml-0.2.2 → simml-0.2.3}/simplydoc/tests/dev.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/simplydoc/tests/test_01_layout.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/simplydoc/tests/test_02_doc_readme.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/simplydoc/tests/test_03_doc.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/__init__.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_cmd_about.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_cmd_best.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_cmd_compare.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_cmd_create.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_cmd_dataset.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_cmd_info.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_cmd_model.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_cmd_predict.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_cmd_rank.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_cmd_train.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_datasets.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_info.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_models.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/cli_workspace.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/cli/utils.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/comparator/comparator.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/comparator/comparator_config.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/comparator/models_rank.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/dataset/dataset.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/dataset/workspace_datasets.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/__init__.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/dataset_info.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/dataset_training_info.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/datasets_store_config.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/evaluation_config.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/features_targets.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/metadata.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/model_configs.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/models_store_config.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/regression_metrics.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/report_config.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/store_model.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/trainer_config.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/models/workspace_config.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/multi_trainer.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/predict.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/predict_manager.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/report/__init__.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/report/data.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/report/report.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/report/report_texts.py +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/__init__.py +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/body_icones.html +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_1.css +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_2_colors.css +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_3_table.css +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_4_block_layouts.css +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_4_icons.css +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_5_buttons.css +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_9_w.css +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_body_10.js +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_body_20_com_charts.js +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_body_21_echarts.js +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_body_30.js +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_body_40_render_table.js +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_body_80.js +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_body_90.js +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/assets/doc_head.js +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/doc.py +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/models/__init__.py +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/models/base_blocks.py +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/models/doc_layout.py +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/models/dynamic_blocks.py +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/models/static_blocks.py +0 -0
- {simml-0.2.2/src/simml/simplydoc → simml-0.2.3/src/simml/simml_simplydoc}/utils.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/store_collection.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/store_manager.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/trainer.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/trainers/trainer_base.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/utils/class_load.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/utils/config_file.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/utils/csv.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/utils/datetime.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/utils/hash.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/utils/uuid.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/workspace/__init__.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/workspace/workspace.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/workspace/ws_constants.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/src/simml/workspace/ws_create.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/tests/test_07_models.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/tests/test_08_trainer.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/tests/test_09_multi_trainer.py +0 -0
- {simml-0.2.2 → simml-0.2.3}/tests/test_10_predict.py +0 -0
|
@@ -39,6 +39,14 @@ jobs:
|
|
|
39
39
|
- name: Checkout
|
|
40
40
|
uses: actions/checkout@v4
|
|
41
41
|
|
|
42
|
+
# simplydoc
|
|
43
|
+
|
|
44
|
+
- name: Replace simplydoc by simml_simplydoc
|
|
45
|
+
run: |
|
|
46
|
+
find . -type f -name "/*.py" \
|
|
47
|
+
-not -path "./.git/*" \
|
|
48
|
+
-exec sed -i 's/import simplydoc/import simml_simplydoc/g' {} +
|
|
49
|
+
|
|
42
50
|
- name: Checkout simplydoc
|
|
43
51
|
uses: actions/checkout@v4
|
|
44
52
|
with:
|
|
@@ -48,7 +56,7 @@ jobs:
|
|
|
48
56
|
|
|
49
57
|
- name: Move simplydoc sources
|
|
50
58
|
run: |
|
|
51
|
-
mv simplydoc/src/simplydoc src/simml/
|
|
59
|
+
mv simplydoc/src/simplydoc src/simml/simml_simplydoc
|
|
52
60
|
|
|
53
61
|
# Checks: Package, GIT, Zensical versions
|
|
54
62
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"data":"\n<!doctype html>\n<html lang=\"en\" class=\"no-js\">\n <head>\n \n <meta charset=\"utf-8\">\n <meta name=\"viewport\" content=\"width=device-width,initial-scale=1\">\n \n \n <meta name=\"author\" content=\"PinkSalmon\">\n \n \n \n \n \n <link rel=\"next\" href=\"./documentation/_Get-Started/01-installation/\">\n \n \n \n \n \n <link rel=\"icon\" href=\"./assets/images/favicon.png\">\n <meta name=\"generator\" content=\"zensical-0.1.0\">\n \n \n \n <title>SimML - SimML</title>\n \n \n \n \n \n \n <link rel=\"stylesheet\" href=\"./assets/stylesheets/modern/main.4ab2de0c.min.css\">\n \n \n\n\n \n \n \n \n \n \n \n \n <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin>\n <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,500,500i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback\">\n <style>:root{--md-text-font:\"Inter\";--md-code-font:\"JetBrains Mono\"}</style>\n \n \n \n <link rel=\"stylesheet\" href=\"./stylesheets/extra.css\">\n \n <script>__md_scope=new URL(\".\",location),__md_scope.pathname.endsWith(\"/\")||(__md_scope=new URL(__md_scope.pathname+\"/\",location)),__md_hash=e=>[...e].reduce(((e,t)=>(e<<5)-e+t.charCodeAt(0)),0),__md_get=(e,t=localStorage,_=__md_scope)=>JSON.parse(t.getItem(_.pathname+\".\"+e)),__md_set=(e,t,_=localStorage,a=__md_scope)=>{try{_.setItem(a.pathname+\".\"+e,JSON.stringify(t))}catch(e){}},document.documentElement.setAttribute(\"data-platform\",navigator.platform)</script>\n \n \n\n \n \n </head>\n \n \n <body dir=\"ltr\">\n \n \n <input class=\"md-toggle\" data-md-toggle=\"drawer\" type=\"checkbox\" id=\"__drawer\" autocomplete=\"off\">\n <input class=\"md-toggle\" data-md-toggle=\"search\" type=\"checkbox\" id=\"__search\" autocomplete=\"off\">\n <label class=\"md-overlay\" for=\"__drawer\" aria-hidden=\"true\"></label>\n <div data-md-component=\"skip\">\n <a href=\"#__skip\" class=\"md-skip\">\n Skip to content\n </a>\n </div>\n <div data-md-component=\"announce\">\n \n </div>\n \n <div data-md-color-scheme=\"default\" data-md-component=\"outdated\" hidden>\n \n </div>\n \n \n \n\n<header class=\"md-header\" data-md-component=\"header\">\n <nav class=\"md-header__inner md-grid\" aria-label=\"Header\">\n <a href=\"\" title=\"SimML\" class=\"md-header__button md-logo\" aria-label=\"SimML\" data-md-component=\"logo\">\n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"32\" height=\"32\" viewBox=\"0 0 24 24\"><!-- Icon from Lucide Lab by Lucide Contributors - https://github.com/lucide-icons/lucide-lab/blob/main/LICENSE --><g fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\"><path d=\"M19.9 8.3C20.6 7 21 5.6 21 4c0-.6-.4-1-1-1c-2.3 0-4.3.8-5.9 2.2a15 15 0 0 0-4.2 0A8.78 8.78 0 0 0 4 3c-.6 0-1 .4-1 1c0 1.6.4 3 1.1 4.3c-.6.7-1.1 1.4-1.4 2.2C4 13 11 16 12 16s8-3 9.3-5.5c-.3-.8-.8-1.5-1.4-2.2M9 9v.5m4 3.5h-2m1 3v-3m3-4v.5\"/><path d=\"M6.3 20.5A6.87 6.87 0 0 0 9 15H2.2c.8 4 4.9 7 9.8 7c5.5 0 10-3.8 10-8.5c0-1.1-.2-2.1-.7-3\"/></g></svg>\n\n </a>\n <label class=\"md-header__button md-icon\" for=\"__drawer\" aria-label=\"Navigation\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-menu\" viewBox=\"0 0 24 24\"><path d=\"M4 5h16M4 12h16M4 19h16\"/></svg>\n </label>\n <div class=\"md-header__title\" data-md-component=\"header-title\">\n <div class=\"md-header__ellipsis\">\n <div class=\"md-header__topic\">\n <span class=\"md-ellipsis\">\n SimML\n <span style=\"background: var(--md-accent-fg-color--transparent); color: var(--md-accent-fg-color); padding: 2px 4px; margin:4px; border-radius: 4px; font-size: 0.6em;\">\n v0.2.2\n </span>\n </span>\n </div>\n <div class=\"md-header__topic\" data-md-component=\"header-topic\">\n <span class=\"md-ellipsis\">\n \n SimML\n \n </span>\n </div>\n </div>\n </div>\n \n \n <script>var palette=__md_get(\"__palette\");if(palette&&palette.color){if(\"(prefers-color-scheme)\"===palette.color.media){var media=matchMedia(\"(prefers-color-scheme: light)\"),input=document.querySelector(media.matches?\"[data-md-color-media='(prefers-color-scheme: light)']\":\"[data-md-color-media='(prefers-color-scheme: dark)']\");palette.color.media=input.getAttribute(\"data-md-color-media\"),palette.color.scheme=input.getAttribute(\"data-md-color-scheme\"),palette.color.primary=input.getAttribute(\"data-md-color-primary\"),palette.color.accent=input.getAttribute(\"data-md-color-accent\")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute(\"data-md-color-\"+key,value)}</script>\n \n \n \n \n \n <label class=\"md-header__button md-icon\" for=\"__search\" aria-label=\"Search\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-search\" viewBox=\"0 0 24 24\"><path d=\"m21 21-4.34-4.34\"/><circle cx=\"11\" cy=\"11\" r=\"8\"/></svg>\n </label>\n <div class=\"md-search\" data-md-component=\"search\" role=\"dialog\" aria-label=\"Search\">\n <button type=\"button\" class=\"md-search__button\">\n Search\n </button>\n</div>\n \n \n <div class=\"md-header__source\">\n \n </div>\n </nav>\n \n</header>\n \n <div class=\"md-container\" data-md-component=\"container\">\n \n \n \n \n \n<nav class=\"md-tabs\" aria-label=\"Tabs\" data-md-component=\"tabs\">\n <div class=\"md-grid\">\n <ul class=\"md-tabs__list\">\n \n \n \n \n \n \n \n \n <li class=\"md-tabs__item md-tabs__item--active\">\n <a href=\"\" class=\"md-tabs__link\">\n \n \n SimML\n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-tabs__item\">\n <a href=\"./documentation/_Get-Started/01-installation/\" class=\"md-tabs__link\">\n \n \n Documentation\n\n </a>\n </li>\n \n \n\n \n \n\n \n </ul>\n </div>\n</nav>\n \n \n \n <main class=\"md-main\" data-md-component=\"main\">\n <div class=\"md-main__inner md-grid\">\n \n \n \n <div class=\"md-sidebar md-sidebar--primary\" data-md-component=\"sidebar\" data-md-type=\"navigation\" >\n <div class=\"md-sidebar__scrollwrap\">\n <div class=\"md-sidebar__inner\">\n \n\n\n \n\n\n<nav class=\"md-nav md-nav--primary md-nav--lifted\" aria-label=\"Navigation\" data-md-level=\"0\">\n <label class=\"md-nav__title\" for=\"__drawer\">\n <a href=\"\" title=\"SimML\" class=\"md-nav__button md-logo\" aria-label=\"SimML\" data-md-component=\"logo\">\n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"32\" height=\"32\" viewBox=\"0 0 24 24\"><!-- Icon from Lucide Lab by Lucide Contributors - https://github.com/lucide-icons/lucide-lab/blob/main/LICENSE --><g fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\"><path d=\"M19.9 8.3C20.6 7 21 5.6 21 4c0-.6-.4-1-1-1c-2.3 0-4.3.8-5.9 2.2a15 15 0 0 0-4.2 0A8.78 8.78 0 0 0 4 3c-.6 0-1 .4-1 1c0 1.6.4 3 1.1 4.3c-.6.7-1.1 1.4-1.4 2.2C4 13 11 16 12 16s8-3 9.3-5.5c-.3-.8-.8-1.5-1.4-2.2M9 9v.5m4 3.5h-2m1 3v-3m3-4v.5\"/><path d=\"M6.3 20.5A6.87 6.87 0 0 0 9 15H2.2c.8 4 4.9 7 9.8 7c5.5 0 10-3.8 10-8.5c0-1.1-.2-2.1-.7-3\"/></g></svg>\n\n </a>\n SimML\n </label>\n \n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--active\">\n \n \n \n \n \n \n \n <a href=\"\" class=\"md-nav__link md-nav__link--active\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-braces\" viewBox=\"0 0 24 24\"><path d=\"M8 3H7a2 2 0 0 0-2 2v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5c0 1.1.9 2 2 2h1M16 21h1a2 2 0 0 0 2-2v-5c0-1.1.9-2 2-2a2 2 0 0 1-2-2V5a2 2 0 0 0-2-2h-1\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n SimML\n\n \n </span>\n \n \n\n </a>\n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2\" id=\"__nav_2_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Documentation\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_2_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Documentation\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_1\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_1\" id=\"__nav_2_1_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Get Started\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_1_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_1\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Get Started\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/_Get-Started/01-installation/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-package-open\" viewBox=\"0 0 24 24\"><path d=\"M12 22v-9M15.17 2.21a1.67 1.67 0 0 1 1.63 0L21 4.57a1.93 1.93 0 0 1 0 3.36L8.82 14.79a1.66 1.66 0 0 1-1.64 0L3 12.43a1.93 1.93 0 0 1 0-3.36z\"/><path d=\"M20 13v3.87a2.06 2.06 0 0 1-1.11 1.83l-6 3.08a1.93 1.93 0 0 1-1.78 0l-6-3.08A2.06 2.06 0 0 1 4 16.87V13\"/><path d=\"M21 12.43a1.93 1.93 0 0 0 0-3.36L8.83 2.2a1.64 1.64 0 0 0-1.63 0L3 4.57a1.93 1.93 0 0 0 0 3.36l12.18 6.86a1.64 1.64 0 0 0 1.63 0z\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Installation\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/_Get-Started/02-minimal-example/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-file-box\" viewBox=\"0 0 24 24\"><path d=\"M14 2v5a1 1 0 0 0 1 1h5\"/><path d=\"M14.692 22H18a2 2 0 0 0 2-2V8a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 14 2H6a2 2 0 0 0-2 2v3.804\"/><path d=\"M2.264 13.752 7 16.5l4.737-2.748\"/><path d=\"M2.995 13.014A2 2 0 0 0 2 14.744v3.516a2 2 0 0 0 .996 1.73l3 1.74a2 2 0 0 0 2.008 0l3-1.74A2 2 0 0 0 12 18.26v-3.517a2 2 0 0 0-.995-1.73l-3-1.742a2 2 0 0 0-1.892-.064zM7 16.5V22\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Minimal Training Example\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/_Get-Started/03-license/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-scale\" viewBox=\"0 0 24 24\"><path d=\"M12 3v18M19 8l3 8a5 5 0 0 1-6 0zV7\"/><path d=\"M3 7h1a17 17 0 0 0 8-2 17 17 0 0 0 8 2h1M5 8l3 8a5 5 0 0 1-6 0zV7M7 21h10\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n License\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_2\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_2\" id=\"__nav_2_2_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Key Concepts\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_2_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Key Concepts\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/__Key-Concepts/01-overview/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-info\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"M12 16v-4M12 8h.01\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Overview\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n </ul>\n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-sidebar md-sidebar--secondary\" data-md-component=\"sidebar\" data-md-type=\"toc\" >\n <div class=\"md-sidebar__scrollwrap\">\n \n \n \n \n \n \n \n \n <div class=\"md-sidebar__inner\">\n \n\n\n<nav class=\"md-nav md-nav--secondary\" aria-label=\"On this page\">\n \n \n \n \n \n \n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-content\" data-md-component=\"content\">\n \n \n\n\n\n \n\n\n \n <article class=\"md-content__inner md-typeset\">\n <a id=\"__skip\" tabindex=\"-1\"></a>\n \n \n\n\n<h1 id=\"simml-the-framework-for-scientific-simulation-surrogate-models\">SimML - The framework for scientific simulation surrogate models<a class=\"headerlink\" href=\"#simml-the-framework-for-scientific-simulation-surrogate-models\" title=\"Permanent link\">¶</a></h1>\n<p>Explore more. Simulate faster.</p>\n<p><img alt=\"\" src=\"assets/image.png\" /></p>\n\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n\n \n </article>\n </div>\n \n \n<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith(\"__tabbed_\"))</script>\n </div>\n \n <button type=\"button\" class=\"md-top md-icon\" data-md-component=\"top\" hidden>\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-circle-arrow-up\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"m16 12-4-4-4 4M12 16V8\"/></svg>\n Back to top\n</button>\n \n </main>\n \n <footer class=\"md-footer\">\n \n <div class=\"md-footer-meta md-typeset\">\n <div class=\"md-footer-meta__inner md-grid\">\n <div class=\"md-copyright\">\n \n <div class=\"md-copyright__highlight\">\n Copyright © 2026 SimML - A PinkSalmon Library\n </div>\n \n \n</div>\n \n </div>\n </div>\n</footer>\n \n </div>\n <div class=\"md-dialog\" data-md-component=\"dialog\" role=\"status\" aria-atomic=\"true\">\n <div class=\"md-dialog__inner md-typeset\"></div>\n </div>\n \n \n \n \n \n \n \n \n \n <script id=\"__config\" type=\"application/json\">{\"annotate\":null,\"base\":\".\",\"features\":[\"navigation.tabs\",\"navigation.path\",\"navigation.expand\",\"navigation.top\",\"navigation.sections\",\"navigation.indexes\",\"content.code.copy\"],\"redirect\":null,\"search\":\"./assets/javascripts/workers/search.719e0d91.min.js\",\"tags\":null,\"translations\":{\"clipboard.copied\":\"Copied to clipboard\",\"clipboard.copy\":\"Copy to clipboard\",\"clipboard.error\":\"Could not copy to clipboard\",\"search.result.more.one\":\"1 more on this page\",\"search.result.more.other\":\"# more on this page\",\"search.result.none\":\"No matching documents\",\"search.result.one\":\"1 matching document\",\"search.result.other\":\"# matching documents\",\"search.result.placeholder\":\"Type to start searching\",\"search.result.term.missing\":\"Missing\",\"select.version\":\"Select version\"},\"version\":\"v0.2.2\"}</script>\n \n \n <script src=\"./assets/javascripts/bundle.d31f0ffa.min.js\"></script>\n \n \n </body>\n</html>","hash":1989750389803784698}
|
|
1
|
+
{"data":"\n<!doctype html>\n<html lang=\"en\" class=\"no-js\">\n <head>\n \n <meta charset=\"utf-8\">\n <meta name=\"viewport\" content=\"width=device-width,initial-scale=1\">\n \n \n <meta name=\"author\" content=\"PinkSalmon\">\n \n \n \n \n \n <link rel=\"next\" href=\"./documentation/_Get-Started/01-installation/\">\n \n \n \n \n \n <link rel=\"icon\" href=\"./assets/images/favicon.png\">\n <meta name=\"generator\" content=\"zensical-0.1.0\">\n \n \n \n <title>SimML - SimML</title>\n \n \n \n \n \n \n <link rel=\"stylesheet\" href=\"./assets/stylesheets/modern/main.4ab2de0c.min.css\">\n \n \n\n\n \n \n \n \n \n \n \n \n <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin>\n <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,500,500i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback\">\n <style>:root{--md-text-font:\"Inter\";--md-code-font:\"JetBrains Mono\"}</style>\n \n \n \n <link rel=\"stylesheet\" href=\"./stylesheets/extra.css\">\n \n <script>__md_scope=new URL(\".\",location),__md_scope.pathname.endsWith(\"/\")||(__md_scope=new URL(__md_scope.pathname+\"/\",location)),__md_hash=e=>[...e].reduce(((e,t)=>(e<<5)-e+t.charCodeAt(0)),0),__md_get=(e,t=localStorage,_=__md_scope)=>JSON.parse(t.getItem(_.pathname+\".\"+e)),__md_set=(e,t,_=localStorage,a=__md_scope)=>{try{_.setItem(a.pathname+\".\"+e,JSON.stringify(t))}catch(e){}},document.documentElement.setAttribute(\"data-platform\",navigator.platform)</script>\n \n \n\n \n \n </head>\n \n \n <body dir=\"ltr\">\n \n \n <input class=\"md-toggle\" data-md-toggle=\"drawer\" type=\"checkbox\" id=\"__drawer\" autocomplete=\"off\">\n <input class=\"md-toggle\" data-md-toggle=\"search\" type=\"checkbox\" id=\"__search\" autocomplete=\"off\">\n <label class=\"md-overlay\" for=\"__drawer\" aria-hidden=\"true\"></label>\n <div data-md-component=\"skip\">\n <a href=\"#__skip\" class=\"md-skip\">\n Skip to content\n </a>\n </div>\n <div data-md-component=\"announce\">\n \n </div>\n \n <div data-md-color-scheme=\"default\" data-md-component=\"outdated\" hidden>\n \n </div>\n \n \n \n\n<header class=\"md-header\" data-md-component=\"header\">\n <nav class=\"md-header__inner md-grid\" aria-label=\"Header\">\n <a href=\"\" title=\"SimML\" class=\"md-header__button md-logo\" aria-label=\"SimML\" data-md-component=\"logo\">\n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"32\" height=\"32\" viewBox=\"0 0 24 24\"><!-- Icon from Lucide Lab by Lucide Contributors - https://github.com/lucide-icons/lucide-lab/blob/main/LICENSE --><g fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\"><path d=\"M19.9 8.3C20.6 7 21 5.6 21 4c0-.6-.4-1-1-1c-2.3 0-4.3.8-5.9 2.2a15 15 0 0 0-4.2 0A8.78 8.78 0 0 0 4 3c-.6 0-1 .4-1 1c0 1.6.4 3 1.1 4.3c-.6.7-1.1 1.4-1.4 2.2C4 13 11 16 12 16s8-3 9.3-5.5c-.3-.8-.8-1.5-1.4-2.2M9 9v.5m4 3.5h-2m1 3v-3m3-4v.5\"/><path d=\"M6.3 20.5A6.87 6.87 0 0 0 9 15H2.2c.8 4 4.9 7 9.8 7c5.5 0 10-3.8 10-8.5c0-1.1-.2-2.1-.7-3\"/></g></svg>\n\n </a>\n <label class=\"md-header__button md-icon\" for=\"__drawer\" aria-label=\"Navigation\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-menu\" viewBox=\"0 0 24 24\"><path d=\"M4 5h16M4 12h16M4 19h16\"/></svg>\n </label>\n <div class=\"md-header__title\" data-md-component=\"header-title\">\n <div class=\"md-header__ellipsis\">\n <div class=\"md-header__topic\">\n <span class=\"md-ellipsis\">\n SimML\n <span style=\"background: var(--md-accent-fg-color--transparent); color: var(--md-accent-fg-color); padding: 2px 4px; margin:4px; border-radius: 4px; font-size: 0.6em;\">\n v0.2.3\n </span>\n </span>\n </div>\n <div class=\"md-header__topic\" data-md-component=\"header-topic\">\n <span class=\"md-ellipsis\">\n \n SimML\n \n </span>\n </div>\n </div>\n </div>\n \n \n <script>var palette=__md_get(\"__palette\");if(palette&&palette.color){if(\"(prefers-color-scheme)\"===palette.color.media){var media=matchMedia(\"(prefers-color-scheme: light)\"),input=document.querySelector(media.matches?\"[data-md-color-media='(prefers-color-scheme: light)']\":\"[data-md-color-media='(prefers-color-scheme: dark)']\");palette.color.media=input.getAttribute(\"data-md-color-media\"),palette.color.scheme=input.getAttribute(\"data-md-color-scheme\"),palette.color.primary=input.getAttribute(\"data-md-color-primary\"),palette.color.accent=input.getAttribute(\"data-md-color-accent\")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute(\"data-md-color-\"+key,value)}</script>\n \n \n \n \n \n <label class=\"md-header__button md-icon\" for=\"__search\" aria-label=\"Search\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-search\" viewBox=\"0 0 24 24\"><path d=\"m21 21-4.34-4.34\"/><circle cx=\"11\" cy=\"11\" r=\"8\"/></svg>\n </label>\n <div class=\"md-search\" data-md-component=\"search\" role=\"dialog\" aria-label=\"Search\">\n <button type=\"button\" class=\"md-search__button\">\n Search\n </button>\n</div>\n \n \n <div class=\"md-header__source\">\n \n </div>\n </nav>\n \n</header>\n \n <div class=\"md-container\" data-md-component=\"container\">\n \n \n \n \n \n<nav class=\"md-tabs\" aria-label=\"Tabs\" data-md-component=\"tabs\">\n <div class=\"md-grid\">\n <ul class=\"md-tabs__list\">\n \n \n \n \n \n \n \n \n <li class=\"md-tabs__item md-tabs__item--active\">\n <a href=\"\" class=\"md-tabs__link\">\n \n \n SimML\n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-tabs__item\">\n <a href=\"./documentation/_Get-Started/01-installation/\" class=\"md-tabs__link\">\n \n \n Documentation\n\n </a>\n </li>\n \n \n\n \n \n\n \n </ul>\n </div>\n</nav>\n \n \n \n <main class=\"md-main\" data-md-component=\"main\">\n <div class=\"md-main__inner md-grid\">\n \n \n \n <div class=\"md-sidebar md-sidebar--primary\" data-md-component=\"sidebar\" data-md-type=\"navigation\" >\n <div class=\"md-sidebar__scrollwrap\">\n <div class=\"md-sidebar__inner\">\n \n\n\n \n\n\n<nav class=\"md-nav md-nav--primary md-nav--lifted\" aria-label=\"Navigation\" data-md-level=\"0\">\n <label class=\"md-nav__title\" for=\"__drawer\">\n <a href=\"\" title=\"SimML\" class=\"md-nav__button md-logo\" aria-label=\"SimML\" data-md-component=\"logo\">\n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"32\" height=\"32\" viewBox=\"0 0 24 24\"><!-- Icon from Lucide Lab by Lucide Contributors - https://github.com/lucide-icons/lucide-lab/blob/main/LICENSE --><g fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\"><path d=\"M19.9 8.3C20.6 7 21 5.6 21 4c0-.6-.4-1-1-1c-2.3 0-4.3.8-5.9 2.2a15 15 0 0 0-4.2 0A8.78 8.78 0 0 0 4 3c-.6 0-1 .4-1 1c0 1.6.4 3 1.1 4.3c-.6.7-1.1 1.4-1.4 2.2C4 13 11 16 12 16s8-3 9.3-5.5c-.3-.8-.8-1.5-1.4-2.2M9 9v.5m4 3.5h-2m1 3v-3m3-4v.5\"/><path d=\"M6.3 20.5A6.87 6.87 0 0 0 9 15H2.2c.8 4 4.9 7 9.8 7c5.5 0 10-3.8 10-8.5c0-1.1-.2-2.1-.7-3\"/></g></svg>\n\n </a>\n SimML\n </label>\n \n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--active\">\n \n \n \n \n \n \n \n <a href=\"\" class=\"md-nav__link md-nav__link--active\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-braces\" viewBox=\"0 0 24 24\"><path d=\"M8 3H7a2 2 0 0 0-2 2v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5c0 1.1.9 2 2 2h1M16 21h1a2 2 0 0 0 2-2v-5c0-1.1.9-2 2-2a2 2 0 0 1-2-2V5a2 2 0 0 0-2-2h-1\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n SimML\n\n \n </span>\n \n \n\n </a>\n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2\" id=\"__nav_2_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Documentation\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_2_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Documentation\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_1\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_1\" id=\"__nav_2_1_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Get Started\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_1_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_1\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Get Started\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/_Get-Started/01-installation/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-package-open\" viewBox=\"0 0 24 24\"><path d=\"M12 22v-9M15.17 2.21a1.67 1.67 0 0 1 1.63 0L21 4.57a1.93 1.93 0 0 1 0 3.36L8.82 14.79a1.66 1.66 0 0 1-1.64 0L3 12.43a1.93 1.93 0 0 1 0-3.36z\"/><path d=\"M20 13v3.87a2.06 2.06 0 0 1-1.11 1.83l-6 3.08a1.93 1.93 0 0 1-1.78 0l-6-3.08A2.06 2.06 0 0 1 4 16.87V13\"/><path d=\"M21 12.43a1.93 1.93 0 0 0 0-3.36L8.83 2.2a1.64 1.64 0 0 0-1.63 0L3 4.57a1.93 1.93 0 0 0 0 3.36l12.18 6.86a1.64 1.64 0 0 0 1.63 0z\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Installation\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/_Get-Started/02-minimal-example/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-file-box\" viewBox=\"0 0 24 24\"><path d=\"M14 2v5a1 1 0 0 0 1 1h5\"/><path d=\"M14.692 22H18a2 2 0 0 0 2-2V8a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 14 2H6a2 2 0 0 0-2 2v3.804\"/><path d=\"M2.264 13.752 7 16.5l4.737-2.748\"/><path d=\"M2.995 13.014A2 2 0 0 0 2 14.744v3.516a2 2 0 0 0 .996 1.73l3 1.74a2 2 0 0 0 2.008 0l3-1.74A2 2 0 0 0 12 18.26v-3.517a2 2 0 0 0-.995-1.73l-3-1.742a2 2 0 0 0-1.892-.064zM7 16.5V22\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Minimal Training Example\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/_Get-Started/03-license/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-scale\" viewBox=\"0 0 24 24\"><path d=\"M12 3v18M19 8l3 8a5 5 0 0 1-6 0zV7\"/><path d=\"M3 7h1a17 17 0 0 0 8-2 17 17 0 0 0 8 2h1M5 8l3 8a5 5 0 0 1-6 0zV7M7 21h10\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n License\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_2\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_2\" id=\"__nav_2_2_label\" tabindex=\"0\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Key Concepts\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_2_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Key Concepts\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"./documentation/__Key-Concepts/01-overview/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-info\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"M12 16v-4M12 8h.01\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Overview\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n </ul>\n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-sidebar md-sidebar--secondary\" data-md-component=\"sidebar\" data-md-type=\"toc\" >\n <div class=\"md-sidebar__scrollwrap\">\n \n \n \n \n \n \n \n \n <div class=\"md-sidebar__inner\">\n \n\n\n<nav class=\"md-nav md-nav--secondary\" aria-label=\"On this page\">\n \n \n \n \n \n \n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-content\" data-md-component=\"content\">\n \n \n\n\n\n \n\n\n \n <article class=\"md-content__inner md-typeset\">\n <a id=\"__skip\" tabindex=\"-1\"></a>\n \n \n\n\n<h1 id=\"simml-the-framework-for-scientific-simulation-surrogate-models\">SimML - The framework for scientific simulation surrogate models<a class=\"headerlink\" href=\"#simml-the-framework-for-scientific-simulation-surrogate-models\" title=\"Permanent link\">¶</a></h1>\n<p>Explore more. Simulate faster.</p>\n<p><img alt=\"\" src=\"assets/image.png\" /></p>\n\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n\n \n </article>\n </div>\n \n \n<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith(\"__tabbed_\"))</script>\n </div>\n \n <button type=\"button\" class=\"md-top md-icon\" data-md-component=\"top\" hidden>\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-circle-arrow-up\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"m16 12-4-4-4 4M12 16V8\"/></svg>\n Back to top\n</button>\n \n </main>\n \n <footer class=\"md-footer\">\n \n <div class=\"md-footer-meta md-typeset\">\n <div class=\"md-footer-meta__inner md-grid\">\n <div class=\"md-copyright\">\n \n <div class=\"md-copyright__highlight\">\n Copyright © 2026 SimML - A PinkSalmon Library\n </div>\n \n \n</div>\n \n </div>\n </div>\n</footer>\n \n </div>\n <div class=\"md-dialog\" data-md-component=\"dialog\" role=\"status\" aria-atomic=\"true\">\n <div class=\"md-dialog__inner md-typeset\"></div>\n </div>\n \n \n \n \n \n \n \n \n \n <script id=\"__config\" type=\"application/json\">{\"annotate\":null,\"base\":\".\",\"features\":[\"navigation.tabs\",\"navigation.path\",\"navigation.expand\",\"navigation.top\",\"navigation.sections\",\"navigation.indexes\",\"content.code.copy\"],\"redirect\":null,\"search\":\"./assets/javascripts/workers/search.719e0d91.min.js\",\"tags\":null,\"translations\":{\"clipboard.copied\":\"Copied to clipboard\",\"clipboard.copy\":\"Copy to clipboard\",\"clipboard.error\":\"Could not copy to clipboard\",\"search.result.more.one\":\"1 more on this page\",\"search.result.more.other\":\"# more on this page\",\"search.result.none\":\"No matching documents\",\"search.result.one\":\"1 matching document\",\"search.result.other\":\"# matching documents\",\"search.result.placeholder\":\"Type to start searching\",\"search.result.term.missing\":\"Missing\",\"select.version\":\"Select version\"},\"version\":\"v0.2.3\"}</script>\n \n \n <script src=\"./assets/javascripts/bundle.d31f0ffa.min.js\"></script>\n \n \n </body>\n</html>","hash":7675907908919649668}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"data":"\n<!doctype html>\n<html lang=\"en\" class=\"no-js\">\n <head>\n \n <meta charset=\"utf-8\">\n <meta name=\"viewport\" content=\"width=device-width,initial-scale=1\">\n \n \n <meta name=\"author\" content=\"PinkSalmon\">\n \n \n \n \n <link rel=\"prev\" href=\"../../_Get-Started/03-license/\">\n \n \n \n \n \n \n <link rel=\"icon\" href=\"../../../assets/images/favicon.png\">\n <meta name=\"generator\" content=\"zensical-0.1.0\">\n \n \n \n <title>Overview - SimML</title>\n \n \n \n \n \n \n <link rel=\"stylesheet\" href=\"../../../assets/stylesheets/modern/main.4ab2de0c.min.css\">\n \n \n\n\n \n \n \n \n \n \n \n \n <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin>\n <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,500,500i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback\">\n <style>:root{--md-text-font:\"Inter\";--md-code-font:\"JetBrains Mono\"}</style>\n \n \n \n <link rel=\"stylesheet\" href=\"../../../stylesheets/extra.css\">\n \n <script>__md_scope=new URL(\"../../..\",location),__md_scope.pathname.endsWith(\"/\")||(__md_scope=new URL(__md_scope.pathname+\"/\",location)),__md_hash=e=>[...e].reduce(((e,t)=>(e<<5)-e+t.charCodeAt(0)),0),__md_get=(e,t=localStorage,_=__md_scope)=>JSON.parse(t.getItem(_.pathname+\".\"+e)),__md_set=(e,t,_=localStorage,a=__md_scope)=>{try{_.setItem(a.pathname+\".\"+e,JSON.stringify(t))}catch(e){}},document.documentElement.setAttribute(\"data-platform\",navigator.platform)</script>\n \n \n\n \n \n </head>\n \n \n <body dir=\"ltr\">\n \n \n <input class=\"md-toggle\" data-md-toggle=\"drawer\" type=\"checkbox\" id=\"__drawer\" autocomplete=\"off\">\n <input class=\"md-toggle\" data-md-toggle=\"search\" type=\"checkbox\" id=\"__search\" autocomplete=\"off\">\n <label class=\"md-overlay\" for=\"__drawer\" aria-hidden=\"true\"></label>\n <div data-md-component=\"skip\">\n <a href=\"#__skip\" class=\"md-skip\">\n Skip to content\n </a>\n </div>\n <div data-md-component=\"announce\">\n \n </div>\n \n <div data-md-color-scheme=\"default\" data-md-component=\"outdated\" hidden>\n \n </div>\n \n \n \n\n<header class=\"md-header\" data-md-component=\"header\">\n <nav class=\"md-header__inner md-grid\" aria-label=\"Header\">\n <a href=\"../../..\" title=\"SimML\" class=\"md-header__button md-logo\" aria-label=\"SimML\" data-md-component=\"logo\">\n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"32\" height=\"32\" viewBox=\"0 0 24 24\"><!-- Icon from Lucide Lab by Lucide Contributors - https://github.com/lucide-icons/lucide-lab/blob/main/LICENSE --><g fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\"><path d=\"M19.9 8.3C20.6 7 21 5.6 21 4c0-.6-.4-1-1-1c-2.3 0-4.3.8-5.9 2.2a15 15 0 0 0-4.2 0A8.78 8.78 0 0 0 4 3c-.6 0-1 .4-1 1c0 1.6.4 3 1.1 4.3c-.6.7-1.1 1.4-1.4 2.2C4 13 11 16 12 16s8-3 9.3-5.5c-.3-.8-.8-1.5-1.4-2.2M9 9v.5m4 3.5h-2m1 3v-3m3-4v.5\"/><path d=\"M6.3 20.5A6.87 6.87 0 0 0 9 15H2.2c.8 4 4.9 7 9.8 7c5.5 0 10-3.8 10-8.5c0-1.1-.2-2.1-.7-3\"/></g></svg>\n\n </a>\n <label class=\"md-header__button md-icon\" for=\"__drawer\" aria-label=\"Navigation\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-menu\" viewBox=\"0 0 24 24\"><path d=\"M4 5h16M4 12h16M4 19h16\"/></svg>\n </label>\n <div class=\"md-header__title\" data-md-component=\"header-title\">\n <div class=\"md-header__ellipsis\">\n <div class=\"md-header__topic\">\n <span class=\"md-ellipsis\">\n SimML\n <span style=\"background: var(--md-accent-fg-color--transparent); color: var(--md-accent-fg-color); padding: 2px 4px; margin:4px; border-radius: 4px; font-size: 0.6em;\">\n v0.2.2\n </span>\n </span>\n </div>\n <div class=\"md-header__topic\" data-md-component=\"header-topic\">\n <span class=\"md-ellipsis\">\n \n Overview\n \n </span>\n </div>\n </div>\n </div>\n \n \n <script>var palette=__md_get(\"__palette\");if(palette&&palette.color){if(\"(prefers-color-scheme)\"===palette.color.media){var media=matchMedia(\"(prefers-color-scheme: light)\"),input=document.querySelector(media.matches?\"[data-md-color-media='(prefers-color-scheme: light)']\":\"[data-md-color-media='(prefers-color-scheme: dark)']\");palette.color.media=input.getAttribute(\"data-md-color-media\"),palette.color.scheme=input.getAttribute(\"data-md-color-scheme\"),palette.color.primary=input.getAttribute(\"data-md-color-primary\"),palette.color.accent=input.getAttribute(\"data-md-color-accent\")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute(\"data-md-color-\"+key,value)}</script>\n \n \n \n \n \n <label class=\"md-header__button md-icon\" for=\"__search\" aria-label=\"Search\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-search\" viewBox=\"0 0 24 24\"><path d=\"m21 21-4.34-4.34\"/><circle cx=\"11\" cy=\"11\" r=\"8\"/></svg>\n </label>\n <div class=\"md-search\" data-md-component=\"search\" role=\"dialog\" aria-label=\"Search\">\n <button type=\"button\" class=\"md-search__button\">\n Search\n </button>\n</div>\n \n \n <div class=\"md-header__source\">\n \n </div>\n </nav>\n \n</header>\n \n <div class=\"md-container\" data-md-component=\"container\">\n \n \n \n \n \n<nav class=\"md-tabs\" aria-label=\"Tabs\" data-md-component=\"tabs\">\n <div class=\"md-grid\">\n <ul class=\"md-tabs__list\">\n \n \n \n \n \n \n <li class=\"md-tabs__item\">\n <a href=\"../../..\" class=\"md-tabs__link\">\n \n \n SimML\n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-tabs__item md-tabs__item--active\">\n <a href=\"../../_Get-Started/01-installation/\" class=\"md-tabs__link\">\n \n \n Documentation\n\n </a>\n </li>\n \n \n\n \n \n\n \n </ul>\n </div>\n</nav>\n \n \n \n <main class=\"md-main\" data-md-component=\"main\">\n <div class=\"md-main__inner md-grid\">\n \n \n \n <div class=\"md-sidebar md-sidebar--primary\" data-md-component=\"sidebar\" data-md-type=\"navigation\" >\n <div class=\"md-sidebar__scrollwrap\">\n <div class=\"md-sidebar__inner\">\n \n\n\n \n\n\n<nav class=\"md-nav md-nav--primary md-nav--lifted\" aria-label=\"Navigation\" data-md-level=\"0\">\n <label class=\"md-nav__title\" for=\"__drawer\">\n <a href=\"../../..\" title=\"SimML\" class=\"md-nav__button md-logo\" aria-label=\"SimML\" data-md-component=\"logo\">\n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"32\" height=\"32\" viewBox=\"0 0 24 24\"><!-- Icon from Lucide Lab by Lucide Contributors - https://github.com/lucide-icons/lucide-lab/blob/main/LICENSE --><g fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\"><path d=\"M19.9 8.3C20.6 7 21 5.6 21 4c0-.6-.4-1-1-1c-2.3 0-4.3.8-5.9 2.2a15 15 0 0 0-4.2 0A8.78 8.78 0 0 0 4 3c-.6 0-1 .4-1 1c0 1.6.4 3 1.1 4.3c-.6.7-1.1 1.4-1.4 2.2C4 13 11 16 12 16s8-3 9.3-5.5c-.3-.8-.8-1.5-1.4-2.2M9 9v.5m4 3.5h-2m1 3v-3m3-4v.5\"/><path d=\"M6.3 20.5A6.87 6.87 0 0 0 9 15H2.2c.8 4 4.9 7 9.8 7c5.5 0 10-3.8 10-8.5c0-1.1-.2-2.1-.7-3\"/></g></svg>\n\n </a>\n SimML\n </label>\n \n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../..\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-braces\" viewBox=\"0 0 24 24\"><path d=\"M8 3H7a2 2 0 0 0-2 2v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5c0 1.1.9 2 2 2h1M16 21h1a2 2 0 0 0 2-2v-5c0-1.1.9-2 2-2a2 2 0 0 1-2-2V5a2 2 0 0 0-2-2h-1\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n SimML\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested\">\n \n \n \n <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_2\" checked>\n \n \n <label class=\"md-nav__link\" for=\"__nav_2\" id=\"__nav_2_label\" tabindex=\"\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Documentation\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_2_label\" aria-expanded=\"true\">\n <label class=\"md-nav__title\" for=\"__nav_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Documentation\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--section md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_1\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_1\" id=\"__nav_2_1_label\" tabindex=\"\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Get Started\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_1_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_1\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Get Started\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../_Get-Started/01-installation/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-package-open\" viewBox=\"0 0 24 24\"><path d=\"M12 22v-9M15.17 2.21a1.67 1.67 0 0 1 1.63 0L21 4.57a1.93 1.93 0 0 1 0 3.36L8.82 14.79a1.66 1.66 0 0 1-1.64 0L3 12.43a1.93 1.93 0 0 1 0-3.36z\"/><path d=\"M20 13v3.87a2.06 2.06 0 0 1-1.11 1.83l-6 3.08a1.93 1.93 0 0 1-1.78 0l-6-3.08A2.06 2.06 0 0 1 4 16.87V13\"/><path d=\"M21 12.43a1.93 1.93 0 0 0 0-3.36L8.83 2.2a1.64 1.64 0 0 0-1.63 0L3 4.57a1.93 1.93 0 0 0 0 3.36l12.18 6.86a1.64 1.64 0 0 0 1.63 0z\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Installation\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../_Get-Started/02-minimal-example/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-file-box\" viewBox=\"0 0 24 24\"><path d=\"M14 2v5a1 1 0 0 0 1 1h5\"/><path d=\"M14.692 22H18a2 2 0 0 0 2-2V8a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 14 2H6a2 2 0 0 0-2 2v3.804\"/><path d=\"M2.264 13.752 7 16.5l4.737-2.748\"/><path d=\"M2.995 13.014A2 2 0 0 0 2 14.744v3.516a2 2 0 0 0 .996 1.73l3 1.74a2 2 0 0 0 2.008 0l3-1.74A2 2 0 0 0 12 18.26v-3.517a2 2 0 0 0-.995-1.73l-3-1.742a2 2 0 0 0-1.892-.064zM7 16.5V22\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Minimal Training Example\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../_Get-Started/03-license/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-scale\" viewBox=\"0 0 24 24\"><path d=\"M12 3v18M19 8l3 8a5 5 0 0 1-6 0zV7\"/><path d=\"M3 7h1a17 17 0 0 0 8-2 17 17 0 0 0 8 2h1M5 8l3 8a5 5 0 0 1-6 0zV7M7 21h10\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n License\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested\">\n \n \n \n <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_2_2\" checked>\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_2\" id=\"__nav_2_2_label\" tabindex=\"\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Key Concepts\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_2_label\" aria-expanded=\"true\">\n <label class=\"md-nav__title\" for=\"__nav_2_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Key Concepts\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--active\">\n \n \n \n \n \n \n \n <a href=\"././\" class=\"md-nav__link md-nav__link--active\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-info\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"M12 16v-4M12 8h.01\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Overview\n\n \n </span>\n \n \n\n </a>\n \n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n </ul>\n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-sidebar md-sidebar--secondary\" data-md-component=\"sidebar\" data-md-type=\"toc\" >\n <div class=\"md-sidebar__scrollwrap\">\n \n \n \n \n \n \n \n \n <div class=\"md-sidebar__inner\">\n \n\n\n<nav class=\"md-nav md-nav--secondary\" aria-label=\"On this page\">\n \n \n \n \n \n \n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-content\" data-md-component=\"content\">\n \n \n\n\n\n \n\n\n <nav class=\"md-path\" aria-label=\"Navigation\" >\n <ol class=\"md-path__list\">\n \n \n \n \n <li class=\"md-path__item\">\n <a href=\"../../..\" class=\"md-path__link\">\n \n \n <span class=\"md-ellipsis\">\n SimML\n </span>\n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-path__item\">\n <a href=\"../../_Get-Started/01-installation/\" class=\"md-path__link\">\n \n \n <span class=\"md-ellipsis\">\n Documentation\n </span>\n\n </a>\n </li>\n \n \n\n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-path__item\">\n <a href=\"././\" class=\"md-path__link\">\n \n \n <span class=\"md-ellipsis\">\n Key Concepts\n </span>\n\n </a>\n </li>\n \n \n\n \n </ol>\n </nav>\n\n \n <article class=\"md-content__inner md-typeset\">\n <a id=\"__skip\" tabindex=\"-1\"></a>\n \n \n\n\n<h1 id=\"overview\">Overview<a class=\"headerlink\" href=\"#overview\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> is a lightweight surrogate modeling framework built on top of <code>scikit-learn</code>.</p>\n<p>It is designed for engineering studies, numerical simulations, parametric sweeps, and batch computation workflows where large simulation datasets are generated and later approximated with fast predictive models.</p>\n<p>The library focuses on:</p>\n<ul>\n<li>simple dataset-driven workflows</li>\n<li>reproducible surrogate training</li>\n<li>automated model evaluation</li>\n<li>sklearn compatibility</li>\n<li>lightweight deployment through <code>joblib</code></li>\n</ul>\n<hr />\n<h1 id=\"core-idea\">Core Idea<a class=\"headerlink\" href=\"#core-idea\" title=\"Permanent link\">¶</a></h1>\n<p>A simulation workflow generates a CSV dataset:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-0-1\"><a id=\"__codelineno-0-1\" name=\"__codelineno-0-1\" href=\"#__codelineno-0-1\"></a>input parameters → simulation → output quantities\n</span></code></pre></div>\n<p><code>simml</code> then trains surrogate models that learn:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-1-1\"><a id=\"__codelineno-1-1\" name=\"__codelineno-1-1\" href=\"#__codelineno-1-1\"></a>f(inputs) → outputs\n</span></code></pre></div>\n<p>allowing predictions to be evaluated in milliseconds instead of rerunning expensive simulations.</p>\n<hr />\n<h1 id=\"typical-workflow\">Typical Workflow<a class=\"headerlink\" href=\"#typical-workflow\" title=\"Permanent link\">¶</a></h1>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-2-1\"><a id=\"__codelineno-2-1\" name=\"__codelineno-2-1\" href=\"#__codelineno-2-1\"></a>Batch simulations\n</span><span id=\"__span-2-2\"><a id=\"__codelineno-2-2\" name=\"__codelineno-2-2\" href=\"#__codelineno-2-2\"></a> ↓\n</span><span id=\"__span-2-3\"><a id=\"__codelineno-2-3\" name=\"__codelineno-2-3\" href=\"#__codelineno-2-3\"></a>CSV dataset generation\n</span><span id=\"__span-2-4\"><a id=\"__codelineno-2-4\" name=\"__codelineno-2-4\" href=\"#__codelineno-2-4\"></a> ↓\n</span><span id=\"__span-2-5\"><a id=\"__codelineno-2-5\" name=\"__codelineno-2-5\" href=\"#__codelineno-2-5\"></a>Train surrogate models\n</span><span id=\"__span-2-6\"><a id=\"__codelineno-2-6\" name=\"__codelineno-2-6\" href=\"#__codelineno-2-6\"></a> ↓\n</span><span id=\"__span-2-7\"><a id=\"__codelineno-2-7\" name=\"__codelineno-2-7\" href=\"#__codelineno-2-7\"></a>Cross-validation & model selection\n</span><span id=\"__span-2-8\"><a id=\"__codelineno-2-8\" name=\"__codelineno-2-8\" href=\"#__codelineno-2-8\"></a> ↓\n</span><span id=\"__span-2-9\"><a id=\"__codelineno-2-9\" name=\"__codelineno-2-9\" href=\"#__codelineno-2-9\"></a>Save trained pipelines\n</span><span id=\"__span-2-10\"><a id=\"__codelineno-2-10\" name=\"__codelineno-2-10\" href=\"#__codelineno-2-10\"></a> ↓\n</span><span id=\"__span-2-11\"><a id=\"__codelineno-2-11\" name=\"__codelineno-2-11\" href=\"#__codelineno-2-11\"></a>Fast inference / optimization / exploration\n</span></code></pre></div>\n<hr />\n<h1 id=\"dataset-structure\">Dataset Structure<a class=\"headerlink\" href=\"#dataset-structure\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> operates directly on CSV datasets.</p>\n<p>A dataset contains:</p>\n<ul>\n<li>feature columns (inputs)</li>\n<li>target columns (outputs)</li>\n</ul>\n<p>Example:</p>\n<table>\n<thead>\n<tr>\n<th>length</th>\n<th>width</th>\n<th>angle</th>\n<th>lift</th>\n<th>drag</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>1.0</td>\n<td>0.5</td>\n<td>5</td>\n<td>120</td>\n<td>12</td>\n</tr>\n<tr>\n<td>1.2</td>\n<td>0.6</td>\n<td>7</td>\n<td>135</td>\n<td>15</td>\n</tr>\n</tbody>\n</table>\n<p>Where:</p>\n<ul>\n<li><code>length</code>, <code>width</code>, <code>angle</code> are features</li>\n<li><code>lift</code>, <code>drag</code> are prediction targets</li>\n</ul>\n<hr />\n<h1 id=\"available-training-modes\">Available Training Modes<a class=\"headerlink\" href=\"#available-training-modes\" title=\"Permanent link\">¶</a></h1>\n<h2 id=\"single-output-training\">Single-Output Training<a class=\"headerlink\" href=\"#single-output-training\" title=\"Permanent link\">¶</a></h2>\n<p>Implemented with:</p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-3-1\"><a id=\"__codelineno-3-1\" name=\"__codelineno-3-1\" href=\"#__codelineno-3-1\"></a><span class=\"n\">SurrogateTrainer</span>\n</span></code></pre></div>\n<p>A separate pipeline is trained for each target variable.</p>\n<p>For:</p>\n<ul>\n<li>3 targets</li>\n<li>3 model types</li>\n</ul>\n<p>the trainer produces:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-4-1\"><a id=\"__codelineno-4-1\" name=\"__codelineno-4-1\" href=\"#__codelineno-4-1\"></a>9 independent models\n</span></code></pre></div>\n<h3 id=\"advantages\">Advantages<a class=\"headerlink\" href=\"#advantages\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>independent optimization per target</li>\n<li>simpler debugging</li>\n<li>robust behavior</li>\n<li>easier interpretation</li>\n</ul>\n<h3 id=\"typical-use-cases\">Typical Use Cases<a class=\"headerlink\" href=\"#typical-use-cases\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>unrelated target variables</li>\n<li>small datasets</li>\n<li>highly heterogeneous outputs</li>\n</ul>\n<hr />\n<h2 id=\"multi-output-training\">Multi-Output Training<a class=\"headerlink\" href=\"#multi-output-training\" title=\"Permanent link\">¶</a></h2>\n<p>Implemented with:</p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-5-1\"><a id=\"__codelineno-5-1\" name=\"__codelineno-5-1\" href=\"#__codelineno-5-1\"></a><span class=\"n\">MultiOutputSurrogateTrainer</span>\n</span></code></pre></div>\n<p>A single pipeline predicts all targets simultaneously.</p>\n<p>For:</p>\n<ul>\n<li>3 targets</li>\n<li>3 model types</li>\n</ul>\n<p>the trainer produces:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-6-1\"><a id=\"__codelineno-6-1\" name=\"__codelineno-6-1\" href=\"#__codelineno-6-1\"></a>3 multi-output models\n</span></code></pre></div>\n<h3 id=\"advantages_1\">Advantages<a class=\"headerlink\" href=\"#advantages_1\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>captures correlations between targets</li>\n<li>fewer saved models</li>\n<li>cleaner deployment</li>\n<li>potentially better global consistency</li>\n</ul>\n<h3 id=\"typical-use-cases_1\">Typical Use Cases<a class=\"headerlink\" href=\"#typical-use-cases_1\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>correlated physical quantities</li>\n<li>coupled simulation outputs</li>\n<li>reduced deployment complexity</li>\n</ul>\n<hr />\n<h1 id=\"supported-models\">Supported Models<a class=\"headerlink\" href=\"#supported-models\" title=\"Permanent link\">¶</a></h1>\n<h2 id=\"linear-regression\">Linear Regression<a class=\"headerlink\" href=\"#linear-regression\" title=\"Permanent link\">¶</a></h2>\n<p>Fast and interpretable baseline model.</p>\n<p>Best suited for:</p>\n<ul>\n<li>approximately linear systems</li>\n<li>low-noise datasets</li>\n<li>quick benchmarking</li>\n</ul>\n<hr />\n<h2 id=\"gaussian-process-regression\">Gaussian Process Regression<a class=\"headerlink\" href=\"#gaussian-process-regression\" title=\"Permanent link\">¶</a></h2>\n<p>Probabilistic non-linear regression model.</p>\n<p>Best suited for:</p>\n<ul>\n<li>smooth physical systems</li>\n<li>small to medium datasets</li>\n<li>high-accuracy interpolation</li>\n</ul>\n<p>Characteristics:</p>\n<ul>\n<li>excellent predictive quality</li>\n<li>expensive on large datasets</li>\n<li>naturally smooth predictions</li>\n</ul>\n<hr />\n<h2 id=\"neural-network-mlp\">Neural Network (MLP)<a class=\"headerlink\" href=\"#neural-network-mlp\" title=\"Permanent link\">¶</a></h2>\n<p>Multi-layer perceptron regressor using sklearn.</p>\n<p>Best suited for:</p>\n<ul>\n<li>larger datasets</li>\n<li>strongly non-linear systems</li>\n<li>high-dimensional inputs</li>\n</ul>\n<p>Characteristics:</p>\n<ul>\n<li>flexible</li>\n<li>scalable</li>\n<li>sensitive to hyperparameters</li>\n</ul>\n<hr />\n<h1 id=\"validation-strategy\">Validation Strategy<a class=\"headerlink\" href=\"#validation-strategy\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> automatically evaluates models using cross-validation.</p>\n<h2 id=\"k-fold-cross-validation\">K-Fold Cross Validation<a class=\"headerlink\" href=\"#k-fold-cross-validation\" title=\"Permanent link\">¶</a></h2>\n<p>Used to estimate generalization performance.</p>\n<p>Metrics include:</p>\n<ul>\n<li><code>R²</code></li>\n<li><code>MAE</code></li>\n<li><code>RMSE</code></li>\n</ul>\n<hr />\n<h2 id=\"leave-one-out-cross-validation-loocv\">Leave-One-Out Cross Validation (LOOCV)<a class=\"headerlink\" href=\"#leave-one-out-cross-validation-loocv\" title=\"Permanent link\">¶</a></h2>\n<p>Used to compute predictive robustness metrics.</p>\n<p>Metrics include:</p>\n<ul>\n<li><code>Q²</code></li>\n<li><code>PRESS</code></li>\n<li><code>LOOCV RMSE</code></li>\n</ul>\n<p>This is particularly useful in engineering surrogate modeling workflows.</p>\n<hr />\n<h1 id=\"saved-models\">Saved Models<a class=\"headerlink\" href=\"#saved-models\" title=\"Permanent link\">¶</a></h1>\n<p>All trained models are saved as sklearn pipelines using <code>joblib</code>.</p>\n<p>Each pipeline contains:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-7-1\"><a id=\"__codelineno-7-1\" name=\"__codelineno-7-1\" href=\"#__codelineno-7-1\"></a>StandardScaler\n</span><span id=\"__span-7-2\"><a id=\"__codelineno-7-2\" name=\"__codelineno-7-2\" href=\"#__codelineno-7-2\"></a> +\n</span><span id=\"__span-7-3\"><a id=\"__codelineno-7-3\" name=\"__codelineno-7-3\" href=\"#__codelineno-7-3\"></a>trained estimator\n</span></code></pre></div>\n<p>This guarantees identical preprocessing during inference.</p>\n<hr />\n<h1 id=\"sklearn-compatibility\">sklearn Compatibility<a class=\"headerlink\" href=\"#sklearn-compatibility\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> is intentionally built around sklearn primitives:</p>\n<ul>\n<li><code>Pipeline</code></li>\n<li><code>StandardScaler</code></li>\n<li><code>LinearRegression</code></li>\n<li><code>GaussianProcessRegressor</code></li>\n<li><code>MLPRegressor</code></li>\n</ul>\n<p>This makes the framework:</p>\n<ul>\n<li>easy to extend</li>\n<li>easy to debug</li>\n<li>interoperable with sklearn tooling</li>\n</ul>\n<hr />\n<h1 id=\"design-philosophy\">Design Philosophy<a class=\"headerlink\" href=\"#design-philosophy\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> intentionally avoids:</p>\n<ul>\n<li>proprietary binary formats</li>\n<li>hidden preprocessing</li>\n<li>complex training orchestration</li>\n<li>framework lock-in</li>\n</ul>\n<p>Instead, it favors:</p>\n<ul>\n<li>explicit configuration</li>\n<li>plain CSV datasets</li>\n<li>sklearn-native pipelines</li>\n<li>reproducible workflows</li>\n</ul>\n<hr />\n<h1 id=\"what-simml-does-not-do\">What simml does Not Do<a class=\"headerlink\" href=\"#what-simml-does-not-do\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> does not:</p>\n<ul>\n<li>generate simulation datasets</li>\n<li>manage simulation campaigns</li>\n<li>orchestrate HPC workloads</li>\n<li>perform Bayesian optimization</li>\n<li>provide deep learning frameworks</li>\n</ul>\n<p>Its role begins once a dataset already exists.</p>\n<hr />\n<h1 id=\"intended-use-cases\">Intended Use Cases<a class=\"headerlink\" href=\"#intended-use-cases\" title=\"Permanent link\">¶</a></h1>\n<p>Typical applications include:</p>\n<ul>\n<li>CFD surrogate models</li>\n<li>FEM approximation</li>\n<li>parametric engineering studies</li>\n<li>design space exploration</li>\n<li>optimization acceleration</li>\n<li>uncertainty studies</li>\n<li>reduced-order modeling</li>\n<li>fast digital twins</li>\n</ul>\n<h1 id=\"minimal-training-example\">Minimal Training Example<a class=\"headerlink\" href=\"#minimal-training-example\" title=\"Permanent link\">¶</a></h1>\n<p>See:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-8-1\"><a id=\"__codelineno-8-1\" name=\"__codelineno-8-1\" href=\"#__codelineno-8-1\"></a>minimal_example.md\n</span></code></pre></div>\n<p>for a runnable example using both:</p>\n<ul>\n<li><code>SurrogateTrainer</code></li>\n<li><code>MultiOutputSurrogateTrainer</code></li>\n</ul>\n\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n\n \n </article>\n </div>\n \n \n<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith(\"__tabbed_\"))</script>\n </div>\n \n <button type=\"button\" class=\"md-top md-icon\" data-md-component=\"top\" hidden>\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-circle-arrow-up\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"m16 12-4-4-4 4M12 16V8\"/></svg>\n Back to top\n</button>\n \n </main>\n \n <footer class=\"md-footer\">\n \n <div class=\"md-footer-meta md-typeset\">\n <div class=\"md-footer-meta__inner md-grid\">\n <div class=\"md-copyright\">\n \n <div class=\"md-copyright__highlight\">\n Copyright © 2026 SimML - A PinkSalmon Library\n </div>\n \n \n</div>\n \n </div>\n </div>\n</footer>\n \n </div>\n <div class=\"md-dialog\" data-md-component=\"dialog\" role=\"status\" aria-atomic=\"true\">\n <div class=\"md-dialog__inner md-typeset\"></div>\n </div>\n \n \n \n \n \n \n \n \n \n <script id=\"__config\" type=\"application/json\">{\"annotate\":null,\"base\":\"../../..\",\"features\":[\"navigation.tabs\",\"navigation.path\",\"navigation.expand\",\"navigation.top\",\"navigation.sections\",\"navigation.indexes\",\"content.code.copy\"],\"redirect\":null,\"search\":\"../../../assets/javascripts/workers/search.719e0d91.min.js\",\"tags\":null,\"translations\":{\"clipboard.copied\":\"Copied to clipboard\",\"clipboard.copy\":\"Copy to clipboard\",\"clipboard.error\":\"Could not copy to clipboard\",\"search.result.more.one\":\"1 more on this page\",\"search.result.more.other\":\"# more on this page\",\"search.result.none\":\"No matching documents\",\"search.result.one\":\"1 matching document\",\"search.result.other\":\"# matching documents\",\"search.result.placeholder\":\"Type to start searching\",\"search.result.term.missing\":\"Missing\",\"select.version\":\"Select version\"},\"version\":\"v0.2.2\"}</script>\n \n \n <script src=\"../../../assets/javascripts/bundle.d31f0ffa.min.js\"></script>\n \n \n </body>\n</html>","hash":1858512465517214936}
|
|
1
|
+
{"data":"\n<!doctype html>\n<html lang=\"en\" class=\"no-js\">\n <head>\n \n <meta charset=\"utf-8\">\n <meta name=\"viewport\" content=\"width=device-width,initial-scale=1\">\n \n \n <meta name=\"author\" content=\"PinkSalmon\">\n \n \n \n \n <link rel=\"prev\" href=\"../../_Get-Started/03-license/\">\n \n \n \n \n \n \n <link rel=\"icon\" href=\"../../../assets/images/favicon.png\">\n <meta name=\"generator\" content=\"zensical-0.1.0\">\n \n \n \n <title>Overview - SimML</title>\n \n \n \n \n \n \n <link rel=\"stylesheet\" href=\"../../../assets/stylesheets/modern/main.4ab2de0c.min.css\">\n \n \n\n\n \n \n \n \n \n \n \n \n <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin>\n <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,500,500i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback\">\n <style>:root{--md-text-font:\"Inter\";--md-code-font:\"JetBrains Mono\"}</style>\n \n \n \n <link rel=\"stylesheet\" href=\"../../../stylesheets/extra.css\">\n \n <script>__md_scope=new URL(\"../../..\",location),__md_scope.pathname.endsWith(\"/\")||(__md_scope=new URL(__md_scope.pathname+\"/\",location)),__md_hash=e=>[...e].reduce(((e,t)=>(e<<5)-e+t.charCodeAt(0)),0),__md_get=(e,t=localStorage,_=__md_scope)=>JSON.parse(t.getItem(_.pathname+\".\"+e)),__md_set=(e,t,_=localStorage,a=__md_scope)=>{try{_.setItem(a.pathname+\".\"+e,JSON.stringify(t))}catch(e){}},document.documentElement.setAttribute(\"data-platform\",navigator.platform)</script>\n \n \n\n \n \n </head>\n \n \n <body dir=\"ltr\">\n \n \n <input class=\"md-toggle\" data-md-toggle=\"drawer\" type=\"checkbox\" id=\"__drawer\" autocomplete=\"off\">\n <input class=\"md-toggle\" data-md-toggle=\"search\" type=\"checkbox\" id=\"__search\" autocomplete=\"off\">\n <label class=\"md-overlay\" for=\"__drawer\" aria-hidden=\"true\"></label>\n <div data-md-component=\"skip\">\n <a href=\"#__skip\" class=\"md-skip\">\n Skip to content\n </a>\n </div>\n <div data-md-component=\"announce\">\n \n </div>\n \n <div data-md-color-scheme=\"default\" data-md-component=\"outdated\" hidden>\n \n </div>\n \n \n \n\n<header class=\"md-header\" data-md-component=\"header\">\n <nav class=\"md-header__inner md-grid\" aria-label=\"Header\">\n <a href=\"../../..\" title=\"SimML\" class=\"md-header__button md-logo\" aria-label=\"SimML\" data-md-component=\"logo\">\n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"32\" height=\"32\" viewBox=\"0 0 24 24\"><!-- Icon from Lucide Lab by Lucide Contributors - https://github.com/lucide-icons/lucide-lab/blob/main/LICENSE --><g fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\"><path d=\"M19.9 8.3C20.6 7 21 5.6 21 4c0-.6-.4-1-1-1c-2.3 0-4.3.8-5.9 2.2a15 15 0 0 0-4.2 0A8.78 8.78 0 0 0 4 3c-.6 0-1 .4-1 1c0 1.6.4 3 1.1 4.3c-.6.7-1.1 1.4-1.4 2.2C4 13 11 16 12 16s8-3 9.3-5.5c-.3-.8-.8-1.5-1.4-2.2M9 9v.5m4 3.5h-2m1 3v-3m3-4v.5\"/><path d=\"M6.3 20.5A6.87 6.87 0 0 0 9 15H2.2c.8 4 4.9 7 9.8 7c5.5 0 10-3.8 10-8.5c0-1.1-.2-2.1-.7-3\"/></g></svg>\n\n </a>\n <label class=\"md-header__button md-icon\" for=\"__drawer\" aria-label=\"Navigation\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-menu\" viewBox=\"0 0 24 24\"><path d=\"M4 5h16M4 12h16M4 19h16\"/></svg>\n </label>\n <div class=\"md-header__title\" data-md-component=\"header-title\">\n <div class=\"md-header__ellipsis\">\n <div class=\"md-header__topic\">\n <span class=\"md-ellipsis\">\n SimML\n <span style=\"background: var(--md-accent-fg-color--transparent); color: var(--md-accent-fg-color); padding: 2px 4px; margin:4px; border-radius: 4px; font-size: 0.6em;\">\n v0.2.3\n </span>\n </span>\n </div>\n <div class=\"md-header__topic\" data-md-component=\"header-topic\">\n <span class=\"md-ellipsis\">\n \n Overview\n \n </span>\n </div>\n </div>\n </div>\n \n \n <script>var palette=__md_get(\"__palette\");if(palette&&palette.color){if(\"(prefers-color-scheme)\"===palette.color.media){var media=matchMedia(\"(prefers-color-scheme: light)\"),input=document.querySelector(media.matches?\"[data-md-color-media='(prefers-color-scheme: light)']\":\"[data-md-color-media='(prefers-color-scheme: dark)']\");palette.color.media=input.getAttribute(\"data-md-color-media\"),palette.color.scheme=input.getAttribute(\"data-md-color-scheme\"),palette.color.primary=input.getAttribute(\"data-md-color-primary\"),palette.color.accent=input.getAttribute(\"data-md-color-accent\")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute(\"data-md-color-\"+key,value)}</script>\n \n \n \n \n \n <label class=\"md-header__button md-icon\" for=\"__search\" aria-label=\"Search\">\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-search\" viewBox=\"0 0 24 24\"><path d=\"m21 21-4.34-4.34\"/><circle cx=\"11\" cy=\"11\" r=\"8\"/></svg>\n </label>\n <div class=\"md-search\" data-md-component=\"search\" role=\"dialog\" aria-label=\"Search\">\n <button type=\"button\" class=\"md-search__button\">\n Search\n </button>\n</div>\n \n \n <div class=\"md-header__source\">\n \n </div>\n </nav>\n \n</header>\n \n <div class=\"md-container\" data-md-component=\"container\">\n \n \n \n \n \n<nav class=\"md-tabs\" aria-label=\"Tabs\" data-md-component=\"tabs\">\n <div class=\"md-grid\">\n <ul class=\"md-tabs__list\">\n \n \n \n \n \n \n <li class=\"md-tabs__item\">\n <a href=\"../../..\" class=\"md-tabs__link\">\n \n \n SimML\n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-tabs__item md-tabs__item--active\">\n <a href=\"../../_Get-Started/01-installation/\" class=\"md-tabs__link\">\n \n \n Documentation\n\n </a>\n </li>\n \n \n\n \n \n\n \n </ul>\n </div>\n</nav>\n \n \n \n <main class=\"md-main\" data-md-component=\"main\">\n <div class=\"md-main__inner md-grid\">\n \n \n \n <div class=\"md-sidebar md-sidebar--primary\" data-md-component=\"sidebar\" data-md-type=\"navigation\" >\n <div class=\"md-sidebar__scrollwrap\">\n <div class=\"md-sidebar__inner\">\n \n\n\n \n\n\n<nav class=\"md-nav md-nav--primary md-nav--lifted\" aria-label=\"Navigation\" data-md-level=\"0\">\n <label class=\"md-nav__title\" for=\"__drawer\">\n <a href=\"../../..\" title=\"SimML\" class=\"md-nav__button md-logo\" aria-label=\"SimML\" data-md-component=\"logo\">\n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"32\" height=\"32\" viewBox=\"0 0 24 24\"><!-- Icon from Lucide Lab by Lucide Contributors - https://github.com/lucide-icons/lucide-lab/blob/main/LICENSE --><g fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\"><path d=\"M19.9 8.3C20.6 7 21 5.6 21 4c0-.6-.4-1-1-1c-2.3 0-4.3.8-5.9 2.2a15 15 0 0 0-4.2 0A8.78 8.78 0 0 0 4 3c-.6 0-1 .4-1 1c0 1.6.4 3 1.1 4.3c-.6.7-1.1 1.4-1.4 2.2C4 13 11 16 12 16s8-3 9.3-5.5c-.3-.8-.8-1.5-1.4-2.2M9 9v.5m4 3.5h-2m1 3v-3m3-4v.5\"/><path d=\"M6.3 20.5A6.87 6.87 0 0 0 9 15H2.2c.8 4 4.9 7 9.8 7c5.5 0 10-3.8 10-8.5c0-1.1-.2-2.1-.7-3\"/></g></svg>\n\n </a>\n SimML\n </label>\n \n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../..\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-braces\" viewBox=\"0 0 24 24\"><path d=\"M8 3H7a2 2 0 0 0-2 2v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5c0 1.1.9 2 2 2h1M16 21h1a2 2 0 0 0 2-2v-5c0-1.1.9-2 2-2a2 2 0 0 1-2-2V5a2 2 0 0 0-2-2h-1\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n SimML\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested\">\n \n \n \n <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_2\" checked>\n \n \n <label class=\"md-nav__link\" for=\"__nav_2\" id=\"__nav_2_label\" tabindex=\"\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Documentation\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_2_label\" aria-expanded=\"true\">\n <label class=\"md-nav__title\" for=\"__nav_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Documentation\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--section md-nav__item--nested\">\n \n \n \n \n \n <input class=\"md-nav__toggle md-toggle md-toggle--indeterminate\" type=\"checkbox\" id=\"__nav_2_1\" >\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_1\" id=\"__nav_2_1_label\" tabindex=\"\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Get Started\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_1_label\" aria-expanded=\"false\">\n <label class=\"md-nav__title\" for=\"__nav_2_1\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Get Started\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../_Get-Started/01-installation/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-package-open\" viewBox=\"0 0 24 24\"><path d=\"M12 22v-9M15.17 2.21a1.67 1.67 0 0 1 1.63 0L21 4.57a1.93 1.93 0 0 1 0 3.36L8.82 14.79a1.66 1.66 0 0 1-1.64 0L3 12.43a1.93 1.93 0 0 1 0-3.36z\"/><path d=\"M20 13v3.87a2.06 2.06 0 0 1-1.11 1.83l-6 3.08a1.93 1.93 0 0 1-1.78 0l-6-3.08A2.06 2.06 0 0 1 4 16.87V13\"/><path d=\"M21 12.43a1.93 1.93 0 0 0 0-3.36L8.83 2.2a1.64 1.64 0 0 0-1.63 0L3 4.57a1.93 1.93 0 0 0 0 3.36l12.18 6.86a1.64 1.64 0 0 0 1.63 0z\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Installation\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../_Get-Started/02-minimal-example/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-file-box\" viewBox=\"0 0 24 24\"><path d=\"M14 2v5a1 1 0 0 0 1 1h5\"/><path d=\"M14.692 22H18a2 2 0 0 0 2-2V8a2.4 2.4 0 0 0-.706-1.706l-3.588-3.588A2.4 2.4 0 0 0 14 2H6a2 2 0 0 0-2 2v3.804\"/><path d=\"M2.264 13.752 7 16.5l4.737-2.748\"/><path d=\"M2.995 13.014A2 2 0 0 0 2 14.744v3.516a2 2 0 0 0 .996 1.73l3 1.74a2 2 0 0 0 2.008 0l3-1.74A2 2 0 0 0 12 18.26v-3.517a2 2 0 0 0-.995-1.73l-3-1.742a2 2 0 0 0-1.892-.064zM7 16.5V22\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Minimal Training Example\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n <li class=\"md-nav__item\">\n <a href=\"../../_Get-Started/03-license/\" class=\"md-nav__link\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-scale\" viewBox=\"0 0 24 24\"><path d=\"M12 3v18M19 8l3 8a5 5 0 0 1-6 0zV7\"/><path d=\"M3 7h1a17 17 0 0 0 8-2 17 17 0 0 0 8 2h1M5 8l3 8a5 5 0 0 1-6 0zV7M7 21h10\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n License\n\n \n </span>\n \n \n\n </a>\n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested\">\n \n \n \n <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_2_2\" checked>\n \n \n <label class=\"md-nav__link\" for=\"__nav_2_2\" id=\"__nav_2_2_label\" tabindex=\"\">\n \n \n \n <span class=\"md-ellipsis\">\n \n \n Key Concepts\n\n \n </span>\n \n \n\n <span class=\"md-nav__icon md-icon\"></span>\n </label>\n \n \n <nav class=\"md-nav\" data-md-level=\"2\" aria-labelledby=\"__nav_2_2_label\" aria-expanded=\"true\">\n <label class=\"md-nav__title\" for=\"__nav_2_2\">\n <span class=\"md-nav__icon md-icon\"></span>\n \n \n Key Concepts\n\n </label>\n <ul class=\"md-nav__list\" data-md-scrollfix>\n \n \n \n \n \n \n \n \n \n <li class=\"md-nav__item md-nav__item--active\">\n \n \n \n \n \n \n \n <a href=\"././\" class=\"md-nav__link md-nav__link--active\">\n \n \n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-info\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"M12 16v-4M12 8h.01\"/></svg>\n \n <span class=\"md-ellipsis\">\n \n \n Overview\n\n \n </span>\n \n \n\n </a>\n \n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n \n </ul>\n </nav>\n \n \n </li>\n \n\n \n </ul>\n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-sidebar md-sidebar--secondary\" data-md-component=\"sidebar\" data-md-type=\"toc\" >\n <div class=\"md-sidebar__scrollwrap\">\n \n \n \n \n \n \n \n \n <div class=\"md-sidebar__inner\">\n \n\n\n<nav class=\"md-nav md-nav--secondary\" aria-label=\"On this page\">\n \n \n \n \n \n \n</nav>\n </div>\n </div>\n </div>\n \n \n \n <div class=\"md-content\" data-md-component=\"content\">\n \n \n\n\n\n \n\n\n <nav class=\"md-path\" aria-label=\"Navigation\" >\n <ol class=\"md-path__list\">\n \n \n \n \n <li class=\"md-path__item\">\n <a href=\"../../..\" class=\"md-path__link\">\n \n \n <span class=\"md-ellipsis\">\n SimML\n </span>\n\n </a>\n </li>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-path__item\">\n <a href=\"../../_Get-Started/01-installation/\" class=\"md-path__link\">\n \n \n <span class=\"md-ellipsis\">\n Documentation\n </span>\n\n </a>\n </li>\n \n \n\n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n <li class=\"md-path__item\">\n <a href=\"././\" class=\"md-path__link\">\n \n \n <span class=\"md-ellipsis\">\n Key Concepts\n </span>\n\n </a>\n </li>\n \n \n\n \n </ol>\n </nav>\n\n \n <article class=\"md-content__inner md-typeset\">\n <a id=\"__skip\" tabindex=\"-1\"></a>\n \n \n\n\n<h1 id=\"overview\">Overview<a class=\"headerlink\" href=\"#overview\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> is a lightweight surrogate modeling framework built on top of <code>scikit-learn</code>.</p>\n<p>It is designed for engineering studies, numerical simulations, parametric sweeps, and batch computation workflows where large simulation datasets are generated and later approximated with fast predictive models.</p>\n<p>The library focuses on:</p>\n<ul>\n<li>simple dataset-driven workflows</li>\n<li>reproducible surrogate training</li>\n<li>automated model evaluation</li>\n<li>sklearn compatibility</li>\n<li>lightweight deployment through <code>joblib</code></li>\n</ul>\n<hr />\n<h1 id=\"core-idea\">Core Idea<a class=\"headerlink\" href=\"#core-idea\" title=\"Permanent link\">¶</a></h1>\n<p>A simulation workflow generates a CSV dataset:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-0-1\"><a id=\"__codelineno-0-1\" name=\"__codelineno-0-1\" href=\"#__codelineno-0-1\"></a>input parameters → simulation → output quantities\n</span></code></pre></div>\n<p><code>simml</code> then trains surrogate models that learn:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-1-1\"><a id=\"__codelineno-1-1\" name=\"__codelineno-1-1\" href=\"#__codelineno-1-1\"></a>f(inputs) → outputs\n</span></code></pre></div>\n<p>allowing predictions to be evaluated in milliseconds instead of rerunning expensive simulations.</p>\n<hr />\n<h1 id=\"typical-workflow\">Typical Workflow<a class=\"headerlink\" href=\"#typical-workflow\" title=\"Permanent link\">¶</a></h1>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-2-1\"><a id=\"__codelineno-2-1\" name=\"__codelineno-2-1\" href=\"#__codelineno-2-1\"></a>Batch simulations\n</span><span id=\"__span-2-2\"><a id=\"__codelineno-2-2\" name=\"__codelineno-2-2\" href=\"#__codelineno-2-2\"></a> ↓\n</span><span id=\"__span-2-3\"><a id=\"__codelineno-2-3\" name=\"__codelineno-2-3\" href=\"#__codelineno-2-3\"></a>CSV dataset generation\n</span><span id=\"__span-2-4\"><a id=\"__codelineno-2-4\" name=\"__codelineno-2-4\" href=\"#__codelineno-2-4\"></a> ↓\n</span><span id=\"__span-2-5\"><a id=\"__codelineno-2-5\" name=\"__codelineno-2-5\" href=\"#__codelineno-2-5\"></a>Train surrogate models\n</span><span id=\"__span-2-6\"><a id=\"__codelineno-2-6\" name=\"__codelineno-2-6\" href=\"#__codelineno-2-6\"></a> ↓\n</span><span id=\"__span-2-7\"><a id=\"__codelineno-2-7\" name=\"__codelineno-2-7\" href=\"#__codelineno-2-7\"></a>Cross-validation & model selection\n</span><span id=\"__span-2-8\"><a id=\"__codelineno-2-8\" name=\"__codelineno-2-8\" href=\"#__codelineno-2-8\"></a> ↓\n</span><span id=\"__span-2-9\"><a id=\"__codelineno-2-9\" name=\"__codelineno-2-9\" href=\"#__codelineno-2-9\"></a>Save trained pipelines\n</span><span id=\"__span-2-10\"><a id=\"__codelineno-2-10\" name=\"__codelineno-2-10\" href=\"#__codelineno-2-10\"></a> ↓\n</span><span id=\"__span-2-11\"><a id=\"__codelineno-2-11\" name=\"__codelineno-2-11\" href=\"#__codelineno-2-11\"></a>Fast inference / optimization / exploration\n</span></code></pre></div>\n<hr />\n<h1 id=\"dataset-structure\">Dataset Structure<a class=\"headerlink\" href=\"#dataset-structure\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> operates directly on CSV datasets.</p>\n<p>A dataset contains:</p>\n<ul>\n<li>feature columns (inputs)</li>\n<li>target columns (outputs)</li>\n</ul>\n<p>Example:</p>\n<table>\n<thead>\n<tr>\n<th>length</th>\n<th>width</th>\n<th>angle</th>\n<th>lift</th>\n<th>drag</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>1.0</td>\n<td>0.5</td>\n<td>5</td>\n<td>120</td>\n<td>12</td>\n</tr>\n<tr>\n<td>1.2</td>\n<td>0.6</td>\n<td>7</td>\n<td>135</td>\n<td>15</td>\n</tr>\n</tbody>\n</table>\n<p>Where:</p>\n<ul>\n<li><code>length</code>, <code>width</code>, <code>angle</code> are features</li>\n<li><code>lift</code>, <code>drag</code> are prediction targets</li>\n</ul>\n<hr />\n<h1 id=\"available-training-modes\">Available Training Modes<a class=\"headerlink\" href=\"#available-training-modes\" title=\"Permanent link\">¶</a></h1>\n<h2 id=\"single-output-training\">Single-Output Training<a class=\"headerlink\" href=\"#single-output-training\" title=\"Permanent link\">¶</a></h2>\n<p>Implemented with:</p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-3-1\"><a id=\"__codelineno-3-1\" name=\"__codelineno-3-1\" href=\"#__codelineno-3-1\"></a><span class=\"n\">SurrogateTrainer</span>\n</span></code></pre></div>\n<p>A separate pipeline is trained for each target variable.</p>\n<p>For:</p>\n<ul>\n<li>3 targets</li>\n<li>3 model types</li>\n</ul>\n<p>the trainer produces:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-4-1\"><a id=\"__codelineno-4-1\" name=\"__codelineno-4-1\" href=\"#__codelineno-4-1\"></a>9 independent models\n</span></code></pre></div>\n<h3 id=\"advantages\">Advantages<a class=\"headerlink\" href=\"#advantages\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>independent optimization per target</li>\n<li>simpler debugging</li>\n<li>robust behavior</li>\n<li>easier interpretation</li>\n</ul>\n<h3 id=\"typical-use-cases\">Typical Use Cases<a class=\"headerlink\" href=\"#typical-use-cases\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>unrelated target variables</li>\n<li>small datasets</li>\n<li>highly heterogeneous outputs</li>\n</ul>\n<hr />\n<h2 id=\"multi-output-training\">Multi-Output Training<a class=\"headerlink\" href=\"#multi-output-training\" title=\"Permanent link\">¶</a></h2>\n<p>Implemented with:</p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-5-1\"><a id=\"__codelineno-5-1\" name=\"__codelineno-5-1\" href=\"#__codelineno-5-1\"></a><span class=\"n\">MultiOutputSurrogateTrainer</span>\n</span></code></pre></div>\n<p>A single pipeline predicts all targets simultaneously.</p>\n<p>For:</p>\n<ul>\n<li>3 targets</li>\n<li>3 model types</li>\n</ul>\n<p>the trainer produces:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-6-1\"><a id=\"__codelineno-6-1\" name=\"__codelineno-6-1\" href=\"#__codelineno-6-1\"></a>3 multi-output models\n</span></code></pre></div>\n<h3 id=\"advantages_1\">Advantages<a class=\"headerlink\" href=\"#advantages_1\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>captures correlations between targets</li>\n<li>fewer saved models</li>\n<li>cleaner deployment</li>\n<li>potentially better global consistency</li>\n</ul>\n<h3 id=\"typical-use-cases_1\">Typical Use Cases<a class=\"headerlink\" href=\"#typical-use-cases_1\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>correlated physical quantities</li>\n<li>coupled simulation outputs</li>\n<li>reduced deployment complexity</li>\n</ul>\n<hr />\n<h1 id=\"supported-models\">Supported Models<a class=\"headerlink\" href=\"#supported-models\" title=\"Permanent link\">¶</a></h1>\n<h2 id=\"linear-regression\">Linear Regression<a class=\"headerlink\" href=\"#linear-regression\" title=\"Permanent link\">¶</a></h2>\n<p>Fast and interpretable baseline model.</p>\n<p>Best suited for:</p>\n<ul>\n<li>approximately linear systems</li>\n<li>low-noise datasets</li>\n<li>quick benchmarking</li>\n</ul>\n<hr />\n<h2 id=\"gaussian-process-regression\">Gaussian Process Regression<a class=\"headerlink\" href=\"#gaussian-process-regression\" title=\"Permanent link\">¶</a></h2>\n<p>Probabilistic non-linear regression model.</p>\n<p>Best suited for:</p>\n<ul>\n<li>smooth physical systems</li>\n<li>small to medium datasets</li>\n<li>high-accuracy interpolation</li>\n</ul>\n<p>Characteristics:</p>\n<ul>\n<li>excellent predictive quality</li>\n<li>expensive on large datasets</li>\n<li>naturally smooth predictions</li>\n</ul>\n<hr />\n<h2 id=\"neural-network-mlp\">Neural Network (MLP)<a class=\"headerlink\" href=\"#neural-network-mlp\" title=\"Permanent link\">¶</a></h2>\n<p>Multi-layer perceptron regressor using sklearn.</p>\n<p>Best suited for:</p>\n<ul>\n<li>larger datasets</li>\n<li>strongly non-linear systems</li>\n<li>high-dimensional inputs</li>\n</ul>\n<p>Characteristics:</p>\n<ul>\n<li>flexible</li>\n<li>scalable</li>\n<li>sensitive to hyperparameters</li>\n</ul>\n<hr />\n<h1 id=\"validation-strategy\">Validation Strategy<a class=\"headerlink\" href=\"#validation-strategy\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> automatically evaluates models using cross-validation.</p>\n<h2 id=\"k-fold-cross-validation\">K-Fold Cross Validation<a class=\"headerlink\" href=\"#k-fold-cross-validation\" title=\"Permanent link\">¶</a></h2>\n<p>Used to estimate generalization performance.</p>\n<p>Metrics include:</p>\n<ul>\n<li><code>R²</code></li>\n<li><code>MAE</code></li>\n<li><code>RMSE</code></li>\n</ul>\n<hr />\n<h2 id=\"leave-one-out-cross-validation-loocv\">Leave-One-Out Cross Validation (LOOCV)<a class=\"headerlink\" href=\"#leave-one-out-cross-validation-loocv\" title=\"Permanent link\">¶</a></h2>\n<p>Used to compute predictive robustness metrics.</p>\n<p>Metrics include:</p>\n<ul>\n<li><code>Q²</code></li>\n<li><code>PRESS</code></li>\n<li><code>LOOCV RMSE</code></li>\n</ul>\n<p>This is particularly useful in engineering surrogate modeling workflows.</p>\n<hr />\n<h1 id=\"saved-models\">Saved Models<a class=\"headerlink\" href=\"#saved-models\" title=\"Permanent link\">¶</a></h1>\n<p>All trained models are saved as sklearn pipelines using <code>joblib</code>.</p>\n<p>Each pipeline contains:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-7-1\"><a id=\"__codelineno-7-1\" name=\"__codelineno-7-1\" href=\"#__codelineno-7-1\"></a>StandardScaler\n</span><span id=\"__span-7-2\"><a id=\"__codelineno-7-2\" name=\"__codelineno-7-2\" href=\"#__codelineno-7-2\"></a> +\n</span><span id=\"__span-7-3\"><a id=\"__codelineno-7-3\" name=\"__codelineno-7-3\" href=\"#__codelineno-7-3\"></a>trained estimator\n</span></code></pre></div>\n<p>This guarantees identical preprocessing during inference.</p>\n<hr />\n<h1 id=\"sklearn-compatibility\">sklearn Compatibility<a class=\"headerlink\" href=\"#sklearn-compatibility\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> is intentionally built around sklearn primitives:</p>\n<ul>\n<li><code>Pipeline</code></li>\n<li><code>StandardScaler</code></li>\n<li><code>LinearRegression</code></li>\n<li><code>GaussianProcessRegressor</code></li>\n<li><code>MLPRegressor</code></li>\n</ul>\n<p>This makes the framework:</p>\n<ul>\n<li>easy to extend</li>\n<li>easy to debug</li>\n<li>interoperable with sklearn tooling</li>\n</ul>\n<hr />\n<h1 id=\"design-philosophy\">Design Philosophy<a class=\"headerlink\" href=\"#design-philosophy\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> intentionally avoids:</p>\n<ul>\n<li>proprietary binary formats</li>\n<li>hidden preprocessing</li>\n<li>complex training orchestration</li>\n<li>framework lock-in</li>\n</ul>\n<p>Instead, it favors:</p>\n<ul>\n<li>explicit configuration</li>\n<li>plain CSV datasets</li>\n<li>sklearn-native pipelines</li>\n<li>reproducible workflows</li>\n</ul>\n<hr />\n<h1 id=\"what-simml-does-not-do\">What simml does Not Do<a class=\"headerlink\" href=\"#what-simml-does-not-do\" title=\"Permanent link\">¶</a></h1>\n<p><code>simml</code> does not:</p>\n<ul>\n<li>generate simulation datasets</li>\n<li>manage simulation campaigns</li>\n<li>orchestrate HPC workloads</li>\n<li>perform Bayesian optimization</li>\n<li>provide deep learning frameworks</li>\n</ul>\n<p>Its role begins once a dataset already exists.</p>\n<hr />\n<h1 id=\"intended-use-cases\">Intended Use Cases<a class=\"headerlink\" href=\"#intended-use-cases\" title=\"Permanent link\">¶</a></h1>\n<p>Typical applications include:</p>\n<ul>\n<li>CFD surrogate models</li>\n<li>FEM approximation</li>\n<li>parametric engineering studies</li>\n<li>design space exploration</li>\n<li>optimization acceleration</li>\n<li>uncertainty studies</li>\n<li>reduced-order modeling</li>\n<li>fast digital twins</li>\n</ul>\n<h1 id=\"minimal-training-example\">Minimal Training Example<a class=\"headerlink\" href=\"#minimal-training-example\" title=\"Permanent link\">¶</a></h1>\n<p>See:</p>\n<div class=\"language-text highlight\"><pre><span></span><code><span id=\"__span-8-1\"><a id=\"__codelineno-8-1\" name=\"__codelineno-8-1\" href=\"#__codelineno-8-1\"></a>minimal_example.md\n</span></code></pre></div>\n<p>for a runnable example using both:</p>\n<ul>\n<li><code>SurrogateTrainer</code></li>\n<li><code>MultiOutputSurrogateTrainer</code></li>\n</ul>\n\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n\n \n </article>\n </div>\n \n \n<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith(\"__tabbed_\"))</script>\n </div>\n \n <button type=\"button\" class=\"md-top md-icon\" data-md-component=\"top\" hidden>\n \n <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-circle-arrow-up\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"m16 12-4-4-4 4M12 16V8\"/></svg>\n Back to top\n</button>\n \n </main>\n \n <footer class=\"md-footer\">\n \n <div class=\"md-footer-meta md-typeset\">\n <div class=\"md-footer-meta__inner md-grid\">\n <div class=\"md-copyright\">\n \n <div class=\"md-copyright__highlight\">\n Copyright © 2026 SimML - A PinkSalmon Library\n </div>\n \n \n</div>\n \n </div>\n </div>\n</footer>\n \n </div>\n <div class=\"md-dialog\" data-md-component=\"dialog\" role=\"status\" aria-atomic=\"true\">\n <div class=\"md-dialog__inner md-typeset\"></div>\n </div>\n \n \n \n \n \n \n \n \n \n <script id=\"__config\" type=\"application/json\">{\"annotate\":null,\"base\":\"../../..\",\"features\":[\"navigation.tabs\",\"navigation.path\",\"navigation.expand\",\"navigation.top\",\"navigation.sections\",\"navigation.indexes\",\"content.code.copy\"],\"redirect\":null,\"search\":\"../../../assets/javascripts/workers/search.719e0d91.min.js\",\"tags\":null,\"translations\":{\"clipboard.copied\":\"Copied to clipboard\",\"clipboard.copy\":\"Copy to clipboard\",\"clipboard.error\":\"Could not copy to clipboard\",\"search.result.more.one\":\"1 more on this page\",\"search.result.more.other\":\"# more on this page\",\"search.result.none\":\"No matching documents\",\"search.result.one\":\"1 matching document\",\"search.result.other\":\"# matching documents\",\"search.result.placeholder\":\"Type to start searching\",\"search.result.term.missing\":\"Missing\",\"select.version\":\"Select version\"},\"version\":\"v0.2.3\"}</script>\n \n \n <script src=\"../../../assets/javascripts/bundle.d31f0ffa.min.js\"></script>\n \n \n </body>\n</html>","hash":10353577715685682881}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"data":{"origin":{"Source":"documentation/_Get-Started/01-installation.md"},"route":{"source":"documentation/_Get-Started/01-installation.md","destination":"documentation/_Get-Started/01-installation/index.html","url":"documentation/_Get-Started/01-installation/"},"properties":{},"variables":{},"markdown":{"meta":{"icon":"lucide/package-open","tags":["Get started"]},"content":"<h1 id=\"installation\">Installation<a class=\"headerlink\" href=\"#installation\" title=\"Permanent link\">¶</a></h1>\n<p><strong>SimML</strong> is written in <strong>Python</strong> and is published as a <strong>Python package</strong>. It could be installed with <strong>pip</strong> or with your favorite <strong>package manager</strong>.</p>\n<h2 id=\"install-with-pip\">Install with pip<a class=\"headerlink\" href=\"#install-with-pip\" title=\"Permanent link\">¶</a></h2>\n<div class=\"language-sh highlight\"><pre><span></span><code><span id=\"__span-0-1\"><a id=\"__codelineno-0-1\" name=\"__codelineno-0-1\" href=\"#__codelineno-0-1\"></a>pip<span class=\"w\"> </span>install<span class=\"w\"> </span>simml\n</span></code></pre></div>\n<p>We recommend to use a Python virtual environment when installing with pip.</p>\n<div class=\"tabbed-set tabbed-alternate\" data-tabs=\"1:3\"><input checked=\"checked\" id=\"__tabbed_1_1\" name=\"__tabbed_1\" type=\"radio\" /><input id=\"__tabbed_1_2\" name=\"__tabbed_1\" type=\"radio\" /><input id=\"__tabbed_1_3\" name=\"__tabbed_1\" type=\"radio\" /><div class=\"tabbed-labels\"><label for=\"__tabbed_1_1\"><span class=\"twemoji\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M18.71 19.5c-.83 1.24-1.71 2.45-3.05 2.47-1.34.03-1.77-.79-3.29-.79-1.53 0-2 .77-3.27.82-1.31.05-2.3-1.32-3.14-2.53C4.25 17 2.94 12.45 4.7 9.39c.87-1.52 2.43-2.48 4.12-2.51 1.28-.02 2.5.87 3.29.87.78 0 2.26-1.07 3.81-.91.65.03 2.47.26 3.64 1.98-.09.06-2.17 1.28-2.15 3.81.03 3.02 2.65 4.03 2.68 4.04-.03.07-.42 1.44-1.38 2.83M13 3.5c.73-.83 1.94-1.46 2.94-1.5.13 1.17-.34 2.35-1.04 3.19-.69.85-1.83 1.51-2.95 1.42-.15-1.15.41-2.35 1.05-3.11\"/></svg></span> macOS</label><label for=\"__tabbed_1_2\"><span class=\"twemoji\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 448 512\"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc.--><path fill=\"currentColor\" d=\"m0 93.7 183.6-25.3v177.4H0zm0 324.6 183.6 25.3V268.4H0zm203.8 28L448 480V268.4H203.8zm0-380.6v180.1H448V32z\"/></svg></span> Windows</label><label for=\"__tabbed_1_3\"><span class=\"twemoji\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M14.62 8.35c-.42.28-1.75 1.04-1.95 1.19-.39.31-.75.29-1.14-.01-.2-.16-1.53-.92-1.95-1.19-.48-.31-.45-.7.08-.92 1.64-.69 3.28-.64 4.91.03.49.21.51.6.05.9m7.22 7.28c-.93-2.09-2.2-3.99-3.84-5.66a4.3 4.3 0 0 1-1.06-1.88c-.1-.33-.17-.67-.24-1.01-.2-.88-.29-1.78-.7-2.61-.73-1.58-2-2.4-3.84-2.47-1.81.05-3.16.81-3.95 2.4-.21.43-.36.88-.46 1.34-.17.76-.32 1.55-.5 2.32-.15.65-.45 1.21-.96 1.71-1.61 1.57-2.9 3.37-3.88 5.35-.14.29-.28.58-.37.88-.19.66.29 1.12.99.96.44-.09.88-.18 1.3-.31.41-.15.57-.05.67.35.65 2.15 2.07 3.66 4.24 4.5 4.12 1.56 8.93-.66 9.97-4.58.07-.27.17-.37.47-.27.46.14.93.24 1.4.35.49.09.85-.16.92-.64.03-.26-.06-.49-.16-.73\"/></svg></span> Linux</label></div>\n<div class=\"tabbed-content\">\n<div class=\"tabbed-block\">\n<div class=\"language-sh highlight\"><pre><span></span><code><span id=\"__span-1-1\"><a id=\"__codelineno-1-1\" name=\"__codelineno-1-1\" href=\"#__codelineno-1-1\"></a>python3<span class=\"w\"> </span>-m<span class=\"w\"> </span>venv<span class=\"w\"> </span>.venv\n</span><span id=\"__span-1-2\"><a id=\"__codelineno-1-2\" name=\"__codelineno-1-2\" href=\"#__codelineno-1-2\"></a><span class=\"nb\">source</span><span class=\"w\"> </span>.venv/bin/activate\n</span><span id=\"__span-1-3\"><a id=\"__codelineno-1-3\" name=\"__codelineno-1-3\" href=\"#__codelineno-1-3\"></a>pip<span class=\"w\"> </span>install<span class=\"w\"> </span>simml\n</span></code></pre></div>\n</div>\n<div class=\"tabbed-block\">\n<div class=\"language-ps1 highlight\"><pre><span></span><code><span id=\"__span-2-1\"><a id=\"__codelineno-2-1\" name=\"__codelineno-2-1\" href=\"#__codelineno-2-1\"></a><span class=\"n\">python</span> <span class=\"n\">-m</span> <span class=\"n\">venv</span> <span class=\"p\">.</span><span class=\"n\">venv</span>\n</span><span id=\"__span-2-2\"><a id=\"__codelineno-2-2\" name=\"__codelineno-2-2\" href=\"#__codelineno-2-2\"></a><span class=\"p\">.</span><span class=\"n\">venv</span><span class=\"p\">\\</span><span class=\"n\">Scripts</span><span class=\"p\">\\</span><span class=\"n\">activate</span>\n</span><span id=\"__span-2-3\"><a id=\"__codelineno-2-3\" name=\"__codelineno-2-3\" href=\"#__codelineno-2-3\"></a><span class=\"n\">pip</span> <span class=\"n\">install</span> <span class=\"n\">simml</span>\n</span></code></pre></div>\n</div>\n<div class=\"tabbed-block\">\n<div class=\"language-sh highlight\"><pre><span></span><code><span id=\"__span-3-1\"><a id=\"__codelineno-3-1\" name=\"__codelineno-3-1\" href=\"#__codelineno-3-1\"></a>python3<span class=\"w\"> </span>-m<span class=\"w\"> </span>venv<span class=\"w\"> </span>.venv\n</span><span id=\"__span-3-2\"><a id=\"__codelineno-3-2\" name=\"__codelineno-3-2\" href=\"#__codelineno-3-2\"></a><span class=\"nb\">source</span><span class=\"w\"> </span>.venv/bin/activate\n</span><span id=\"__span-3-3\"><a id=\"__codelineno-3-3\" name=\"__codelineno-3-3\" href=\"#__codelineno-3-3\"></a>pip<span class=\"w\"> </span>install<span class=\"w\"> </span>simml\n</span></code></pre></div>\n</div>\n</div>\n</div>","toc":[{"title":"Installation","content":"Installation","id":"installation","url":"#installation","children":[{"title":"Install with pip","content":"Install with pip","id":"install-with-pip","url":"#install-with-pip","children":[],"level":2}],"level":1}]},"title":"Installation","navigation_title":null,"html":{"autorefs":{"references":[]},"autorefs_registrations":{"primary":{"
|
|
1
|
+
{"data":{"origin":{"Source":"documentation/_Get-Started/01-installation.md"},"route":{"source":"documentation/_Get-Started/01-installation.md","destination":"documentation/_Get-Started/01-installation/index.html","url":"documentation/_Get-Started/01-installation/"},"properties":{},"variables":{},"markdown":{"meta":{"icon":"lucide/package-open","tags":["Get started"]},"content":"<h1 id=\"installation\">Installation<a class=\"headerlink\" href=\"#installation\" title=\"Permanent link\">¶</a></h1>\n<p><strong>SimML</strong> is written in <strong>Python</strong> and is published as a <strong>Python package</strong>. It could be installed with <strong>pip</strong> or with your favorite <strong>package manager</strong>.</p>\n<h2 id=\"install-with-pip\">Install with pip<a class=\"headerlink\" href=\"#install-with-pip\" title=\"Permanent link\">¶</a></h2>\n<div class=\"language-sh highlight\"><pre><span></span><code><span id=\"__span-0-1\"><a id=\"__codelineno-0-1\" name=\"__codelineno-0-1\" href=\"#__codelineno-0-1\"></a>pip<span class=\"w\"> </span>install<span class=\"w\"> </span>simml\n</span></code></pre></div>\n<p>We recommend to use a Python virtual environment when installing with pip.</p>\n<div class=\"tabbed-set tabbed-alternate\" data-tabs=\"1:3\"><input checked=\"checked\" id=\"__tabbed_1_1\" name=\"__tabbed_1\" type=\"radio\" /><input id=\"__tabbed_1_2\" name=\"__tabbed_1\" type=\"radio\" /><input id=\"__tabbed_1_3\" name=\"__tabbed_1\" type=\"radio\" /><div class=\"tabbed-labels\"><label for=\"__tabbed_1_1\"><span class=\"twemoji\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M18.71 19.5c-.83 1.24-1.71 2.45-3.05 2.47-1.34.03-1.77-.79-3.29-.79-1.53 0-2 .77-3.27.82-1.31.05-2.3-1.32-3.14-2.53C4.25 17 2.94 12.45 4.7 9.39c.87-1.52 2.43-2.48 4.12-2.51 1.28-.02 2.5.87 3.29.87.78 0 2.26-1.07 3.81-.91.65.03 2.47.26 3.64 1.98-.09.06-2.17 1.28-2.15 3.81.03 3.02 2.65 4.03 2.68 4.04-.03.07-.42 1.44-1.38 2.83M13 3.5c.73-.83 1.94-1.46 2.94-1.5.13 1.17-.34 2.35-1.04 3.19-.69.85-1.83 1.51-2.95 1.42-.15-1.15.41-2.35 1.05-3.11\"/></svg></span> macOS</label><label for=\"__tabbed_1_2\"><span class=\"twemoji\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 448 512\"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc.--><path fill=\"currentColor\" d=\"m0 93.7 183.6-25.3v177.4H0zm0 324.6 183.6 25.3V268.4H0zm203.8 28L448 480V268.4H203.8zm0-380.6v180.1H448V32z\"/></svg></span> Windows</label><label for=\"__tabbed_1_3\"><span class=\"twemoji\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M14.62 8.35c-.42.28-1.75 1.04-1.95 1.19-.39.31-.75.29-1.14-.01-.2-.16-1.53-.92-1.95-1.19-.48-.31-.45-.7.08-.92 1.64-.69 3.28-.64 4.91.03.49.21.51.6.05.9m7.22 7.28c-.93-2.09-2.2-3.99-3.84-5.66a4.3 4.3 0 0 1-1.06-1.88c-.1-.33-.17-.67-.24-1.01-.2-.88-.29-1.78-.7-2.61-.73-1.58-2-2.4-3.84-2.47-1.81.05-3.16.81-3.95 2.4-.21.43-.36.88-.46 1.34-.17.76-.32 1.55-.5 2.32-.15.65-.45 1.21-.96 1.71-1.61 1.57-2.9 3.37-3.88 5.35-.14.29-.28.58-.37.88-.19.66.29 1.12.99.96.44-.09.88-.18 1.3-.31.41-.15.57-.05.67.35.65 2.15 2.07 3.66 4.24 4.5 4.12 1.56 8.93-.66 9.97-4.58.07-.27.17-.37.47-.27.46.14.93.24 1.4.35.49.09.85-.16.92-.64.03-.26-.06-.49-.16-.73\"/></svg></span> Linux</label></div>\n<div class=\"tabbed-content\">\n<div class=\"tabbed-block\">\n<div class=\"language-sh highlight\"><pre><span></span><code><span id=\"__span-1-1\"><a id=\"__codelineno-1-1\" name=\"__codelineno-1-1\" href=\"#__codelineno-1-1\"></a>python3<span class=\"w\"> </span>-m<span class=\"w\"> </span>venv<span class=\"w\"> </span>.venv\n</span><span id=\"__span-1-2\"><a id=\"__codelineno-1-2\" name=\"__codelineno-1-2\" href=\"#__codelineno-1-2\"></a><span class=\"nb\">source</span><span class=\"w\"> </span>.venv/bin/activate\n</span><span id=\"__span-1-3\"><a id=\"__codelineno-1-3\" name=\"__codelineno-1-3\" href=\"#__codelineno-1-3\"></a>pip<span class=\"w\"> </span>install<span class=\"w\"> </span>simml\n</span></code></pre></div>\n</div>\n<div class=\"tabbed-block\">\n<div class=\"language-ps1 highlight\"><pre><span></span><code><span id=\"__span-2-1\"><a id=\"__codelineno-2-1\" name=\"__codelineno-2-1\" href=\"#__codelineno-2-1\"></a><span class=\"n\">python</span> <span class=\"n\">-m</span> <span class=\"n\">venv</span> <span class=\"p\">.</span><span class=\"n\">venv</span>\n</span><span id=\"__span-2-2\"><a id=\"__codelineno-2-2\" name=\"__codelineno-2-2\" href=\"#__codelineno-2-2\"></a><span class=\"p\">.</span><span class=\"n\">venv</span><span class=\"p\">\\</span><span class=\"n\">Scripts</span><span class=\"p\">\\</span><span class=\"n\">activate</span>\n</span><span id=\"__span-2-3\"><a id=\"__codelineno-2-3\" name=\"__codelineno-2-3\" href=\"#__codelineno-2-3\"></a><span class=\"n\">pip</span> <span class=\"n\">install</span> <span class=\"n\">simml</span>\n</span></code></pre></div>\n</div>\n<div class=\"tabbed-block\">\n<div class=\"language-sh highlight\"><pre><span></span><code><span id=\"__span-3-1\"><a id=\"__codelineno-3-1\" name=\"__codelineno-3-1\" href=\"#__codelineno-3-1\"></a>python3<span class=\"w\"> </span>-m<span class=\"w\"> </span>venv<span class=\"w\"> </span>.venv\n</span><span id=\"__span-3-2\"><a id=\"__codelineno-3-2\" name=\"__codelineno-3-2\" href=\"#__codelineno-3-2\"></a><span class=\"nb\">source</span><span class=\"w\"> </span>.venv/bin/activate\n</span><span id=\"__span-3-3\"><a id=\"__codelineno-3-3\" name=\"__codelineno-3-3\" href=\"#__codelineno-3-3\"></a>pip<span class=\"w\"> </span>install<span class=\"w\"> </span>simml\n</span></code></pre></div>\n</div>\n</div>\n</div>","toc":[{"title":"Installation","content":"Installation","id":"installation","url":"#installation","children":[{"title":"Install with pip","content":"Install with pip","id":"install-with-pip","url":"#install-with-pip","children":[],"level":2}],"level":1}]},"title":"Installation","navigation_title":null,"html":{"autorefs":{"references":[]},"autorefs_registrations":{"primary":{"installation":["documentation/_Get-Started/01-installation/#installation"],"__codelineno-1-1":["documentation/_Get-Started/01-installation/#__codelineno-1-1"],"__codelineno-3-1":["documentation/_Get-Started/01-installation/#__codelineno-3-1"],"__codelineno-2-3":["documentation/_Get-Started/01-installation/#__codelineno-2-3"],"__codelineno-1-2":["documentation/_Get-Started/01-installation/#__codelineno-1-2"],"__codelineno-2-1":["documentation/_Get-Started/01-installation/#__codelineno-2-1"],"install-with-pip":["documentation/_Get-Started/01-installation/#install-with-pip"],"__codelineno-2-2":["documentation/_Get-Started/01-installation/#__codelineno-2-2"],"__codelineno-3-2":["documentation/_Get-Started/01-installation/#__codelineno-3-2"],"__codelineno-3-3":["documentation/_Get-Started/01-installation/#__codelineno-3-3"],"__codelineno-0-1":["documentation/_Get-Started/01-installation/#__codelineno-0-1"],"__codelineno-1-3":["documentation/_Get-Started/01-installation/#__codelineno-1-3"]},"secondary":{},"titles":{"documentation/_Get-Started/01-installation/#installation":"Installation","documentation/_Get-Started/01-installation/#install-with-pip":"Install with pip"}},"search":{"sections":[{"location":null,"level":1,"title":"Installation","text":"<p>SimML is written in Python and is published as a Python package. It could be installed with pip or with your favorite package manager.</p>"},{"location":"install-with-pip","level":2,"title":"Install with pip","text":"<pre><code>pip install simml\n</code></pre> <p>We recommend to use a Python virtual environment when installing with pip.</p> macOS Windows Linux <pre><code>python3 -m venv .venv\nsource .venv/bin/activate\npip install simml\n</code></pre> <pre><code>python -m venv .venv\n.venv\\Scripts\\activate\npip install simml\n</code></pre> <pre><code>python3 -m venv .venv\nsource .venv/bin/activate\npip install simml\n</code></pre>"}]},"tags":{"mappings":[],"listings":[],"search_cleanup":false},"llmstxt":null}},"hash":13167339865172915440}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"data":{"origin":{"Source":"documentation/_Get-Started/03-license.md"},"route":{"source":"documentation/_Get-Started/03-license.md","destination":"documentation/_Get-Started/03-license/index.html","url":"documentation/_Get-Started/03-license/"},"properties":{},"variables":{},"markdown":{"meta":{"icon":"lucide/scale","tags":["Get started"]},"content":"<h1 id=\"license\">License<a class=\"headerlink\" href=\"#license\" title=\"Permanent link\">¶</a></h1>\n<h2 id=\"1-purpose-of-the-license\">1. Purpose of the License<a class=\"headerlink\" href=\"#1-purpose-of-the-license\" title=\"Permanent link\">¶</a></h2>\n<ul>\n<li>This license defines the terms and conditions for the use of the software library called <code>simml</code> (hereinafter referred to as <code>the Library</code>).</li>\n</ul>\n<h2 id=\"2-usage-rights\">2. Usage Rights<a class=\"headerlink\" href=\"#2-usage-rights\" title=\"Permanent link\">¶</a></h2>\n<h3 id=\"21-open-source-usage\">2.1 Open Source Usage<a class=\"headerlink\" href=\"#21-open-source-usage\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>Use is permitted free of charge exclusively within open source projects, provided that the Library is not used for commercial purposes, either directly or indirectly (e.g., SaaS, paid services, integration into a commercial product).</li>\n</ul>\n<h3 id=\"22-other-usage\">2.2 Other Usage<a class=\"headerlink\" href=\"#22-other-usage\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>The purchase or receipt of a license grants the user a limited, non-exclusive, and non-transferable license to use the Library in accordance with the terms of this license.</li>\n<li>The user is authorized to use the Library only for projects within the scope defined by the agreement.</li>\n</ul>\n<h2 id=\"3-restrictions\">3. Restrictions<a class=\"headerlink\" href=\"#3-restrictions\" title=\"Permanent link\">¶</a></h2>\n<p>The user agrees to comply with the following restrictions:</p>\n<ul>\n<li><strong>No Redistribution</strong>: It is strictly prohibited to distribute, sell, rent, or lend the Library to third parties in any form whatsoever.</li>\n<li><strong>Source Code</strong>: The Library is provided in binary or compiled form, unless otherwise specified. Any attempt to decompile, reverse engineer, or modify it is strictly prohibited.</li>\n<li><strong>Intellectual Property</strong>: All intellectual property rights related to the Library are and shall remain the exclusive property of PinkSalmon.</li>\n</ul>\n<h2 id=\"4-warranty-limitations\">4. Warranty Limitations<a class=\"headerlink\" href=\"#4-warranty-limitations\" title=\"Permanent link\">¶</a></h2>\n<ul>\n<li>The Library is provided \"as is\" without any express or implied warranty.</li>\n<li>PinkSalmon shall not be held liable for any direct or indirect damages, including but not limited to data loss, loss of profits, or service interruption.</li>\n</ul>\n<h2 id=\"5-term-and-termination\">5. Term and Termination<a class=\"headerlink\" href=\"#5-term-and-termination\" title=\"Permanent link\">¶</a></h2>\n<ul>\n<li>This license remains valid until terminated.</li>\n<li>It may be terminated automatically in the event of a breach of the terms of this license.</li>\n<li>Upon termination, the user must destroy all copies of the Library in their possession.</li>\n</ul>\n<h2 id=\"6-governing-law-and-jurisdiction\">6. Governing Law and Jurisdiction<a class=\"headerlink\" href=\"#6-governing-law-and-jurisdiction\" title=\"Permanent link\">¶</a></h2>\n<ul>\n<li>This License shall be governed by and construed in accordance with the laws of France.</li>\n<li>Notwithstanding the foregoing, if the Licensee is located outside France, mandatory provisions of the local laws of the Licensee’s country of residence may apply to the extent they cannot be waived by contract.</li>\n<li>Any dispute arising out of or in connection with this License shall be submitted to the exclusive jurisdiction of the competent courts of France, unless otherwise required by applicable mandatory law.</li>\n</ul>\n<hr />\n<p><strong>Contact</strong>: For any questions regarding this license, please contact <a href=\"mailto:contact@pinksalmon.cloud\">contact@pinksalmon.cloud</a>.</p>","toc":[{"title":"License","content":"License","id":"license","url":"#license","children":[{"title":"1. Purpose of the License","content":"1. Purpose of the License","id":"1-purpose-of-the-license","url":"#1-purpose-of-the-license","children":[],"level":2},{"title":"2. Usage Rights","content":"2. Usage Rights","id":"2-usage-rights","url":"#2-usage-rights","children":[{"title":"2.1 Open Source Usage","content":"2.1 Open Source Usage","id":"21-open-source-usage","url":"#21-open-source-usage","children":[],"level":3},{"title":"2.2 Other Usage","content":"2.2 Other Usage","id":"22-other-usage","url":"#22-other-usage","children":[],"level":3}],"level":2},{"title":"3. Restrictions","content":"3. Restrictions","id":"3-restrictions","url":"#3-restrictions","children":[],"level":2},{"title":"4. Warranty Limitations","content":"4. Warranty Limitations","id":"4-warranty-limitations","url":"#4-warranty-limitations","children":[],"level":2},{"title":"5. Term and Termination","content":"5. Term and Termination","id":"5-term-and-termination","url":"#5-term-and-termination","children":[],"level":2},{"title":"6. Governing Law and Jurisdiction","content":"6. Governing Law and Jurisdiction","id":"6-governing-law-and-jurisdiction","url":"#6-governing-law-and-jurisdiction","children":[],"level":2}],"level":1}]},"title":"License","navigation_title":null,"html":{"autorefs":{"references":[]},"autorefs_registrations":{"primary":{"4-warranty-limitations":["documentation/_Get-Started/03-license/#4-warranty-limitations"],"license":["documentation/_Get-Started/03-license/#license"],"5-term-and-termination":["documentation/_Get-Started/03-license/#5-term-and-termination"],"1-purpose-of-the-license":["documentation/_Get-Started/03-license/#1-purpose-of-the-license"],"3-restrictions":["documentation/_Get-Started/03-license/#3-restrictions"],"2-usage-rights":["documentation/_Get-Started/03-license/#2-usage-rights"],"21-open-source-usage":["documentation/_Get-Started/03-license/#21-open-source-usage"],"6-governing-law-and-jurisdiction":["documentation/_Get-Started/03-license/#6-governing-law-and-jurisdiction"],"22-other-usage":["documentation/_Get-Started/03-license/#22-other-usage"]},"secondary":{},"titles":{"documentation/_Get-Started/03-license/#21-open-source-usage":"2.1 Open Source Usage","documentation/_Get-Started/03-license/#3-restrictions":"3. Restrictions","documentation/_Get-Started/03-license/#1-purpose-of-the-license":"1. Purpose of the License","documentation/_Get-Started/03-license/#5-term-and-termination":"5. Term and Termination","documentation/_Get-Started/03-license/#2-usage-rights":"2. Usage Rights","documentation/_Get-Started/03-license/#6-governing-law-and-jurisdiction":"6. Governing Law and Jurisdiction","documentation/_Get-Started/03-license/#22-other-usage":"2.2 Other Usage","documentation/_Get-Started/03-license/#4-warranty-limitations":"4. Warranty Limitations","documentation/_Get-Started/03-license/#license":"License"}},"search":{"sections":[{"location":null,"level":1,"title":"License","text":""},{"location":"1-purpose-of-the-license","level":2,"title":"1. Purpose of the License","text":"<ul> <li>This license defines the terms and conditions for the use of the software library called <code>simml</code> (hereinafter referred to as <code>the Library</code>).</li> </ul>"},{"location":"2-usage-rights","level":2,"title":"2. Usage Rights","text":""},{"location":"21-open-source-usage","level":3,"title":"2.1 Open Source Usage","text":"<ul> <li>Use is permitted free of charge exclusively within open source projects, provided that the Library is not used for commercial purposes, either directly or indirectly (e.g., SaaS, paid services, integration into a commercial product).</li> </ul>"},{"location":"22-other-usage","level":3,"title":"2.2 Other Usage","text":"<ul> <li>The purchase or receipt of a license grants the user a limited, non-exclusive, and non-transferable license to use the Library in accordance with the terms of this license.</li> <li>The user is authorized to use the Library only for projects within the scope defined by the agreement.</li> </ul>"},{"location":"3-restrictions","level":2,"title":"3. Restrictions","text":"<p>The user agrees to comply with the following restrictions:</p> <ul> <li>No Redistribution: It is strictly prohibited to distribute, sell, rent, or lend the Library to third parties in any form whatsoever.</li> <li>Source Code: The Library is provided in binary or compiled form, unless otherwise specified. Any attempt to decompile, reverse engineer, or modify it is strictly prohibited.</li> <li>Intellectual Property: All intellectual property rights related to the Library are and shall remain the exclusive property of PinkSalmon.</li> </ul>"},{"location":"4-warranty-limitations","level":2,"title":"4. Warranty Limitations","text":"<ul> <li>The Library is provided \"as is\" without any express or implied warranty.</li> <li>PinkSalmon shall not be held liable for any direct or indirect damages, including but not limited to data loss, loss of profits, or service interruption.</li> </ul>"},{"location":"5-term-and-termination","level":2,"title":"5. Term and Termination","text":"<ul> <li>This license remains valid until terminated.</li> <li>It may be terminated automatically in the event of a breach of the terms of this license.</li> <li>Upon termination, the user must destroy all copies of the Library in their possession.</li> </ul>"},{"location":"6-governing-law-and-jurisdiction","level":2,"title":"6. Governing Law and Jurisdiction","text":"<ul> <li>This License shall be governed by and construed in accordance with the laws of France.</li> <li>Notwithstanding the foregoing, if the Licensee is located outside France, mandatory provisions of the local laws of the Licensee’s country of residence may apply to the extent they cannot be waived by contract.</li> <li>Any dispute arising out of or in connection with this License shall be submitted to the exclusive jurisdiction of the competent courts of France, unless otherwise required by applicable mandatory law.</li> </ul> <p>Contact: For any questions regarding this license, please contact contact@pinksalmon.cloud.</p>"}]},"tags":{"mappings":[],"listings":[],"search_cleanup":false},"llmstxt":null}},"hash":8366788487338765370}
|
|
1
|
+
{"data":{"origin":{"Source":"documentation/_Get-Started/03-license.md"},"route":{"source":"documentation/_Get-Started/03-license.md","destination":"documentation/_Get-Started/03-license/index.html","url":"documentation/_Get-Started/03-license/"},"properties":{},"variables":{},"markdown":{"meta":{"icon":"lucide/scale","tags":["Get started"]},"content":"<h1 id=\"license\">License<a class=\"headerlink\" href=\"#license\" title=\"Permanent link\">¶</a></h1>\n<h2 id=\"1-purpose-of-the-license\">1. Purpose of the License<a class=\"headerlink\" href=\"#1-purpose-of-the-license\" title=\"Permanent link\">¶</a></h2>\n<ul>\n<li>This license defines the terms and conditions for the use of the software library called <code>simml</code> (hereinafter referred to as <code>the Library</code>).</li>\n</ul>\n<h2 id=\"2-usage-rights\">2. Usage Rights<a class=\"headerlink\" href=\"#2-usage-rights\" title=\"Permanent link\">¶</a></h2>\n<h3 id=\"21-open-source-usage\">2.1 Open Source Usage<a class=\"headerlink\" href=\"#21-open-source-usage\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>Use is permitted free of charge exclusively within open source projects, provided that the Library is not used for commercial purposes, either directly or indirectly (e.g., SaaS, paid services, integration into a commercial product).</li>\n</ul>\n<h3 id=\"22-other-usage\">2.2 Other Usage<a class=\"headerlink\" href=\"#22-other-usage\" title=\"Permanent link\">¶</a></h3>\n<ul>\n<li>The purchase or receipt of a license grants the user a limited, non-exclusive, and non-transferable license to use the Library in accordance with the terms of this license.</li>\n<li>The user is authorized to use the Library only for projects within the scope defined by the agreement.</li>\n</ul>\n<h2 id=\"3-restrictions\">3. Restrictions<a class=\"headerlink\" href=\"#3-restrictions\" title=\"Permanent link\">¶</a></h2>\n<p>The user agrees to comply with the following restrictions:</p>\n<ul>\n<li><strong>No Redistribution</strong>: It is strictly prohibited to distribute, sell, rent, or lend the Library to third parties in any form whatsoever.</li>\n<li><strong>Source Code</strong>: The Library is provided in binary or compiled form, unless otherwise specified. Any attempt to decompile, reverse engineer, or modify it is strictly prohibited.</li>\n<li><strong>Intellectual Property</strong>: All intellectual property rights related to the Library are and shall remain the exclusive property of PinkSalmon.</li>\n</ul>\n<h2 id=\"4-warranty-limitations\">4. Warranty Limitations<a class=\"headerlink\" href=\"#4-warranty-limitations\" title=\"Permanent link\">¶</a></h2>\n<ul>\n<li>The Library is provided \"as is\" without any express or implied warranty.</li>\n<li>PinkSalmon shall not be held liable for any direct or indirect damages, including but not limited to data loss, loss of profits, or service interruption.</li>\n</ul>\n<h2 id=\"5-term-and-termination\">5. Term and Termination<a class=\"headerlink\" href=\"#5-term-and-termination\" title=\"Permanent link\">¶</a></h2>\n<ul>\n<li>This license remains valid until terminated.</li>\n<li>It may be terminated automatically in the event of a breach of the terms of this license.</li>\n<li>Upon termination, the user must destroy all copies of the Library in their possession.</li>\n</ul>\n<h2 id=\"6-governing-law-and-jurisdiction\">6. Governing Law and Jurisdiction<a class=\"headerlink\" href=\"#6-governing-law-and-jurisdiction\" title=\"Permanent link\">¶</a></h2>\n<ul>\n<li>This License shall be governed by and construed in accordance with the laws of France.</li>\n<li>Notwithstanding the foregoing, if the Licensee is located outside France, mandatory provisions of the local laws of the Licensee’s country of residence may apply to the extent they cannot be waived by contract.</li>\n<li>Any dispute arising out of or in connection with this License shall be submitted to the exclusive jurisdiction of the competent courts of France, unless otherwise required by applicable mandatory law.</li>\n</ul>\n<hr />\n<p><strong>Contact</strong>: For any questions regarding this license, please contact <a href=\"mailto:contact@pinksalmon.cloud\">contact@pinksalmon.cloud</a>.</p>","toc":[{"title":"License","content":"License","id":"license","url":"#license","children":[{"title":"1. Purpose of the License","content":"1. Purpose of the License","id":"1-purpose-of-the-license","url":"#1-purpose-of-the-license","children":[],"level":2},{"title":"2. Usage Rights","content":"2. Usage Rights","id":"2-usage-rights","url":"#2-usage-rights","children":[{"title":"2.1 Open Source Usage","content":"2.1 Open Source Usage","id":"21-open-source-usage","url":"#21-open-source-usage","children":[],"level":3},{"title":"2.2 Other Usage","content":"2.2 Other Usage","id":"22-other-usage","url":"#22-other-usage","children":[],"level":3}],"level":2},{"title":"3. Restrictions","content":"3. Restrictions","id":"3-restrictions","url":"#3-restrictions","children":[],"level":2},{"title":"4. Warranty Limitations","content":"4. Warranty Limitations","id":"4-warranty-limitations","url":"#4-warranty-limitations","children":[],"level":2},{"title":"5. Term and Termination","content":"5. Term and Termination","id":"5-term-and-termination","url":"#5-term-and-termination","children":[],"level":2},{"title":"6. Governing Law and Jurisdiction","content":"6. Governing Law and Jurisdiction","id":"6-governing-law-and-jurisdiction","url":"#6-governing-law-and-jurisdiction","children":[],"level":2}],"level":1}]},"title":"License","navigation_title":null,"html":{"autorefs":{"references":[]},"autorefs_registrations":{"primary":{"1-purpose-of-the-license":["documentation/_Get-Started/03-license/#1-purpose-of-the-license"],"3-restrictions":["documentation/_Get-Started/03-license/#3-restrictions"],"4-warranty-limitations":["documentation/_Get-Started/03-license/#4-warranty-limitations"],"5-term-and-termination":["documentation/_Get-Started/03-license/#5-term-and-termination"],"2-usage-rights":["documentation/_Get-Started/03-license/#2-usage-rights"],"21-open-source-usage":["documentation/_Get-Started/03-license/#21-open-source-usage"],"license":["documentation/_Get-Started/03-license/#license"],"22-other-usage":["documentation/_Get-Started/03-license/#22-other-usage"],"6-governing-law-and-jurisdiction":["documentation/_Get-Started/03-license/#6-governing-law-and-jurisdiction"]},"secondary":{},"titles":{"documentation/_Get-Started/03-license/#22-other-usage":"2.2 Other Usage","documentation/_Get-Started/03-license/#6-governing-law-and-jurisdiction":"6. Governing Law and Jurisdiction","documentation/_Get-Started/03-license/#5-term-and-termination":"5. Term and Termination","documentation/_Get-Started/03-license/#2-usage-rights":"2. Usage Rights","documentation/_Get-Started/03-license/#1-purpose-of-the-license":"1. Purpose of the License","documentation/_Get-Started/03-license/#21-open-source-usage":"2.1 Open Source Usage","documentation/_Get-Started/03-license/#license":"License","documentation/_Get-Started/03-license/#3-restrictions":"3. Restrictions","documentation/_Get-Started/03-license/#4-warranty-limitations":"4. Warranty Limitations"}},"search":{"sections":[{"location":null,"level":1,"title":"License","text":""},{"location":"1-purpose-of-the-license","level":2,"title":"1. Purpose of the License","text":"<ul> <li>This license defines the terms and conditions for the use of the software library called <code>simml</code> (hereinafter referred to as <code>the Library</code>).</li> </ul>"},{"location":"2-usage-rights","level":2,"title":"2. Usage Rights","text":""},{"location":"21-open-source-usage","level":3,"title":"2.1 Open Source Usage","text":"<ul> <li>Use is permitted free of charge exclusively within open source projects, provided that the Library is not used for commercial purposes, either directly or indirectly (e.g., SaaS, paid services, integration into a commercial product).</li> </ul>"},{"location":"22-other-usage","level":3,"title":"2.2 Other Usage","text":"<ul> <li>The purchase or receipt of a license grants the user a limited, non-exclusive, and non-transferable license to use the Library in accordance with the terms of this license.</li> <li>The user is authorized to use the Library only for projects within the scope defined by the agreement.</li> </ul>"},{"location":"3-restrictions","level":2,"title":"3. Restrictions","text":"<p>The user agrees to comply with the following restrictions:</p> <ul> <li>No Redistribution: It is strictly prohibited to distribute, sell, rent, or lend the Library to third parties in any form whatsoever.</li> <li>Source Code: The Library is provided in binary or compiled form, unless otherwise specified. Any attempt to decompile, reverse engineer, or modify it is strictly prohibited.</li> <li>Intellectual Property: All intellectual property rights related to the Library are and shall remain the exclusive property of PinkSalmon.</li> </ul>"},{"location":"4-warranty-limitations","level":2,"title":"4. Warranty Limitations","text":"<ul> <li>The Library is provided \"as is\" without any express or implied warranty.</li> <li>PinkSalmon shall not be held liable for any direct or indirect damages, including but not limited to data loss, loss of profits, or service interruption.</li> </ul>"},{"location":"5-term-and-termination","level":2,"title":"5. Term and Termination","text":"<ul> <li>This license remains valid until terminated.</li> <li>It may be terminated automatically in the event of a breach of the terms of this license.</li> <li>Upon termination, the user must destroy all copies of the Library in their possession.</li> </ul>"},{"location":"6-governing-law-and-jurisdiction","level":2,"title":"6. Governing Law and Jurisdiction","text":"<ul> <li>This License shall be governed by and construed in accordance with the laws of France.</li> <li>Notwithstanding the foregoing, if the Licensee is located outside France, mandatory provisions of the local laws of the Licensee’s country of residence may apply to the extent they cannot be waived by contract.</li> <li>Any dispute arising out of or in connection with this License shall be submitted to the exclusive jurisdiction of the competent courts of France, unless otherwise required by applicable mandatory law.</li> </ul> <p>Contact: For any questions regarding this license, please contact contact@pinksalmon.cloud.</p>"}]},"tags":{"mappings":[],"listings":[],"search_cleanup":false},"llmstxt":null}},"hash":9017615099565681859}
|