ltbams 1.0.0__tar.gz → 1.0.1__tar.gz

{ltbams-1.0.0/ltbams.egg-info → ltbams-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.1
 Name: ltbams
-Version: 1.0.0
+Version: 1.0.1
 Summary: Python software for scheduling modeling and co-simulation with dynamics.
 Home-page: https://github.com/CURENT/ams
 Author: Jinning Wang
@@ -12,39 +12,9 @@ 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
+Provides-Extra: all
 Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: coverage; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: numpydoc; extra == "dev"
-Requires-Dist: toml; extra == "dev"
-Requires-Dist: pyscipopt; extra == "dev"
-Requires-Dist: toml; extra == "dev"
 Provides-Extra: doc
-Requires-Dist: pandoc; extra == "doc"
-Requires-Dist: ipython; extra == "doc"
-Requires-Dist: sphinx; extra == "doc"
-Requires-Dist: pydata-sphinx-theme; extra == "doc"
-Requires-Dist: numpydoc; extra == "doc"
-Requires-Dist: sphinx-copybutton; extra == "doc"
-Requires-Dist: sphinx-panels; extra == "doc"
-Requires-Dist: myst-parser; extra == "doc"
-Requires-Dist: nbsphinx; extra == "doc"
-Requires-Dist: pyscipopt; extra == "doc"
-Dynamic: author
-Dynamic: home-page
 
 # LTB AMS
 
@@ -162,7 +132,8 @@ pip install git+https://github.com/CURENT/ams.git
 - 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` versions **below 1.5** are incompatible with `numpy` versions **2.0 and above**
-- If solver `SCIP` run into import error, try to reinstall its Python interface by running `pip install pyscipopt --no-binary scip --force`
+- 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
 
 # Example Usage
 

{ltbams-1.0.0 → ltbams-1.0.1}/README.md

@@ -114,7 +114,8 @@ pip install git+https://github.com/CURENT/ams.git
 - 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` versions **below 1.5** are incompatible with `numpy` versions **2.0 and above**
-- If solver `SCIP` run into import error, try to reinstall its Python interface by running `pip install pyscipopt --no-binary scip --force`
+- 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
 
 # Example Usage
 

{ltbams-1.0.0 → ltbams-1.0.1}/ams/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-01-24T16:25:19-0500",
+ "date": "2025-01-26T22:29:13-0500",
  "dirty": false,
  "error": null,
- "full-revisionid": "b06fb9d427a5bc13bf2810f6d8bf45d92fb8224d",
- "version": "1.0.0"
+ "full-revisionid": "26601dec804476dfd457ef35d3eb164c8cede2d0",
+ "version": "1.0.1"
 }
 '''  # END VERSION_JSON
 

{ltbams-1.0.0 → ltbams-1.0.1}/ams/shared.py

@@ -41,11 +41,27 @@ copyright_msg = 'Copyright (C) 2023-2024 Jinning Wang'
 mip_solvers = ['CBC', 'COPT', 'GLPK_MI', 'CPLEX', 'GUROBI',
                'MOSEK', 'SCIP', 'XPRESS', 'SCIPY']
 
+misocp_solvers = ['MOSEK', 'CPLEX', 'GUROBI', 'XPRESS', 'SCIP']
+
 installed_solvers = cp.installed_solvers()
 
 installed_mip_solvers = [s for s in installed_solvers if s in mip_solvers]
 
 
+def require_MISOCP_solver(f):
+    """
+    Decorator for functions that require MISOCP solver.
+    """
+
+    @wraps(f)
+    def wrapper(*args, **kwargs):
+        if not any(s in misocp_solvers for s in installed_solvers):
+            raise ModuleNotFoundError("No MISOCP solver is available.")
+        return f(*args, **kwargs)
+
+    return wrapper
+
+
 def require_MIP_solver(f):
     """
     Decorator for functions that require MIP solver.
@@ -73,6 +89,19 @@ def skip_unittest_without_MIP(f):
     return wrapper
 
 
+def skip_unittest_without_MISOCP(f):
+    """
+    Decorator for skipping tests that require MISOCP solver.
+    """
+    def wrapper(*args, **kwargs):
+        if any(s in misocp_solvers for s in installed_solvers):
+            pass
+        else:
+            raise unittest.SkipTest("No MISOCP solver is available.")
+        return f(*args, **kwargs)
+    return wrapper
+
+
 ppc_cols = OrderedDict([
     ('bus', ['bus_i', 'type', 'pd', 'qd', 'gs', 'bs', 'area', 'vm', 'va',
              'baseKV', 'zone', 'vmax', 'vmin', 'lam_p', 'lam_q',

{ltbams-1.0.0 → ltbams-1.0.1}/docs/source/release-notes.rst

@@ -9,6 +9,11 @@ The APIs before v3.0.0 are in beta and may change without prior notice.
 Pre-v1.0.0
 ==========
 
+v1.0.0 (2024-01-26)
+--------------------
+
+Hotfix: removed dependencies on `SCIP` and `pyscipopt` to resolve installation issues
+
 v1.0.0 (2024-01-24)
 --------------------
 

{ltbams-1.0.0 → ltbams-1.0.1/ltbams.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.1
 Name: ltbams
-Version: 1.0.0
+Version: 1.0.1
 Summary: Python software for scheduling modeling and co-simulation with dynamics.
 Home-page: https://github.com/CURENT/ams
 Author: Jinning Wang
@@ -12,39 +12,9 @@ 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
+Provides-Extra: all
 Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: coverage; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: numpydoc; extra == "dev"
-Requires-Dist: toml; extra == "dev"
-Requires-Dist: pyscipopt; extra == "dev"
-Requires-Dist: toml; extra == "dev"
 Provides-Extra: doc
-Requires-Dist: pandoc; extra == "doc"
-Requires-Dist: ipython; extra == "doc"
-Requires-Dist: sphinx; extra == "doc"
-Requires-Dist: pydata-sphinx-theme; extra == "doc"
-Requires-Dist: numpydoc; extra == "doc"
-Requires-Dist: sphinx-copybutton; extra == "doc"
-Requires-Dist: sphinx-panels; extra == "doc"
-Requires-Dist: myst-parser; extra == "doc"
-Requires-Dist: nbsphinx; extra == "doc"
-Requires-Dist: pyscipopt; extra == "doc"
-Dynamic: author
-Dynamic: home-page
 
 # LTB AMS
 
@@ -162,7 +132,8 @@ pip install git+https://github.com/CURENT/ams.git
 - 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` versions **below 1.5** are incompatible with `numpy` versions **2.0 and above**
-- If solver `SCIP` run into import error, try to reinstall its Python interface by running `pip install pyscipopt --no-binary scip --force`
+- 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
 
 # Example Usage
 

ltbams-1.0.1/ltbams.egg-info/SOURCES.txt

@@ -0,0 +1,198 @@
+CONTRIBUTING.rst
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+requirements-extra.txt
+requirements.txt
+setup.cfg
+setup.py
+versioneer.py
+ams/__init__.py
+ams/__main__.py
+ams/_version.py
+ams/cli.py
+ams/interface.py
+ams/main.py
+ams/report.py
+ams/shared.py
+ams/system.py
+ams/cases/5bus/pjm5bus_demo.xlsx
+ams/cases/5bus/pjm5bus_jumper.xlsx
+ams/cases/5bus/pjm5bus_uced.json
+ams/cases/5bus/pjm5bus_uced.xlsx
+ams/cases/5bus/pjm5bus_uced_esd1.xlsx
+ams/cases/5bus/pjm5bus_uced_ev.xlsx
+ams/cases/ieee123/ieee123.xlsx
+ams/cases/ieee123/ieee123_regcv1.xlsx
+ams/cases/ieee14/ieee14.json
+ams/cases/ieee14/ieee14.raw
+ams/cases/ieee14/ieee14_conn.xlsx
+ams/cases/ieee14/ieee14_uced.xlsx
+ams/cases/ieee39/ieee39.xlsx
+ams/cases/ieee39/ieee39_uced.xlsx
+ams/cases/ieee39/ieee39_uced_esd1.xlsx
+ams/cases/ieee39/ieee39_uced_pvd1.xlsx
+ams/cases/ieee39/ieee39_uced_vis.xlsx
+ams/cases/matpower/benchmark.json
+ams/cases/matpower/case118.m
+ams/cases/matpower/case14.m
+ams/cases/matpower/case300.m
+ams/cases/matpower/case39.m
+ams/cases/matpower/case5.m
+ams/cases/matpower/case_ACTIVSg2000.m
+ams/cases/npcc/npcc.m
+ams/cases/npcc/npcc_uced.xlsx
+ams/cases/pglib/pglib_opf_case39_epri__api.m
+ams/cases/wecc/wecc.m
+ams/cases/wecc/wecc_uced.xlsx
+ams/core/__init__.py
+ams/core/documenter.py
+ams/core/matprocessor.py
+ams/core/model.py
+ams/core/param.py
+ams/core/service.py
+ams/core/symprocessor.py
+ams/core/var.py
+ams/extension/__init__.py
+ams/extension/eva.py
+ams/io/__init__.py
+ams/io/json.py
+ams/io/matpower.py
+ams/io/psse.py
+ams/io/pypower.py
+ams/io/xlsx.py
+ams/models/__init__.py
+ams/models/area.py
+ams/models/bus.py
+ams/models/cost.py
+ams/models/group.py
+ams/models/info.py
+ams/models/line.py
+ams/models/reserve.py
+ams/models/shunt.py
+ams/models/timeslot.py
+ams/models/zone.py
+ams/models/distributed/__init__.py
+ams/models/distributed/esd1.py
+ams/models/distributed/ev.py
+ams/models/distributed/pvd1.py
+ams/models/renewable/__init__.py
+ams/models/renewable/regc.py
+ams/models/static/__init__.py
+ams/models/static/gen.py
+ams/models/static/pq.py
+ams/opt/__init__.py
+ams/opt/constraint.py
+ams/opt/exprcalc.py
+ams/opt/expression.py
+ams/opt/objective.py
+ams/opt/omodel.py
+ams/opt/optzbase.py
+ams/opt/param.py
+ams/opt/var.py
+ams/pypower/__init__.py
+ams/pypower/_compat.py
+ams/pypower/eps.py
+ams/pypower/idx.py
+ams/pypower/io.py
+ams/pypower/toggle.py
+ams/pypower/utils.py
+ams/pypower/core/__init__.py
+ams/pypower/core/pips.py
+ams/pypower/core/ppoption.py
+ams/pypower/core/ppver.py
+ams/pypower/core/solver.py
+ams/pypower/make/__init__.py
+ams/pypower/make/matrices.py
+ams/pypower/make/pdv.py
+ams/pypower/routines/__init__.py
+ams/pypower/routines/cpf.py
+ams/pypower/routines/cpf_callbacks.py
+ams/pypower/routines/opf.py
+ams/pypower/routines/opffcns.py
+ams/pypower/routines/pflow.py
+ams/routines/__init__.py
+ams/routines/acopf.py
+ams/routines/cpf.py
+ams/routines/dcopf.py
+ams/routines/dcpf.py
+ams/routines/dcpf0.py
+ams/routines/dopf.py
+ams/routines/ed.py
+ams/routines/pflow.py
+ams/routines/pflow0.py
+ams/routines/routine.py
+ams/routines/rted.py
+ams/routines/type.py
+ams/routines/uc.py
+ams/utils/__init__.py
+ams/utils/misc.py
+ams/utils/paths.py
+docs/Makefile
+docs/make.bat
+docs/source/api.rst
+docs/source/conf.py
+docs/source/genmodelref.py
+docs/source/genroutineref.py
+docs/source/index.rst
+docs/source/release-notes.rst
+docs/source/_templates/autosummary/base.rst
+docs/source/_templates/autosummary/class.rst
+docs/source/_templates/autosummary/module.rst
+docs/source/_templates/autosummary/module_toctree.rst
+docs/source/examples/index.rst
+docs/source/getting_started/copyright.rst
+docs/source/getting_started/index.rst
+docs/source/getting_started/install.rst
+docs/source/getting_started/overview.rst
+docs/source/getting_started/testcase.rst
+docs/source/getting_started/verification.rst
+docs/source/getting_started/formats/index.rst
+docs/source/getting_started/formats/matpower.rst
+docs/source/getting_started/formats/psse.rst
+docs/source/getting_started/formats/pypower.rst
+docs/source/getting_started/formats/xlsx.png
+docs/source/getting_started/formats/xlsx.rst
+docs/source/images/dcopf_time.png
+docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png
+docs/source/images/sponsors/CURENT_Logo_Transparent.png
+docs/source/images/sponsors/CURENT_Logo_Transparent_Name.png
+docs/source/images/sponsors/doe.png
+docs/source/modeling/example.rst
+docs/source/modeling/index.rst
+docs/source/modeling/model.rst
+docs/source/modeling/routine.rst
+docs/source/modeling/system.rst
+ltbams.egg-info/PKG-INFO
+ltbams.egg-info/SOURCES.txt
+ltbams.egg-info/dependency_links.txt
+ltbams.egg-info/entry_points.txt
+ltbams.egg-info/requires.txt
+ltbams.egg-info/top_level.txt
+tests/__init__.py
+tests/test_1st_system.py
+tests/test_addressing.py
+tests/test_andes_mats.py
+tests/test_case.py
+tests/test_cli.py
+tests/test_export_csv.py
+tests/test_group.py
+tests/test_interface.py
+tests/test_io.py
+tests/test_jumper.py
+tests/test_known_good.py
+tests/test_matp.py
+tests/test_model.py
+tests/test_omodel.py
+tests/test_paths.py
+tests/test_report.py
+tests/test_repr.py
+tests/test_routine.py
+tests/test_rtn_dcopf.py
+tests/test_rtn_dcpf.py
+tests/test_rtn_ed.py
+tests/test_rtn_pflow.py
+tests/test_rtn_rted.py
+tests/test_rtn_uc.py
+tests/test_service.py

{ltbams-1.0.0 → ltbams-1.0.1}/ltbams.egg-info/requires.txt

@@ -1,32 +1,46 @@
+andes>=1.9.3
+cvxpy
 kvxopt>=1.3.2.1
+matplotlib
 numpy
-scipy
-sympy!=1.10.0,>=1.6
+openpyxl
 pandas
-matplotlib
 psutil
-openpyxl
-andes>=1.9.3
 pybind11
-cvxpy
+scipy
+sympy!=1.10.0,>=1.6
 
-[dev]
+[all]
+coverage
+flake8
+ipython
+myst-parser
+nbsphinx
+numpydoc
+pandoc
+pydata-sphinx-theme
 pytest
 pytest-cov
+sphinx
+sphinx-copybutton
+sphinx-panels
+toml
+
+[dev]
 coverage
 flake8
 numpydoc
+pytest
+pytest-cov
 toml
-pyscipopt
 
 [doc]
-pandoc
 ipython
-sphinx
-pydata-sphinx-theme
+myst-parser
+nbsphinx
 numpydoc
+pandoc
+pydata-sphinx-theme
+sphinx
 sphinx-copybutton
 sphinx-panels
-myst-parser
-nbsphinx
-pyscipopt

{ltbams-1.0.0 → ltbams-1.0.1}/ltbams.egg-info/top_level.txt

@@ -1,5 +1,4 @@
 ams
 docs
 examples
-icebar
 tests

{ltbams-1.0.0 → ltbams-1.0.1}/pyproject.toml

@@ -43,7 +43,6 @@ dev = [
     "flake8",
     "numpydoc",
     "toml",
-    "pyscipopt",
     "toml"
 ]
 doc = [
@@ -56,7 +55,6 @@ doc = [
     "sphinx-panels",
     "myst-parser",
     "nbsphinx",
-    "pyscipopt"
 ]
 
 [project.scripts]

{ltbams-1.0.0 → ltbams-1.0.1}/requirements-extra.txt

@@ -1,11 +1,10 @@
-# Generated on 2025-01-06.
+# Generated on 2025-01-26.
 pytest               # dev
 pytest-cov           # dev
 coverage             # dev
 flake8               # dev
 numpydoc             # dev
 toml                 # dev
-pyscipopt            # dev
 toml                 # dev
 pandoc               # doc
 ipython              # doc
@@ -16,4 +15,3 @@ sphinx-copybutton    # doc
 sphinx-panels        # doc
 myst-parser          # doc
 nbsphinx             # doc
-pyscipopt            # doc

{ltbams-1.0.0 → ltbams-1.0.1}/requirements.txt

@@ -1,4 +1,4 @@
-# Generated on 2025-01-06.
+# Generated on 2025-01-26.
 kvxopt>=1.3.2.1
 numpy
 scipy

{ltbams-1.0.0 → ltbams-1.0.1}/setup.py

@@ -56,9 +56,9 @@ def get_extra_requires(filename, add_all=True):
                     k, v = k.split('#')
                     tags.update(vv.strip() for vv in v.split(','))
 
-                tags.add(re.split('[<=>]', k)[0])
+                # Do not add the package name itself as a tag
                 for t in tags:
-                    extra_deps[t].add(k)
+                    extra_deps[t].add(k.strip())
 
         # add tag `all` at the end
         if add_all:

{ltbams-1.0.0 → ltbams-1.0.1}/tests/test_report.py

@@ -5,6 +5,7 @@ import unittest
 import os
 
 import ams
+from ams.shared import skip_unittest_without_MISOCP
 
 
 import logging
@@ -118,12 +119,13 @@ class TestReport(unittest.TestCase):
         self.assertTrue(os.path.exists('pjm5bus_demo_RTEDDG.csv'))
         os.remove('pjm5bus_demo_RTEDDG.csv')
 
+    @skip_unittest_without_MISOCP
     def test_RTEDES_report(self):
         """
         Test report with RTEDES solved.
         """
         self.ss.files.no_output = False
-        self.ss.RTEDES.run(solver='SCIP')
+        self.ss.RTEDES.run()
         self.assertTrue(self.ss.report())
         self.assertTrue(os.path.exists(self.expected_report))
 
@@ -172,12 +174,13 @@ class TestReport(unittest.TestCase):
         self.assertTrue(os.path.exists('pjm5bus_demo_EDDG.csv'))
         os.remove('pjm5bus_demo_EDDG.csv')
 
+    @skip_unittest_without_MISOCP
     def test_EDES_report(self):
         """
         Test report with EDES solved.
         """
         self.ss.files.no_output = False
-        self.ss.EDES.run(solver='SCIP')
+        self.ss.EDES.run()
         self.assertTrue(self.ss.report())
         self.assertTrue(os.path.exists(self.expected_report))
 
@@ -190,12 +193,13 @@ class TestReport(unittest.TestCase):
         self.assertTrue(os.path.exists('pjm5bus_demo_EDES.csv'))
         os.remove('pjm5bus_demo_EDES.csv')
 
+    @skip_unittest_without_MISOCP
     def test_UC_report(self):
         """
         Test report with UC solved.
         """
         self.ss.files.no_output = False
-        self.ss.UC.run(solver='SCIP')
+        self.ss.UC.run()
         self.assertTrue(self.ss.report())
         self.assertTrue(os.path.exists(self.expected_report))
 
@@ -208,12 +212,13 @@ class TestReport(unittest.TestCase):
         self.assertTrue(os.path.exists('pjm5bus_demo_UC.csv'))
         os.remove('pjm5bus_demo_UC.csv')
 
+    @skip_unittest_without_MISOCP
     def test_UCDG_report(self):
         """
         Test report with UCDG solved.
         """
         self.ss.files.no_output = False
-        self.ss.UCDG.run(solver='SCIP')
+        self.ss.UCDG.run()
         self.assertTrue(self.ss.report())
         self.assertTrue(os.path.exists(self.expected_report))
 
@@ -226,12 +231,13 @@ class TestReport(unittest.TestCase):
         self.assertTrue(os.path.exists('pjm5bus_demo_UCDG.csv'))
         os.remove('pjm5bus_demo_UCDG.csv')
 
+    @skip_unittest_without_MISOCP
     def test_UCES_report(self):
         """
         Test report with UCES solved.
         """
         self.ss.files.no_output = False
-        self.ss.UCES.run(solver='SCIP')
+        self.ss.UCES.run()
         self.assertTrue(self.ss.report())
         self.assertTrue(os.path.exists(self.expected_report))