Modelon Impact Client
=================================================

*Client library for easy scripting against Modelon Impact*

Python companion library for Modelon Impact that wraps its REST API framework and helps with:

1. Authenticating users against Modelon Impact
2. Compiling models on the server and downloading them as FMUs
3. Creating and automating custom work-flows
4. Defining and executing simulations on the Impact server
5. Fetching results and post-processing them using custom python scripts


.. image:: images/client-server.svg
   :alt: Modelon Impact usage
   :width: 100%
   :align: center

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Getting Started

   install.rst
   authentication_with_modelon_impact.rst
   quick_start.rst

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Tutorials

   working_with_workspaces.rst
   choosing_analysis_type.rst
   choosing_a_model.rst
   setup_run_experiment.rst
   plotting_experiment_results.rst
   multi_execution_experiments.rst
   reexecuting_updating_experiments.rst
   fmu_based_workflow.rst
   logging_output_for_client.rst
   removing_fmus_experiments.rst

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Examples

   sobol_space_coverage.rst

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: API

   modules.rst

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Help & Refernce

   help.rst
   license.rst

Contents
========

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`