pyconvexity 0.4.3__py3-none-any.whl → 0.4.6.post1__py3-none-any.whl

pyconvexity-0.4.6.post1.dist-info/METADATA

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: pyconvexity
+Version: 0.4.6.post1
+Summary: Python library for energy system modeling and optimization with PyPSA
+Author-email: Convexity Team <info@convexity.com>
+License: MIT
+Project-URL: Homepage, https://github.com/bayesian-energy/pyconvexity
+Project-URL: Repository, https://github.com/bayesian-energy/pyconvexity
+Project-URL: Issues, https://github.com/bayesian-energy/pyconvexity/issues
+Project-URL: Documentation, https://pyconvexity.readthedocs.io
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=1.5.0
+Requires-Dist: numpy>=1.21.0
+Requires-Dist: pyarrow>=10.0.0
+Provides-Extra: pypsa
+Requires-Dist: pypsa>=0.25.0; extra == "pypsa"
+Requires-Dist: networkx; extra == "pypsa"
+Requires-Dist: scipy; extra == "pypsa"
+Requires-Dist: xarray; extra == "pypsa"
+Provides-Extra: excel
+Requires-Dist: openpyxl>=3.0.0; extra == "excel"
+Requires-Dist: xlsxwriter>=3.0.0; extra == "excel"
+Provides-Extra: netcdf
+Requires-Dist: netcdf4>=1.6.0; extra == "netcdf"
+Requires-Dist: xarray>=2022.3.0; extra == "netcdf"
+Provides-Extra: data
+Requires-Dist: country-converter>=1.0.0; extra == "data"
+Requires-Dist: pyyaml>=6.0.0; extra == "data"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.10.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: pre-commit>=2.20.0; extra == "dev"
+Provides-Extra: all
+Requires-Dist: pyconvexity[data,excel,netcdf,pypsa]; extra == "all"
+
+# pyconvexity
+
+Python library for energy system modeling and optimization with PyPSA.
+
+[![PyPI version](https://badge.fury.io/py/pyconvexity.svg)](https://badge.fury.io/py/pyconvexity)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Overview
+
+pyconvexity is the Python library that powers [Convexity](https://bayesian.energy/convexity), providing programmatic access to energy system modeling and optimization. It stores models in SQLite databases and integrates with PyPSA for solving.
+
+## Installation
+
+```bash
+pip install pyconvexity
+```
+
+With optional dependencies:
+
+```bash
+pip install pyconvexity[pypsa]     # PyPSA solver integration
+pip install pyconvexity[excel]     # Excel import/export
+pip install pyconvexity[all]       # All optional dependencies
+```
+
+## Quick Start
+
+```python
+import pyconvexity as px
+
+# Create a new model database
+px.create_database_with_schema("my_model.db")
+
+# Create a network
+with px.database_context("my_model.db") as conn:
+    network_req = px.CreateNetworkRequest(
+        name="My Network",
+        start_time="2024-01-01 00:00:00",
+        end_time="2024-01-01 23:00:00",
+        time_resolution="PT1H",
+    )
+    px.create_network(conn, network_req)
+    
+    # Create components
+    carrier_id = px.create_carrier(conn, name="AC")
+    bus_id = px.create_component(conn, "BUS", "Main Bus", carrier_id=carrier_id)
+    
+    conn.commit()
+
+# Solve the network
+result = px.solve_network("my_model.db", solver_name="highs")
+print(f"Success: {result['success']}, Objective: {result['objective_value']}")
+```
+
+## Documentation
+
+Full documentation is available at: **[docs.bayesian.energy](https://docs.bayesian.energy/convexity/user-guide/advanced-features/pyconvexity/)**
+
+- [API Reference](https://docs.bayesian.energy/convexity/user-guide/advanced-features/pyconvexity/api/api-reference)
+- [Examples & Tutorials](https://docs.bayesian.energy/convexity/user-guide/advanced-features/pyconvexity/examples/example-1/)
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/bayesian-energy/pyconvexity.git
+cd pyconvexity
+pip install -e ".[dev,all]"
+```
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Documentation Deployment
+
+API documentation is auto-generated and synced to [bayesian-docs](https://github.com/bayesian-energy/bayesian-docs).
+
+**Generate API docs locally:**
+
+```bash
+python scripts/generate_api_docs.py --output-dir api-docs
+```
+
+**How it works:**
+1. On push to `main` or release, the `sync-docs.yml` workflow runs
+2. It generates API markdown from Python docstrings
+3. Commits the generated docs to the `bayesian-docs` repository
+
+**Setup for maintainers:**
+- Add `DOCS_DEPLOY_TOKEN` secret to the repo (personal access token with `repo` scope for bayesian-docs)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+

{pyconvexity-0.4.3.dist-info → pyconvexity-0.4.6.post1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 pyconvexity/__init__.py,sha256=TJvgkEaMHFFWhIGaOdjMgc4rHVIxHKni3Ggg1YAQziE,5347
-pyconvexity/_version.py,sha256=Nyg0pmk5ea9-SLCAFEIF96ByFx4-TJFtrqYPN-Zn6g4,22
+pyconvexity/_version.py,sha256=mb7cZWFtBTYPgotnX_1oAZadFITLHrAXwTSs2Eb1dvU,28
 pyconvexity/timeseries.py,sha256=QdKbiqjAlxkJATyKm2Kelx1Ea2PsAnnCYfVLU5VER1Y,11085
 pyconvexity/core/__init__.py,sha256=gdyyHNqOc4h9Nfe9u6NA936GNzH6coGNCMgBvvvOnGE,1196
 pyconvexity/core/database.py,sha256=vwCmuN0B0xwImh6L0bFR4vNWHw_wVfYSG1KwsUjK4iY,14831
@@ -11,14 +11,14 @@ pyconvexity/data/loaders/__init__.py,sha256=6xPtOmH2n1mNby7ZjA-2Mk9F48Q246RNsyMn
 pyconvexity/data/loaders/cache.py,sha256=R-DUIiFpphjyi5EitcUZwzwUdZeqN6poYVyuNpKzB4g,7040
 pyconvexity/data/schema/01_core_schema.sql,sha256=xCCxUl65IGYxaMxAbgZVS7jVceRUJ_wOMw5c7cm6_Ww,16903
 pyconvexity/data/schema/02_data_metadata.sql,sha256=BbpTkH1s7IbZQkDBRF2kL_UR9tzMEWDBYS3VBkwDRu0,4323
-pyconvexity/data/schema/03_validation_data.sql,sha256=bxadwwN9Om0KYwRo3lXom33TJI5cg4n2n_X0rpK2CoA,88454
+pyconvexity/data/schema/03_validation_data.sql,sha256=Y4iZ1RzqMzeaBWalecT6BRd8I3MSW5nclXJI3cE_JAQ,88663
 pyconvexity/data/sources/__init__.py,sha256=Dn6_oS7wB-vLjMj2YeXlmIl6hNjACbicimSabKxIWnc,108
 pyconvexity/data/sources/gem.py,sha256=v8OYCMsb2t-8u-YmK8vzMsgI9ArUAOAXMZZQOFpJ-nI,14923
 pyconvexity/io/__init__.py,sha256=FCyvRDfBUrrNei-y5JVod6MMN1bkPMSSfE0fpKi1aKQ,751
 pyconvexity/io/excel_exporter.py,sha256=9MkZAVnHvsJSmfZ12w29GhDTsYI89fCGphjdo7s_ABs,50506
 pyconvexity/io/excel_importer.py,sha256=Q5petB0WXjbw0TIR4ofG3EkjdT8lBh21yJMbEgdtXfU,59347
-pyconvexity/io/netcdf_exporter.py,sha256=9EUPvDSYR7RxYDfOBT7O9clpC9F4sIj1RaNayvOmb5I,7119
-pyconvexity/io/netcdf_importer.py,sha256=WATZutznl7uMfcbi7957qxdP5NRQs3c1dV6mhBJotdc,70783
+pyconvexity/io/netcdf_exporter.py,sha256=ndbYa_b34LZQ-70Y7KXh3oLpATnARLciQHXKNpcjNoY,6828
+pyconvexity/io/netcdf_importer.py,sha256=JtdfIp48F_fQIlRgWJ3XaeeqtvQRa_FeE4hjVaA623I,67189
 pyconvexity/models/__init__.py,sha256=WqDSq1Mst7iJsFytausruoM562FKlOKV0Egmnpm2900,4695
 pyconvexity/models/attributes.py,sha256=RpH3rBoHD33xBSXUEfaD-CvRj3JruolCwexo6HPMGC8,23388
 pyconvexity/models/carriers.py,sha256=L_WuDMW13k8aaA-obsDPxjmpZgZELiIAZuNtxq7YLpg,3447
@@ -28,15 +28,15 @@ pyconvexity/models/results.py,sha256=6j1H4AwVmp94L97gl_sGnE8izMxkU5o89guKIU8JdtE
 pyconvexity/models/scenarios.py,sha256=-0UPUDXf6r9mFriA-z2fD5KKMARm2PUBjLba49S9mCI,5867
 pyconvexity/solvers/__init__.py,sha256=t1gOUTqbYDCtIvKPqGVY1fjKwqJi2Od9bGeIO7bPvJE,667
 pyconvexity/solvers/pypsa/__init__.py,sha256=nudu0AOYEfPhpGHZ1Q9pUgjGeeIJd_zeULc975iyluE,555
-pyconvexity/solvers/pypsa/api.py,sha256=OXGfVsv76HIXMJ4b_5LSiWW1OL5Xiq5EnUzaArTuaTI,18196
-pyconvexity/solvers/pypsa/batch_loader.py,sha256=w525_lqanKtARKgicajhBiDwIJzkaU_HbkL1I82gDqg,12361
-pyconvexity/solvers/pypsa/builder.py,sha256=SOr77SmDCYKNxfb-wGHYRX5A0M7zdv_E2Sjyf82uS6Y,24208
+pyconvexity/solvers/pypsa/api.py,sha256=CWKslptTlZrSbuHy916_PHhCG8nO9SCfjTXkJZylLM8,17512
+pyconvexity/solvers/pypsa/batch_loader.py,sha256=ZgOcZqMnMS3TOYTq2Ly2O4cuwhNNAicu3EDq1Fj38OI,11929
+pyconvexity/solvers/pypsa/builder.py,sha256=1ZU68Wtl_jQSXHzspKQDkR6bxAVU1nKvPfnPUl0aO3k,23256
 pyconvexity/solvers/pypsa/constraints.py,sha256=20WliFDhPQGMAsS4VOTU8LZJpsFpLVRHpNsZW49GTcc,16397
-pyconvexity/solvers/pypsa/solver.py,sha256=oXX2kqU9AWg8GgsMOV0fYqv93XjIk8Kh-fKWbQSzaig,63239
-pyconvexity/solvers/pypsa/storage.py,sha256=9edLe46f62jvpai1mNQEKypV77L26VyFdvKgQLCEA3o,94635
+pyconvexity/solvers/pypsa/solver.py,sha256=M-s-VUCnRD8Jdh22PCUA-gWgYp1eH6_sgpoSzcv6kNQ,59762
+pyconvexity/solvers/pypsa/storage.py,sha256=C8zLPXSd95LT0Aq6c00vZu1xlJHEF_l8RDUhB-s5mJ0,91704
 pyconvexity/validation/__init__.py,sha256=VJNZlFoWABsWwUKktNk2jbtXIepH5omvC0WtsTS7o3o,583
 pyconvexity/validation/rules.py,sha256=GiNadc8hvbWBr09vUkGiLLTmSdvtNSeGLFwvCjlikYY,9241
-pyconvexity-0.4.3.dist-info/METADATA,sha256=DJM9jC54RdzhfgEOaDQh0gdg6zqg3KS_89qcZIIT7TY,2013
-pyconvexity-0.4.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pyconvexity-0.4.3.dist-info/top_level.txt,sha256=wFPEDXVaebR3JO5Tt3HNse-ws5aROCcxEco15d6j64s,12
-pyconvexity-0.4.3.dist-info/RECORD,,
+pyconvexity-0.4.6.post1.dist-info/METADATA,sha256=42uMFhx4muAr2ZyGYa00osp9K_ifn5l14814yYyHkis,4973
+pyconvexity-0.4.6.post1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyconvexity-0.4.6.post1.dist-info/top_level.txt,sha256=wFPEDXVaebR3JO5Tt3HNse-ws5aROCcxEco15d6j64s,12
+pyconvexity-0.4.6.post1.dist-info/RECORD,,

pyconvexity-0.4.3.dist-info/METADATA

@@ -1,47 +0,0 @@
-Metadata-Version: 2.4
-Name: pyconvexity
-Version: 0.4.3
-Summary: Python library for energy system modeling and optimization with PyPSA
-Author-email: Convexity Team <info@convexity.com>
-License: MIT
-Project-URL: Homepage, https://github.com/bayesian-energy/pyconvexity
-Project-URL: Repository, https://github.com/bayesian-energy/pyconvexity
-Project-URL: Issues, https://github.com/bayesian-energy/pyconvexity/issues
-Project-URL: Documentation, https://pyconvexity.readthedocs.io
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: pandas>=1.5.0
-Requires-Dist: numpy>=1.21.0
-Requires-Dist: pyarrow>=10.0.0
-Provides-Extra: pypsa
-Requires-Dist: pypsa>=0.25.0; extra == "pypsa"
-Requires-Dist: networkx; extra == "pypsa"
-Requires-Dist: scipy; extra == "pypsa"
-Requires-Dist: xarray; extra == "pypsa"
-Provides-Extra: excel
-Requires-Dist: openpyxl>=3.0.0; extra == "excel"
-Requires-Dist: xlsxwriter>=3.0.0; extra == "excel"
-Provides-Extra: netcdf
-Requires-Dist: netcdf4>=1.6.0; extra == "netcdf"
-Requires-Dist: xarray>=2022.3.0; extra == "netcdf"
-Provides-Extra: data
-Requires-Dist: country-converter>=1.0.0; extra == "data"
-Requires-Dist: pyyaml>=6.0.0; extra == "data"
-Provides-Extra: dev
-Requires-Dist: pytest>=7.0.0; extra == "dev"
-Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
-Requires-Dist: black>=22.0.0; extra == "dev"
-Requires-Dist: isort>=5.10.0; extra == "dev"
-Requires-Dist: mypy>=1.0.0; extra == "dev"
-Requires-Dist: pre-commit>=2.20.0; extra == "dev"
-Provides-Extra: all
-Requires-Dist: pyconvexity[data,excel,netcdf,pypsa]; extra == "all"