ltbams 0.9.9__tar.gz → 0.9.10__tar.gz

ltbams-0.9.10/CONTRIBUTING.rst

@@ -0,0 +1,102 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/CURENT/ams/issues.
+
+If you are reporting a bug, please include:
+
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "feature"
+is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+AMS could always use more documentation, whether
+as part of the official AMS docs, in docstrings,
+or even on the web in blog posts, articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/CURENT/ams/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `ams` for local development.
+
+1. Fork the `ams` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/ams.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenv wrapper installed, this is how you
+set up your fork for local development::
+
+    $ mkvirtualenv ams
+    $ cd ams/
+    $ pip install -e .[dev]
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+
+    $ flake8 ams tests
+    $ ams selftest
+
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.9 and up. Check
+   https://github.com/CURENT/ams/actions
+   and make sure that the tests pass for all supported Python versions.

ltbams-0.9.10/MANIFEST.in

@@ -0,0 +1,17 @@
+include CONTRIBUTING.rst
+include LICENSE
+include README.md
+include requirements.txt
+include requirements-extra.txt
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include ams/cases *.xlsx *.m *.raw *.dyr *.py *.json
+recursive-include docs *.rst *.png conf.py Makefile make.bat
+
+include versioneer.py
+include ams/_version.py
+
+# If including data files in the package, add them like:
+# include path/to/data_file

ltbams-0.9.10/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.1
+Name: ltbams
+Version: 0.9.10
+Summary: Python software for scheduling modeling and co-simulation with dynanics.
+Home-page: https://github.com/CURENT/ams
+Author: Jinning Wang
+Author-email: jinninggm@gmail.com
+License: GNU Public License v3
+Platform: UNKNOWN
+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
+Provides-Extra: all
+Provides-Extra: coverage 
+Provides-Extra: dev
+Provides-Extra: doc
+Provides-Extra: flake8 
+Provides-Extra: ipython 
+Provides-Extra: myst-parser 
+Provides-Extra: nbsphinx 
+Provides-Extra: numpydoc 
+Provides-Extra: pydata-sphinx-theme 
+Provides-Extra: pyscipopt 
+Provides-Extra: pytest
+Provides-Extra: pytest-cov 
+Provides-Extra: sphinx 
+Provides-Extra: sphinx-copybutton 
+Provides-Extra: sphinx-panels 
+License-File: LICENSE
+
+# LTB AMS
+
+Python Software for Power System Scheduling Modeling and Co-Simulation with Dynanic, 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/)
+![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)
+
+<img src="docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png" alt="CURENT ERC Logo" width="300" height="auto">
+
+|               | Latest                                                                                                                                        | Stable                                                                                                                                        |
+|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| Documentation | [![Latest Documentation](https://readthedocs.org/projects/ams/badge/?version=latest)](https://ams.readthedocs.io/en/latest/?badge=latest) | [![Documentation Status](https://readthedocs.org/projects/ams/badge/?version=stable)](https://ams.readthedocs.io/en/stable/?badge=stable) |
+
+
+| 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) |
+| Build Status  | [![GitHub Action Status](https://github.com/CURENT/ams/workflows/Python%20application/badge.svg)](https://github.com/curent/ams/actions)  | [![Build Status](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) |
+
+
+# Why AMS
+
+With the built-in interface with dynamic simulation engine, ANDES, AMS enables Dynamics Interfaced Stability Constrained Production Cost and Market Operation Modeling.
+
+AMS produces credible scheduling results and competitive performance.
+The following results show the comparison of DCOPF between AMS and other tools.
+
+| Cost [\$]       |      AMS       |  MATPOWER   | pandapower |
+|----------------:|--------------:|------------:|-----------:|
+| PEGASE 1354-Bus |  1,173,590.63  |  1,173,590.63 |  1,173,590.63 |
+| PEGASE 2869-Bus |  2,338,915.61  |  2,338,915.61 |  2,338,915.61 |
+| 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 |
+
+<img src="docs/source/images/dcopf_time.png" alt="DCOPF Time" width="400" height="auto">
+
+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 and and cite our [paper][arxiv paper] -->
+
+# Installation
+
+***NOTE:***
+- Version **0.9.9** has known issues. Please avoid using this version
+- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
+- `cvxpy` versions **below 1.5** are incompatible with `numpy` versions **2.0 and above**
+
+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
+```
+
+# 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
+

{ltbams-0.9.9 → ltbams-0.9.10}/README.md

@@ -8,7 +8,6 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 ![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/)
-[![HitCount](https://hits.dwyl.com/CURENT/ams.svg)](https://hits.dwyl.com/CURENT/ams)
 [![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)
 
@@ -60,8 +59,9 @@ Use the following resources to get involved.
 # Installation
 
 ***NOTE:***
-- ``kvxopt`` is recommended to install via ``conda`` as sometimes ``pip`` struggles to set the correct path for compiled libraries
-- `cvxpy` versions **below 1.5** are incompatible with `numpy` versions **2.0 and above**.
+- Version **0.9.9** has known issues. Please avoid using this version
+- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
+- `cvxpy` versions **below 1.5** are incompatible with `numpy` versions **2.0 and above**
 
 AMS is released as ``ltbams`` on PyPI and conda-forge.
 Install from PyPI using pip:

{ltbams-0.9.9 → ltbams-0.9.10}/ams/_version.py

@@ -1,5 +1,5 @@
 
-# This file was generated by 'versioneer.py' (0.29) from
+# This file was generated by 'versioneer.py' (0.22) from
 # revision-control system data, or from the parent directory name of an
 # unpacked source archive. Distribution tarballs contain a pre-generated copy
 # of this file.
@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-09-02T17:38:15-0400",
+ "date": "2024-09-03T22:41:38-0400",
  "dirty": false,
  "error": null,
- "full-revisionid": "0b3b3c26e50a763fbd1cb0daaca46b556a062396",
- "version": "0.9.9"
+ "full-revisionid": "8bc9504a8281c16236c73decd8e7365b682c706c",
+ "version": "0.9.10"
 }
 '''  # END VERSION_JSON