ltbams 0.9.9__py3-none-any.whl → 1.0.2__py3-none-any.whl

docs/source/release-notes.rst

@@ -0,0 +1,398 @@
+.. _ReleaseNotes:
+
+=============
+Release notes
+=============
+
+The APIs before v3.0.0 are in beta and may change without prior notice.
+
+Pre-v1.0.0
+==========
+
+v1.0.2 (2024-02-01)
+
+--------------------
+
+- Enhance the GitHub Actions workflow file
+- Deprecate andes logger configuration in ``config_logger``
+- Deprecate solver specification in ``demo_ESD1``
+
+v1.0.1 (2024-01-26)
+--------------------
+
+Hotfix: removed dependencies on `SCIP` and `pyscipopt` to resolve installation issues
+
+v1.0.0 (2024-01-24)
+--------------------
+
+- **Breaking Change**: rename model ``Region`` to ``Zone`` for clarity. Prior case
+  files without modification can run into error.
+- Fix bugs in ``RTED.dc2ac``
+- Minor refacotr ``OptzBase.get_idx`` to reduce duplication
+- Rename module ``OptBase`` to ``OptzBase`` for clarity
+- Update benchamrk figure in README
+- Set ANDES requirement to v1.9.3
+- Deprecate method ``get_idx`` and suggest using ``get_all_idxes`` instead
+- Remove module ``benchmarks.py`` and its tests for simplicity
+
+v0.9.13 (2024-12-05)
+--------------------
+
+- Add a step to report in ``RoutineBase.run``
+- Add more tests to cover DG and ES related routines
+- Improve formulation for DG and ESD involved routines
+- Improve module ``Report`` and method ``RoutineBase.export_csv``
+- Support ``TimedEvent`` in ANDES case conversion
+- Add Var ``vBus`` in ``DCOPF`` for placeholder
+
+v0.9.12 (2024-11-23)
+--------------------
+
+- Refactor ``OModel.initialized`` as a property method
+- Add a demo to show using ``Constraint.e`` for debugging
+- Fix ``ams.opt.omodel.Param.evaluate`` when its value is a number
+- Improve ``ams.opt.omodel.ExpressionCalc`` for better performance
+- Refactor module ``ams.opt``
+- Add class ``ams.opt.Expression``
+- Switch from PYPOWER to ANDES in routine ``PFlow``
+- Switch from PYPOWER to regular formulation in routine ``DCPF``
+- Refactor routines ``DCPF`` and ``DCOPF``
+- In ``RDocumenter``, set Srouce to be owner if there is no src
+- Specify ``multiprocess<=0.70.16`` in requirements as 0.70.17 does not support Linux
+
+RC1
+~~~~
+- Reset setup.py to ensure compatibility
+
+v0.9.11 (2024-11-14)
+--------------------
+
+- Add pyproject.toml for PEP 517 and PEP 518 compliance
+- Add model ``Jumper``
+- Fix deprecation warning related to ``pandas.fillna`` and ``newshape`` in NumPy
+- Minor refactor on solvers information in the module ``shared``
+- Change default values of minimum ON/OFF duration time of generators to be 1 and 0.5 hours
+- Add parameter ``uf`` for enforced generator on/off status
+- In servicee ``LoadScale``, consider load online status
+- Consider line online status in routine ``ED``
+- Add methods ``evaluate`` and ``finalize`` in the class ``OModel`` to handle optimization 
+  elements generation and assembling
+- Refactor ``OModel.init`` and ``Routine.init``
+- Add ANDES paper as the citation file for now
+- Add more routine tests for generator trip, line trip, and load trip
+- Add a README to overview built-in cases
+- Rename methods ``v2`` as ``e`` for classes ``Constraint`` and ``Objective``
+- Add benchmark functions
+- Improve the usage of ``eval`` in module ``omodel``
+- Refactor module ``interop.andes`` as module ``interface`` for simplicity
+
+v0.9.10 (2024-09-03)
+--------------------
+
+Hotfix of import issue in ``v0.9.9``.
+
+- In module ``MatProcessor``, add two parameters ``permc_spec`` and ``use_umfpack`` in function ``build_ptdf``
+- Follow RTD's deprecation of Sphinx context injection at build time
+- In MATPOWER conversion, set devices name as None
+- Skip macOS tests in azure-pipelines due to failure in fixing its configuration
+- Prepare to support NumPy v2.0.0, but solvers have unexpected behavior
+- Improve the logic of setting ``Optz`` value
+- Support NumPy v2.0.0
+
+v0.9.9 (2024-09-02)
+-------------------
+
+**NOTICE: This version has known issues and has been yanked on PyPI.**
+
+v0.9.8 (2024-06-18)
+-------------------
+
+- Assign ``MParam.owner`` when declaring
+- In ``MatProcessor``, improve ``build_ptdf`` and ``build_lodf`` to allow partial building and
+  incremental building
+- Add file ``cases/matpower/Benchmark.json`` for benchmark with MATPOWER
+- Improve known good results test
+- Minor fix in ``main.py`` selftest part
+- Set dependency NumPy version to be <2.0.0 to avoid CVXPY compatibility issues
+
+v0.9.7 (2024-05-24)
+-------------------
+
+This patch release add the Roadmap section in the release notes, to list out some potential features.
+It also drafts the EV Aggregation model based on the state space modelg, but the finish date remains unknown.
+
+References:
+
+[1] J. Wang et al., "Electric Vehicles Charging Time Constrained Deliverable Provision of Secondary
+Frequency Regulation," in IEEE Transactions on Smart Grid, doi: 10.1109/TSG.2024.3356948.
+
+- Fix OTDF calculation
+- Add parameter ``dtype='float64'`` and ``no_store=False`` in ``MatProcessor`` PTDF, LODF, and OTDF
+  calculation, to save memory
+- Add placeholder parameter ``Bus.type``
+
+v0.9.6 (2024-04-21)
+-------------------
+
+This patch release refactor and improve ``MatProcessor``, where it support PTDF, LODF,
+and OTDF for static analysis.
+
+The reference can be found online "PowerWorld > Web Help > Sensitivities > Line
+Outage Distribution Factors".
+
+- Refactor DCPF, PFlow, and ACOPF
+- Add a loss factor in ``RTED.dc2ac``
+- Add ``DCOPF.dc2ac``
+- Fix OModel parse status to ensure no_parsed params can be updated
+- Fix and rerun ``ex2``
+- Format ``Routine.get`` return type to be consistent with input idx type
+- Remove unused ``Routine.prepare``
+- Refactor ``MatProcessor`` to separate matrix building
+- Add Var ``plf`` in ``DCPF``, ``PFlow``, and ``ACOPF`` to store the line flow
+- Add ``build_ptdf``, ``build_lodf``, and ``build_otdf``
+- Fix ``Routine.get`` to support pd.Series type idx input
+- Reserve ``exec_time`` after ``dc2ac``
+- Adjust kloss to fix ``ex2``
+
+v0.9.5 (2024-03-25)
+-------------------
+
+- Add more plots in ``demo_AGC``
+- Improve line rating adjustment
+- Adjust static import sequence in ``models.__init__.py``
+- Adjust pjm5bus case line rate_a
+- Fix formulation of constraint line angle diff
+- Align slack bus angle to zero in ``DCOPF``
+- Align StaticGen idx sequence with converted MATPOWER case
+- Fix several issues in MATPOWER converter
+
+v0.9.4 (2024-03-16)
+-------------------
+
+- Add Var ``pi`` and ExpressionCalc ``pic`` to store the dual of constraint power balance
+- Add Param ``M`` and ``D`` to model ``REGCV1``
+- Add CPS1 score calculation in ``demo_AGC``
+
+v0.9.3 (2024-03-06)
+-------------------
+
+- Major improvemets on ``demo_AGC``
+- Bug fix in ``RTED.dc2ac``
+
+v0.9.2 (2024-03-04)
+-------------------
+
+- Add ``demo_AGC`` to demonstrate detailed secondary frequency regulation study
+- Add ``ExpressionCalc`` to handle post-solving calculation
+- Rename ``type='eq'`` to ``is_eq=False`` in ``Constraint`` to avoid overriding built-in attribute
+- Several formatting improvements
+
+v0.9.1 (2024-03-02)
+-------------------
+
+- Change sphinx extension myst_nb to nbsphinx for math rendering in ``ex8``
+- Improve ``symprocessor`` to include routine config
+- Add config to Routine reference
+- Fix symbol processor issue with power operator
+
+v0.9.0 (2024-02-27)
+-------------------
+
+- Add ``ex8`` for formulation customization via API
+- Improve Development documentation
+- Fix ``addService``, ``addVars``
+- Rename ``RoutineModel`` to ``RoutineBase`` for better naming
+- Fix ANDES file converter issue
+- Initial release on conda-forge
+
+v0.8.5 (2024-01-31)
+-------------------
+
+- Improve quality of coverage and format
+- Fix dependency issue
+
+v0.8.4 (2024-01-30)
+-------------------
+
+- Version cleanup
+
+v0.8.3 (2024-01-30)
+-------------------
+
+- Initial release on PyPI
+
+v0.8.2 (2024-01-30)
+-------------------
+
+- Improve examples
+- Add module ``report`` and func ``RoutineBase.export_csv`` for results export
+
+v0.8.1 (2024-01-20)
+-------------------
+
+- Improve ``MatProcessor``
+- Add more examples
+- Improve ANDES interface
+
+v0.8.0 (2024-01-09)
+-------------------
+
+- Refactor ``DCED`` routines to improve performance
+
+v0.7.5 (2023-12-28)
+-------------------
+
+- Refactor ``MatProcessor`` and ``DCED`` routines to improve performance
+- Integrate sparsity pattern in ``RParam``
+- Rename energy storage routines ``RTED2``, ``ED2`` and ``UC2`` to ``RTEDES``, ``EDES`` and ``UCES``
+
+v0.7.4 (2023-11-29)
+-------------------
+
+- Refactor routins and optimization models to improve performance
+- Fix routines modeling
+- Add examples
+- Fix built-in cases
+
+v0.7.3 (2023-11-03)
+-------------------
+
+- Add tests
+
+v0.7.2 (2023-10-26)
+-------------------
+
+- Add routines ``ED2`` and ``UC2``
+- Minor fix on ``SymProcessor`` and ``Documenter``
+
+v0.7.1 (2023-10-12)
+-------------------
+
+- Add function ``_initial_guess`` to routine ``UC``
+- Refactor PYPOWER
+
+v0.7.0 (2023-09-22)
+-------------------
+
+- Add interfaces for customizing optimization
+- Add models ``REGCV1`` and ``REGCV1Cost`` for virtual inertia scheduling
+- Add cost models: ``SRCost``, ``NSRCost``, ``DCost``
+- Add reserve models: ``SR``, ``NSR``
+- Add routine ``UC``
+- Add routine ``RTED2`` to include energy storage model
+
+v0.6.7 (2023-08-02)
+-------------------
+
+- Version cleanup
+
+v0.6.6 (2023-07-27)
+-------------------
+
+- Improve routine reference
+- Add routine ED, LDOPF
+
+v0.6.5 (2023-06-27)
+-------------------
+
+- Update documentation with auto-generated model and routine reference
+- Add interface with ANDES ``ams.interop.andes``
+- Add routine RTED and example of RTED-TDS co-simulation
+- Draft development documentation
+
+v0.6.4 (2023-05-23)
+-------------------
+
+- Setup PFlow and DCPF using PYPOWER
+
+v0.6.3 (2023-05-22)
+-------------------
+
+- Using CVXPY for draft implementation
+- Improve ``model``, ``group``, ``param`` and ``var`` in ``core``
+- Refactor ``routines`` and ``opt``
+- Improve PYPOWER interface ``io.pypower.system2ppc``
+- Fix PYPOWER function ``solver.pypower.makePTDF``
+
+v0.6.2 (2023-04-23)
+-------------------
+
+- Enhance docstring
+- Remove unused module ``utils.LazyImport``
+- Remove unused module ``shared``
+
+v0.6.1 (2023-03-05)
+-------------------
+
+- Fix incompatiability of NumPy attribute ``object`` in  ``io.matpower._get_bus_id_caller``
+- Add file parser ``io.pypower`` for PYPOWER case file
+- Deprecate PYPOWER interface ``solvers.ipp``
+
+v0.6.0 (2023-03-04)
+-------------------
+
+- Set up PYPOWER for power flow calculation
+- Add PYPOWER interface ``solvers.ipp``
+- Develop module ``routines`` for routine analysis
+- Revise module ``system``, ``core.var``, ``core.model`` for routine analysis
+- Set up routine ``PFlow`` for power flow calculation
+- Add file parser ``io.matpower`` and ``io.raw`` for MATPOWER file and RAW file
+- Documentation of APIs
+
+v0.5 (2023-02-17)
+-------------------
+
+- Develop module ``system``, ``main``, ``cli``
+- Development preparation: versioneer, documentation, etc.
+
+v0.4 (2023-01)
+-------------------
+
+This release outlines the package.
+
+Known Limitations
+=================
+
+- For builit-in PYPOWER-based ACOPF, the known largest solvable case is "pglib_opf_case1354_pegase.m"
+- Batch processing is not supported yet
+- Routine ``DCOPF`` has been extensively benchmarked with pandapower and MATPOWER.
+- Routines besides above mentioned are not fully benchmarked yet.
+
+Roadmap
+=======
+
+This section lists out some potential features that may be added in the future.
+Note that the proposed features are not guaranteed to be implemented and subject to change.
+
+Electric Vehicle for Grid Service
+------------------------------------------
+
+A charging-time-constrained EV aggregation based on the state-space model
+
+References:
+
+[1] J. Wang et al., "Electric Vehicles Charging Time Constrained Deliverable Provision of Secondary
+Frequency Regulation," in IEEE Transactions on Smart Grid, doi: 10.1109/TSG.2024.3356948.
+
+[2] M. Wang et al., "State Space Model of Aggregated Electric Vehicles for Frequency Regulation," in
+IEEE Transactions on Smart Grid, vol. 11, no. 2, pp. 981-994, March 2020, doi: 10.1109/TSG.2019.2929052.
+
+Distribution OPF
+--------------------------
+
+- Distribution networks OPF and its LMP
+- DG siting and sizing considering energy equity
+
+References:
+
+[1] H. Yuan, F. Li, Y. Wei and J. Zhu, "Novel Linearized Power Flow and Linearized OPF Models for
+Active Distribution Networks With Application in Distribution LMP," in IEEE Transactions on Smart Grid,
+vol. 9, no. 1, pp. 438-448, Jan. 2018, doi: 10.1109/TSG.2016.2594814.
+
+[2] C. Li, F. Li, S. Jiang, X. Wang and J. Wang, "Siting and Sizing of DG Units Considering Energy
+Equity: Model, Solution, and Guidelines," in IEEE Transactions on Smart Grid, doi: 10.1109/TSG.2024.3350914.
+
+Planning
+--------------------------
+
+- Transmission expansion planning

ltbams-1.0.2.dist-info/METADATA

@@ -0,0 +1,215 @@
+Metadata-Version: 2.2
+Name: ltbams
+Version: 1.0.2
+Summary: Python software for scheduling modeling and co-simulation with dynamics.
+Home-page: https://github.com/CURENT/ams
+Author: Jinning Wang
+Author-email: Jinning Wang <jinninggm@gmail.com>
+License: GPL-3.0-or-later
+Classifier: Development Status :: 4 - Beta
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Environment :: Console
+Description-Content-Type: text/markdown
+Requires-Dist: kvxopt>=1.3.2.1
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: sympy!=1.10.0,>=1.6
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: psutil
+Requires-Dist: openpyxl
+Requires-Dist: andes>=1.9.3
+Requires-Dist: pybind11
+Requires-Dist: cvxpy
+Dynamic: author
+Dynamic: home-page
+
+# LTB AMS
+
+Python Software for Power System Scheduling Modeling and Co-Simulation with Dynamics, serving as the market simulator for the [CURENT Largescale Testbed][LTB Repository].
+
+[![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)](https://github.com/CURENT/ams/blob/master/LICENSE)
+![platforms](https://anaconda.org/conda-forge/ltbams/badges/platforms.svg)
+[![Python Versions](https://img.shields.io/badge/Python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/)
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+![Repo Size](https://img.shields.io/github/repo-size/CURENT/ams)
+[![GitHub last commit (master)](https://img.shields.io/github/last-commit/CURENT/ams/master?label=last%20commit%20to%20master)](https://github.com/CURENT/ams/commits/master/)
+[![GitHub last commit (develop)](https://img.shields.io/github/last-commit/CURENT/ams/develop?label=last%20commit%20to%20develop)](https://github.com/CURENT/ams/commits/develop/)
+[![libraries](https://img.shields.io/librariesio/release/pypi/ltbams)](https://libraries.io/pypi/ltbams)
+[![Structure](https://img.shields.io/badge/code_base-visualize-blue)](https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=CURENT%2Fams)
+
+[![Compatibility Tests](https://github.com/CURENT/ams/actions/workflows/compatibility.yml/badge.svg)](https://github.com/CURENT/ams/actions/workflows/compatibility.yml)
+[![Publish to TestPyPI and PyPI](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml/badge.svg?branch=master)](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml)
+[![Azure Pipline](https://dev.azure.com/curentltb/ams/_apis/build/status%2FCURENT.ams?branchName=master)](https://dev.azure.com/curentltb/ams/_build/latest?definitionId=2&branchName=master)
+
+<img src="docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png" alt="CURENT ERC Logo" width="300" height="auto">
+
+|               | Stable                                                                                                                                        | Latest                                                                                                                                        |
+|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| Documentation | [![Documentation Status](https://readthedocs.org/projects/ams/badge/?version=stable)](https://ams.readthedocs.io/en/stable/?badge=stable) | [![Latest Documentation](https://readthedocs.org/projects/ams/badge/?version=latest)](https://ams.readthedocs.io/en/latest/?badge=latest) | 
+
+
+| Badges        |                                                                                                                                                                                                                                                     |                                                                                                                                                                                                            |
+|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Downloads     | [![PyPI Version](https://img.shields.io/pypi/v/ltbams.svg)](https://pypi.python.org/pypi/ltbams)         | [![Conda Version](https://anaconda.org/conda-forge/ltbams/badges/version.svg)](https://anaconda.org/conda-forge/ltbams) |
+| Try on Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/curent/ams/master)                                                                                                                                                 |                                                                                                                                                                                                            |
+| Code Quality  |[![Codacy Badge](https://app.codacy.com/project/badge/Grade/69456da1b8634f2f984bd769e35f0050)](https://app.codacy.com/gh/CURENT/ams/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)| [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/69456da1b8634f2f984bd769e35f0050)](https://app.codacy.com/gh/CURENT/ams/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage) |
+
+
+
+# Why AMS
+
+AMS facilitates **Dynamics Incorporated Scheduling** and **Scheduling-Dynamics Co-Simulation**
+through an integrated interface with ANDES.
+
+This package is helpful for power system engineers, researchers, and students conducting
+scheduling and transient stability studies at specific operating points. It also benefits
+those interested in developing new scheduling formulations and algorithms, particularly
+by extending existing formulations to include new decision variables, constraints, and
+objective functions.
+
+AMS is a **Modeling Framework** that provides a descriptive way to formulate
+scheduling problems. The optimization problems are then handled by **CVXPY**
+and solved with third-party solvers.
+
+AMS produces credible scheduling results and competitive performance.
+The following results show the comparison of DCOPF between AMS and other tools.
+
+| Cost [\$]             | AMS          | pandapower   | MATPOWER     |
+|-----------------------|--------------|--------------|--------------|
+| IEEE 14-Bus           | 7,642.59     | 7,642.59     | 7,642.59     |
+| IEEE 39-Bus           | 41,263.94    | 41,263.94    | 41,263.94    |
+| PEGASE 89-Bus         | 5,733.37     | 5,733.37     | 5,733.37     |
+| IEEE 118-Bus          | 125,947.88   | 125,947.88   | 125,947.88   |
+| NPCC 140-Bus          | 810,033.37   | 810,016.06   | 810,033.37   |
+| WECC 179-Bus          | 411,706.13   | 411,706.13   | 411,706.13   |
+| IEEE 300-Bus          | 706,292.32   | 706,292.32   | 706,292.32   |
+| PEGASE 1354-Bus       | 1,218,096.86 | 1,218,096.86 | 1,218,096.86 |
+| PEGASE 2869-Bus       | 2,386,235.33 | 2,386,235.33 | 2,386,235.33 |
+| GOC 4020-Bus          | 793,634.11   | 793,634.11   | 793,634.11   |
+| EPIGRIDS 5658-Bus     | 1,195,466.12 | 1,195,466.12 | 1,195,466.12 |
+| EPIGRIDS 7336-Bus     | 1,855,870.94 | 1,855,870.94 | 1,855,870.94 |
+
+<div style="text-align: left;">
+  <img src="docs/source/images/dcopf_time.png" alt="DCOPF Time" width="480" height="auto">
+  <p><strong>Figure:</strong> Computation time of OPF on small-scale cases.</p>
+</div>
+
+In the bar chart, the gray bar labeled "AMS Symbolic Processing" represents the time spent
+on symbolic processing, while the wheat-colored bar "AMS Numeric Evaluation" represents the
+time spent on system matrices calculation and optimization model construction.
+The orange bar labeled "AMS GUROBI" represents the optimization-solving time using the GUROBI solver.
+Similarly, the red bar labeled "AMS MOSEK" and the pink bar labeled "AMS PIQP" represent the
+time used by the solvers MOSEK and PIQP, respectively.
+Regarding the baselines, the blue and green bars represent the running time of MATPOWER using
+solver MIPS and pandapower using solver PIPS, respectively.
+The results for AMS, pandapower, and matpower are the average time consumed over ten repeat tests.
+
+AMS is currently under active development.
+Use the following resources to get involved.
+
+-  Start from the [documentation][readthedocs] for installation and tutorial.
+-  Check out examples in the [examples folder][examples]
+-  Read the model verification results in the [examples/verification folder][verification]
+-  Ask a question in the [GitHub Discussions][Github Discussions]
+-  Report bugs or issues by submitting a [GitHub issue][GitHub issues]
+-  Submit contributions using [pull requests][GitHub pull requests]
+-  Read release notes highlighted [here][release notes]
+-  Try in Jupyter Notebook on [Binder][Binder]
+-  Check out the source code used for [benchmark][benchmark]
+-  Check out and and cite our [paper][paper]
+
+# Installation
+
+AMS is released as ``ltbams`` on PyPI and conda-forge.
+Install from PyPI using pip:
+
+```bash
+pip install ltbams
+```
+
+Install from conda-forge using conda:
+
+```bash
+conda install conda-forge::ltbams
+```
+
+Install from GitHub source:
+
+```bash
+pip install git+https://github.com/CURENT/ams.git
+```
+
+***NOTE:***
+- `cvxpy` is distributed with the open source solvers CLARABEL, OSQP, and SCS, but MIP-capable solvers need separate installation
+- `cvxpy` versions **below 1.5** are incompatible with `numpy` versions **2.0 and above**
+- If the solver `SCIP` encounters an import error caused by a missing `libscip.9.1.dylib`, try reinstalling its Python interface by running `pip install pyscipopt --no-binary scip --force`
+- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
+- Versions **1.0.0** and **1.0.1** are only available on PyPI
+- Version **0.9.9** has known issues and has been yanked from PyPI
+
+# Example Usage
+
+```python
+import ams
+import andes
+
+ss = ams.load(ams.get_case('ieee14/ieee14_uced.xlsx'))
+
+# solve RTED
+ss.RTED.run(solver='CLARABEL')
+
+ss.RTED.pg.v
+>>> array([1.8743862, 0.3226138, 0.01     , 0.02     , 0.01     ])
+
+# convert to ANDES case
+sa = ss.to_andes(addfile=andes.get_case('ieee14/ieee14_full.xlsx'),
+                 setup=True, verify=False)
+sa
+>>> <andes.system.System at 0x14bd98190>
+```
+
+# Citing AMS
+If you use AMS for research or consulting, please cite the following paper in your publication that uses AMS:
+
+> J. Wang et al., "Dynamics-incorporated Modeling Framework for Stability Constrained Scheduling Under High-penetration of Renewable Energy," in IEEE Transactions on Sustainable Energy, doi: 10.1109/TSTE.2025.3528027.
+
+# Sponsors and Contributors
+AMS is the scheduling simulation engine for the CURENT Largescale Testbed (LTB).
+More information about CURENT LTB can be found at the [LTB Repository][LTB Repository].
+
+This work was supported in part by the Engineering Research Center Program of the National Science Foundation and the Department of Energy
+under NSF Award Number EEC-1041877 and the CURENT Industry Partnership Program.
+
+This work was supported in part by the Advanced Grid Research and Development Program in the Office of Electricity at the U.S. Department of Energy.
+
+See [GitHub contributors][GitHub contributors] for the contributor list.
+
+# License
+AMS is licensed under the [GPL v3 License](./LICENSE).
+
+# Related Projects
+- [Popular Open Source Libraries for Power System Analysis](https://github.com/jinningwang/best-of-ps)
+- [G-PST Tools Portal](https://g-pst.github.io/tools/): An open tools portal with a classification approach
+- [Open Source Software (OSS) for Electricity Market Research, Teaching, and Training](https://www2.econ.iastate.edu/tesfatsi/ElectricOSS.htm)
+
+Some commercial solvers provide academic licenses, such as COPT, GUROBI, CPLEX, and MOSEK.
+
+* * *
+
+[GitHub releases]:       https://github.com/CURENT/ams/releases
+[GitHub issues]:         https://github.com/CURENT/ams/issues
+[Github Discussions]:    https://github.com/CURENT/ams/discussions
+[GitHub insights]:       https://github.com/CURENT/ams/pulse
+[GitHub pull requests]:  https://github.com/CURENT/ams/pulls
+[GitHub contributors]:   https://github.com/CURENT/ams/graphs/contributors
+[readthedocs]:           https://ams.readthedocs.io
+[release notes]:         https://ams.readthedocs.io/en/latest/release-notes.html
+[examples]:              https://github.com/CURENT/ams/tree/master/examples
+[verification]:          https://github.com/CURENT/ams/tree/master/examples/verification
+[Binder]:                https://mybinder.org/v2/gh/curent/ams/master
+[LTB Repository]:        https://github.com/CURENT
+[benchmark]:             https://github.com/CURENT/demo/tree/master/demo/ams_benchmark
+[paper]:                 https://ieeexplore.ieee.org/document/9169830