ltbams 1.0.2a1__tar.gz → 1.0.3a1__tar.gz

{ltbams-1.0.2a1/ltbams.egg-info → ltbams-1.0.3a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ltbams
-Version: 1.0.2a1
+Version: 1.0.3a1
 Summary: Python software for scheduling modeling and co-simulation with dynamics.
 Home-page: https://github.com/CURENT/ams
 Author: Jinning Wang
@@ -40,11 +40,15 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 [![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">
 
-|               | Latest                                                                                                                                        | Stable                                                                                                                                        |
+|               | Stable                                                                                                                                        | Latest                                                                                                                                        |
 |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
-| 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) |
+| 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        |                                                                                                                                                                                                                                                     |                                                                                                                                                                                                            |
@@ -52,7 +56,7 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 | 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
@@ -139,11 +143,12 @@ pip install git+https://github.com/CURENT/ams.git
 ```
 
 ***NOTE:***
-- Version **0.9.9** has known issues and has been yanked from PyPI
-- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
+- `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`
-- Version **1.0.0** is only available on PyPI
+- `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
 

{ltbams-1.0.2a1 → ltbams-1.0.3a1}/README.md

@@ -12,11 +12,15 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 [![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">
 
-|               | Latest                                                                                                                                        | Stable                                                                                                                                        |
+|               | Stable                                                                                                                                        | Latest                                                                                                                                        |
 |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
-| 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) |
+| 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        |                                                                                                                                                                                                                                                     |                                                                                                                                                                                                            |
@@ -24,7 +28,7 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 | 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
@@ -111,11 +115,12 @@ pip install git+https://github.com/CURENT/ams.git
 ```
 
 ***NOTE:***
-- Version **0.9.9** has known issues and has been yanked from PyPI
-- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
+- `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`
-- Version **1.0.0** is only available on PyPI
+- `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
 

{ltbams-1.0.2a1 → ltbams-1.0.3a1}/ams/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-02-01T20:53:27-0500",
+ "date": "2025-02-02T08:55:36-0500",
  "dirty": false,
  "error": null,
- "full-revisionid": "b8525bc311f8262880316ee9cf5e697ad7ed80fc",
- "version": "1.0.2a1"
+ "full-revisionid": "8a697edc2d5ab9e5451fa1d4a5b2bec41d180d4c",
+ "version": "1.0.3a1"
 }
 '''  # END VERSION_JSON
 

{ltbams-1.0.2a1 → ltbams-1.0.3a1}/ams/interface.py

@@ -336,7 +336,12 @@ def parse_addfile(adsys, amsys, addfile):
 
     # NOTE: Group TimedEvent needs special treatment
     # adjust Toggle and Fault models
-    toggle_df = df_models.get('Toggle') or df_models.get('Toggler')
+    keys_toggle = ['Toggle', 'Toggler']
+    toggle_df = None
+    for key in keys_toggle:
+        if key in df_models:
+            toggle_df = df_models[key]
+            break
     if toggle_df is not None:
         toggle_df['dev'] = toggle_df.apply(replace_dev, axis=1,
                                            mdl='model', dev='dev',

{ltbams-1.0.2a1 → ltbams-1.0.3a1}/docs/source/conf.py

@@ -201,3 +201,6 @@ shutil.copytree("../../examples/demonstration", "_examples/demo", )
 # sphinx-panels shouldn't add bootstrap css since the pydata-sphinx-theme
 # already loads it
 panels_add_bootstrap_css = False
+
+# specify image loading behavior
+image_loading = 'link'

{ltbams-1.0.2a1 → ltbams-1.0.3a1}/docs/source/getting_started/install.rst

@@ -71,7 +71,8 @@ development packages. Other packages will be required for interoperability.
 The extra support packages are specified in groups. The following group names
 are supported, with descriptions given below:
 
-- ``dev``: packages to support development such as testing and documentation
+- ``dev``: packages to support development such as testing
+- ``doc``: packages to support documentation building
 
 .. note::
 
@@ -82,15 +83,9 @@ To install packages in the ``dev`` when installing AMS, do:
 
 .. code:: bash
 
-    pip install ltbams[dev]
+    pip install -r requirements-dev.txt
 
-To install all extra packages, do:
-
-.. code:: bash
-
-    pip install ltbams[all]
-
-One can also inspect the ``requirements-extra.txt`` to identify the packages
+One can also inspect the ``requirements-dev.txt`` to identify the packages
 for manual installation.
 
 .. _Develop Install:
@@ -134,14 +129,16 @@ Install dependencies with
 .. code:: bash
 
     mamba install --file requirements.txt
-    mamba install --file requirements-extra.txt
+    mamba install --file requirements-dev.txt
+    mamba install --file requirements-doc.txt
 
 Alternatively, you can install them with ``pip``:
 
 .. code:: bash
 
     pip install -r requirements.txt
-    pip install -r requirements-extra.txt
+    pip install -r requirements-dev.txt
+    pip install -r requirements-doc.txt
 
 Step 3: Install AMS in the development mode using
 

{ltbams-1.0.2a1 → ltbams-1.0.3a1}/docs/source/release-notes.rst

@@ -9,6 +9,12 @@ The APIs before v3.0.0 are in beta and may change without prior notice.
 Pre-v1.0.0
 ==========
 
+v1.0.3 (2024-xx-xx)
+
+--------------------
+
+- Bug fix in function ``ams.interface.parse_addfile``, released in v1.0.3a1
+
 v1.0.2 (2024-02-01)
 
 --------------------

{ltbams-1.0.2a1 → ltbams-1.0.3a1/ltbams.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ltbams
-Version: 1.0.2a1
+Version: 1.0.3a1
 Summary: Python software for scheduling modeling and co-simulation with dynamics.
 Home-page: https://github.com/CURENT/ams
 Author: Jinning Wang
@@ -40,11 +40,15 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 [![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">
 
-|               | Latest                                                                                                                                        | Stable                                                                                                                                        |
+|               | Stable                                                                                                                                        | Latest                                                                                                                                        |
 |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
-| 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) |
+| 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        |                                                                                                                                                                                                                                                     |                                                                                                                                                                                                            |
@@ -52,7 +56,7 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 | 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
@@ -139,11 +143,12 @@ pip install git+https://github.com/CURENT/ams.git
 ```
 
 ***NOTE:***
-- Version **0.9.9** has known issues and has been yanked from PyPI
-- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
+- `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`
-- Version **1.0.0** is only available on PyPI
+- `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