deploy: b800a76

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 590f3ec8c37018126a465cf8fb40f1d3
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/CHANGELOG.md.txt

@@ -0,0 +1,2 @@
+```{include} ../../CHANGELOG.md
+```

_sources/LICENSE.md.txt

@@ -0,0 +1,3 @@
+# LICENSE
+```{include} ../../LICENSE
+```

_sources/README.rst.txt

@@ -0,0 +1 @@
+.. include:: ../../README.rst

_sources/_autosummary/sim_explorer.case.Case.rst.txt

@@ -0,0 +1,33 @@
+Case
+====
+
+.. currentmodule:: sim_explorer.case
+
+.. autoclass:: Case
+   :members:
+   :show-inheritance:
+
+
+
+   .. automethod:: __init__
+
+   .. rubric:: Methods
+   .. autosummary::
+
+      ~Case.__init__
+      ~Case.add_results_object
+      ~Case.append
+      ~Case.case_by_name
+      ~Case.iter
+      ~Case.list_cases
+      ~Case.read_assertion
+      ~Case.read_spec_item
+      ~Case.run
+      ~Case.str_act
+
+
+
+
+
+
+

_sources/_autosummary/sim_explorer.case.Cases.rst.txt

@@ -0,0 +1,45 @@
+Cases
+=====
+
+.. currentmodule:: sim_explorer.case
+
+.. autoclass:: Cases
+   :members:
+   :show-inheritance:
+
+
+
+   .. automethod:: __init__
+
+   .. rubric:: Methods
+   .. autosummary::
+
+      ~Cases.__init__
+      ~Cases.case_by_name
+      ~Cases.case_var_by_ref
+      ~Cases.comp_refs_to_case_var
+      ~Cases.disect_variable
+      ~Cases.get_case_variables
+      ~Cases.info
+      ~Cases.read_cases
+      ~Cases.run_case
+
+
+
+
+
+
+   .. rubric:: Attributes
+   .. autosummary::
+
+      ~Cases.file
+      ~Cases.js
+      ~Cases.spec
+      ~Cases.simulator
+      ~Cases.timefac
+      ~Cases.variables
+      ~Cases.base
+      ~Cases.results
+      ~Cases.results_print_type
+
+

_sources/_autosummary/sim_explorer.case.Results.rst.txt

@@ -0,0 +1,29 @@
+Results
+=======
+
+.. currentmodule:: sim_explorer.case
+
+.. autoclass:: Results
+   :members:
+   :show-inheritance:
+
+
+
+   .. automethod:: __init__
+
+   .. rubric:: Methods
+   .. autosummary::
+
+      ~Results.__init__
+      ~Results.add
+      ~Results.inspect
+      ~Results.plot_time_series
+      ~Results.save
+      ~Results.time_series
+
+
+
+
+
+
+

_sources/_autosummary/sim_explorer.case.rst.txt

@@ -0,0 +1,19 @@
+sim\_explorer.case
+==================
+
+.. automodule:: sim_explorer.case
+   :members:
+   :exclude-members: Case,Cases,Results,
+
+
+
+
+   .. rubric:: Classes
+   .. autosummary::
+      :toctree:
+      :template: custom-class.rst
+
+      Case
+      Cases
+      Results
+

_sources/_autosummary/sim_explorer.json5.Json5.rst.txt

@@ -0,0 +1,41 @@
+Json5
+=====
+
+.. currentmodule:: sim_explorer.json5
+
+.. autoclass:: Json5
+   :members:
+   :show-inheritance:
+
+
+
+   .. automethod:: __init__
+
+   .. rubric:: Methods
+   .. autosummary::
+
+      ~Json5.__init__
+      ~Json5.check_valid_js
+      ~Json5.jspath
+      ~Json5.line
+      ~Json5.to_py
+      ~Json5.update
+      ~Json5.write
+
+
+
+
+
+
+   .. rubric:: Attributes
+   .. autosummary::
+
+      ~Json5.comments
+      ~Json5.comments_eol
+      ~Json5.comments_ml
+      ~Json5.js5
+      ~Json5.js_py
+      ~Json5.lines
+      ~Json5.pos
+
+

_sources/_autosummary/sim_explorer.json5.rst.txt

@@ -0,0 +1,22 @@
+sim\_explorer.json5
+===================
+
+.. automodule:: sim_explorer.json5
+   :members:
+   :exclude-members: Json5,
+
+
+
+
+   .. rubric:: Classes
+   .. autosummary::
+      :toctree:
+      :template: custom-class.rst
+
+      Json5
+
+   .. rubric:: Exceptions
+   .. autosummary::
+
+      Json5Error
+

_sources/_autosummary/sim_explorer.simulator_interface.SimulatorInterface.rst.txt

@@ -0,0 +1,46 @@
+SimulatorInterface
+==================
+
+.. currentmodule:: sim_explorer.simulator_interface
+
+.. autoclass:: SimulatorInterface
+   :members:
+   :show-inheritance:
+
+
+
+   .. automethod:: __init__
+
+   .. rubric:: Methods
+   .. autosummary::
+
+      ~SimulatorInterface.__init__
+      ~SimulatorInterface.allowed_action
+      ~SimulatorInterface.component_id_from_name
+      ~SimulatorInterface.component_name_from_id
+      ~SimulatorInterface.default_initial
+      ~SimulatorInterface.get_components
+      ~SimulatorInterface.get_models
+      ~SimulatorInterface.get_variable_value
+      ~SimulatorInterface.get_variables
+      ~SimulatorInterface.is_output_var
+      ~SimulatorInterface.match_components
+      ~SimulatorInterface.match_variables
+      ~SimulatorInterface.pytype
+      ~SimulatorInterface.reset
+      ~SimulatorInterface.same_model
+      ~SimulatorInterface.set_initial
+      ~SimulatorInterface.set_variable_value
+      ~SimulatorInterface.variable_name_from_ref
+
+
+
+
+
+
+   .. rubric:: Attributes
+   .. autosummary::
+
+      ~SimulatorInterface.path
+
+

_sources/_autosummary/sim_explorer.simulator_interface.rst.txt

@@ -0,0 +1,28 @@
+sim\_explorer.simulator\_interface
+==================================
+
+.. automodule:: sim_explorer.simulator_interface
+   :members:
+   :exclude-members: SimulatorInterface,
+
+
+
+
+   .. rubric:: Module Attributes
+   .. autosummary::
+
+      Json5Val
+
+   .. rubric:: Classes
+   .. autosummary::
+      :toctree:
+      :template: custom-class.rst
+
+      SimulatorInterface
+
+   .. rubric:: Exceptions
+   .. autosummary::
+
+      CaseInitError
+      CaseUseError
+

_sources/api.rst.txt

@@ -0,0 +1,38 @@
+API Reference
+=============
+
+
+json5
+-----
+Python module for working with json5 files.
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module.rst
+   :recursive:
+
+   sim_explorer.json5
+
+
+Simulator Interface
+-------------------
+Python module providing the interface to the simulator. Currently only Open Simulation Platform (OSP) is supported
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module.rst
+   :recursive:
+
+   sim_explorer.simulator_interface
+
+
+Case
+----
+Python module to manage cases with respect to reading \*.cases files, running cases and storing results
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module.rst
+   :recursive:
+
+   sim_explorer.case

_sources/cli.rst.txt

@@ -0,0 +1,7 @@
+CLI Documentation
+=================
+
+.. toctree::
+   :maxdepth: 3
+
+   cli.sim_explorer

_sources/cli.sim_explorer.rst.txt

@@ -0,0 +1,3 @@
+.. sphinx_argparse_cli::
+   :module: sim_explorer.cli.sim_explorer
+   :func: _argparser