You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

107 lines
2.6 KiB

.. AMS documentation master file, created by
sphinx-quickstart on Thu Jan 26 15:32:32 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==================
AMS documentation
==================
**Useful Links**: `Source Repository`_ | `Report Issues`_ | `Q&A`_
.. _`Source Repository`: https://github.com/jinningwang/ams
.. _`Report Issues`: https://github.com/jinningwang/ams/issues
.. _`Q&A`: https://github.com/jinningwang/ams/discussions
.. _`LTB Repository`: https://github.com/CURENT/ltb2
AMS is still under DEVELOPMENT, stay tuned!
AMS is an open-source packages for dispatch modeling and co-simulation with dynanic.
AMS is the dispatch simulation engine for the CURENT Largescale Testbed (LTB).
More information about CURENT LTB can be found at the `LTB Repository`_.
.. panels::
:card: + intro-card text-center
:column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex
---
Getting started
^^^^^^^^^^^^^^^
New to AMS? Check out the getting started guides.
+++
.. link-button:: getting-started
:type: ref
:text: To the getting started guides
:classes: btn-block btn-secondary stretched-link
---
Examples
^^^^^^^^
The examples of using AMS for power system dispatch study.
+++
.. link-button:: scripting_examples
:type: ref
:text: To the examples
:classes: btn-block btn-secondary stretched-link
---
Model development guide
^^^^^^^^^^^^^^^^^^^^^^^
New dispatch modeling in AMS.
+++
.. link-button:: development
:type: ref
:text: To the development guide
:classes: btn-block btn-secondary stretched-link
---
API reference
^^^^^^^^^^^^^
The API reference of AMS.
+++
.. link-button:: api_reference
:type: ref
:text: To the API reference
:classes: btn-block btn-secondary stretched-link
---
:column: col-12 p-3
Using AMS for Research?
^^^^^^^^^^^^^^^^^^^^^^^^^
Please cite our paper [Cui2021]_ if AMS is used in your research for
publication.
.. [Cui2021] H. Cui, F. Li and K. Tomsovic, "Hybrid Symbolic-Numeric Framework
for Power System Modeling and Analysis," in IEEE Transactions on Power
Systems, vol. 36, no. 2, pp. 1373-1384, March 2021, doi:
10.1109/TPWRS.2020.3017019.
.. toctree::
:maxdepth: 3
:caption: AMS Manual
:hidden:
getting_started/index
examples/index
modeling/index
release-notes
api