Welcome to VeraGrid's documentation!
===================================

.. figure:: img/VeraGrid_banner.png
    :alt: VeraGrid banner

VeraGrid is a top tier power systems planning and simulation software. As
such it has all the static analysis studies that you can think of, plus
linear and non-linear optimization functions. Some of these functions
are well known, while others you may have never heard of as they are a
product of cutting-edge research.

.. figure:: md_source/figures/VeraGrid_yt.png
    :alt: VeraGrid main figure

|OpenSSF Best Practices| |Dependency Graph| |Scorecard Supply-Chain Security| |CodeQL|

|Documentation Status| |Build Status| |DOI| |Downloads| |Chat|

VeraGrid started in 2015 with a clear objective: create a solid
programming library and a user-friendly interface. This straightforward
approach sparked many innovations — some driven by the necessity for
commercial use, and others fueled by curiosity and research.

Whether you’re a pro needing free tools, a researcher wanting a
real-world tested platform, a teacher sharing commercial-grade software
insights, or a student diving into practical algorithms, VeraGrid’s got
your back. It’s a high quality product made for all of us now and for
the future generations.

🎥 Watch the spotlight series videos:

- `1 - introduction  <https://www.youtube.com/watch?v=4ZDyWIX8_VE>`_

- `2 - Power flow <https://www.youtube.com/watch?v=d9dTyO4wels>`_

- `3 - Optimal power flow <https://www.youtube.com/watch?v=o6oXBJ1Efqc>`_

- `4 - Contingency Analysis <https://youtu.be/3VI_mxPlixs?si=rd1eWqLJkXbEDF3N>`_

- `5 - Time series modelling <https://www.youtube.com/watch?v=wVdAtnvQ7s8>`_


Contact
=======

-  Join the `VeraGrid chat
   channel <https://matrix.to/#/#veragrid:matrix.org>`__ for a friendly
   chat, or quick question.
-  Submit bugs or requests in the
   `Issues <https://github.com/SanPen/VeraGrid/issues>`__ section.


Contents
=========

.. toctree::
    :maxdepth: 2

    md_source/installation.md
    md_source/user_interface.md
    md_source/structure.md
    md_source/modelling.md
    md_source/device_relationships.md
    md_source/small_signal_stability.md
    md_source/model_debugging.md
    md_source/file_operations.md


    md_source/topology.md
    md_source/clustering.md
    md_source/grid_reduction.md
    md_source/procedural_grid.md

    md_source/power_flow.md
    md_source/linear_analysis.md
    md_source/optimal_power_flow.md
    md_source/short_circuit.md
    md_source/stochastic_power_flow.md
    md_source/continuation_power_flow.md
    md_source/solar_wizard.md

    md_source/contingency_analysis.md
    md_source/investment_optimization.md
    md_source/cascading.md

    md_source/net_transfer_capacity.md
    md_source/nodal_hosting_capacity.md
    md_source/reliability.md
    md_source/state_estimation.md

    md_source/development.md
    md_source/plugins.md
    md_source/license.md
    rst_source/change_log
    md_source/data_models.md
    rst_source/api/auto/modules



Disclaimer
----------

All trademarks mentioned in the documentation or the source code belong
to their respective owners.


.. |OpenSSF Best Practices| image:: https://www.bestpractices.dev/projects/13016/badge
   :target: https://www.bestpractices.dev/projects/13016
.. |Dependency Graph| image:: https://github.com/SanPen/VeraGrid/actions/workflows/dependabot/update-graph/badge.svg
   :target: https://github.com/SanPen/VeraGrid/actions/workflows/dependabot/update-graph
.. |Scorecard Supply-Chain Security| image:: https://github.com/SanPen/VeraGrid/actions/workflows/scorecard.yml/badge.svg
   :target: https://github.com/SanPen/VeraGrid/actions/workflows/scorecard.yml
.. |CodeQL| image:: https://github.com/SanPen/VeraGrid/actions/workflows/github-code-scanning/codeql/badge.svg
   :target: https://github.com/SanPen/VeraGrid/actions/workflows/github-code-scanning/codeql
.. |Documentation Status| image:: https://readthedocs.org/projects/veragrid/badge/?version=latest
   :target: https://veragrid.readthedocs.io/en/latest/?badge=latest
.. |Build Status| image:: https://travis-ci.org/SanPen/VeraGrid.svg?branch=master
   :target: https://travis-ci.org/SanPen/VeraGrid
.. |DOI| image:: https://www.zenodo.org/badge/49583206.svg
   :target: https://www.zenodo.org/badge/latestdoi/49583206
.. |Downloads| image:: https://static.pepy.tech/personalized-badge/veragrid?period=total&units=abbreviation&left_color=grey&right_color=green&left_text=Downloads
   :target: https://pepy.tech/project/veragrid
.. |Chat| image:: https://img.shields.io/badge/join-chat-green
   :target: https://matrix.to/#/#veragrid:matrix.org