.. _gridsim-use:

#########################
The Simulator General Use
#########################

The following section describes the first steps to use the Gridsim simulator
and its built-in modules.

Currently, the simulator provides:

* :ref:`gridsim-simu`
* :ref:`gridsim-electrical-simu`
* :ref:`gridsim-cyberphysical-simu`
* :ref:`gridsim-thermal-simu`
* :ref:`gridsim-control`
* :ref:`gridsim-record`

**********
Simulation
**********

.. _gridsim-simu:

Global simulation
=================
.. automodule:: gridsim.simulation
    :members:
    :undoc-members:
    :show-inheritance:

.. _gridsim-electrical-simu:

Electrical simulation
=====================
.. automodule:: gridsim.electrical

Electrical package
------------------
.. automodule:: gridsim.electrical.simulation
    :members:
    :undoc-members:
    :show-inheritance:

Electrical load flow
--------------------

.. automodule:: gridsim.electrical.loadflow
    :members:
    :undoc-members:
    :show-inheritance:

Electrical network
------------------
.. automodule:: gridsim.electrical.network
    :members:
    :undoc-members:
    :show-inheritance:

Electrical elements
-------------------
.. automodule:: gridsim.electrical.element
    :members:
    :undoc-members:
    :show-inheritance:

.. _gridsim-cyberphysical-simu:

Cyber-physical simulation
=========================
.. automodule:: gridsim.cyberphysical

Cyber-physical package
----------------------
.. automodule:: gridsim.cyberphysical.simulation
    :members:
    :undoc-members:
    :show-inheritance:

Cyber-physical elements
-----------------------
.. automodule:: gridsim.cyberphysical.element
    :members:
    :undoc-members:
    :show-inheritance:

Cyber-physical aggregator
-------------------------
.. automodule:: gridsim.cyberphysical.aggregator
    :members:
    :undoc-members:
    :show-inheritance:

.. _gridsim-thermal-simu:

Thermal simulation
==================
.. automodule:: gridsim.thermal

Thermal package
---------------
.. automodule:: gridsim.thermal.simulation
    :members:
    :undoc-members:
    :show-inheritance:

Thermal elements
----------------
.. automodule:: gridsim.thermal.element
    :members:
    :undoc-members:
    :show-inheritance:

**************
User Interface
**************

.. _gridsim-control:

Control of simulation elements
==============================
.. automodule:: gridsim.controller
    :members:
    :undoc-members:
    :show-inheritance:

.. _gridsim-record:

Record of simulation elements
=============================
.. automodule:: gridsim.recorder
    :members:
    :undoc-members:
    :show-inheritance: