pyconvexity 0.5.1.post1__tar.gz

pyconvexity-0.5.1.post1/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: pyconvexity
+Version: 0.5.1.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.5.1.post1/README.md

@@ -0,0 +1,100 @@
+# 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.5.1.post1/pyproject.toml

@@ -0,0 +1,93 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyconvexity"
+version = "0.5.1.post1"
+description = "Python library for energy system modeling and optimization with PyPSA"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Convexity Team", email = "info@convexity.com"}
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "pandas>=1.5.0",
+    "numpy>=1.21.0",
+    "pyarrow>=10.0.0",
+]
+
+[project.optional-dependencies]
+pypsa = [
+    "pypsa>=0.25.0",
+    "networkx",
+    "scipy",
+    "xarray",
+]
+excel = [
+    "openpyxl>=3.0.0",
+    "xlsxwriter>=3.0.0",
+]
+netcdf = [
+    "netcdf4>=1.6.0",
+    "xarray>=2022.3.0",
+]
+data = [
+    "country-converter>=1.0.0",
+    "pyyaml>=6.0.0",
+]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "black>=22.0.0",
+    "isort>=5.10.0",
+    "mypy>=1.0.0",
+    "pre-commit>=2.20.0",
+]
+all = [
+    "pyconvexity[pypsa,excel,netcdf,data]",
+]
+
+[project.urls]
+Homepage = "https://github.com/bayesian-energy/pyconvexity"
+Repository = "https://github.com/bayesian-energy/pyconvexity"
+Issues = "https://github.com/bayesian-energy/pyconvexity/issues"
+Documentation = "https://pyconvexity.readthedocs.io"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+
+[tool.setuptools.package-data]
+pyconvexity = ["data/**/*"]
+
+[tool.black]
+target-version = ['py39']
+
+[tool.isort]
+profile = "black"
+line_length = 88
+
+[tool.mypy]
+python_version = "0.5.1.post1"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]

pyconvexity-0.5.1.post1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyconvexity-0.5.1.post1/src/pyconvexity/__init__.py

@@ -0,0 +1,250 @@
+"""
+PyConvexity - Python library for energy system modeling and optimization.
+
+This library provides the core functionality of the Convexity desktop application
+as a reusable, pip-installable package for building and solving energy system models.
+"""
+
+# Version information
+from pyconvexity._version import __version__
+
+__author__ = "Convexity Team"
+
+# Core imports - always available
+from pyconvexity.core.errors import (
+    PyConvexityError,
+    DatabaseError,
+    ValidationError,
+    ComponentNotFound,
+    AttributeNotFound,
+)
+
+from pyconvexity.core.types import (
+    StaticValue,
+    Timeseries,
+    TimeseriesMetadata,
+    Component,
+    Network,
+    CreateNetworkRequest,
+    CreateComponentRequest,
+)
+
+from pyconvexity.core.database import (
+    create_database_with_schema,
+    database_context,
+    open_connection,
+    validate_database,
+    # Database maintenance functions
+    vacuum_database,
+    analyze_database,
+    optimize_database,
+    get_database_size_info,
+    should_optimize_database,
+)
+
+# Import main API functions
+from pyconvexity.models import (
+    # Component operations
+    get_component,
+    create_component,
+    update_component,
+    delete_component,
+    list_components_by_type,
+    list_component_attributes,
+    # Attribute operations
+    set_static_attribute,
+    set_timeseries_attribute,
+    get_attribute,
+    delete_attribute,
+    # Actual value operations
+    set_actual_static_value,
+    set_actual_timeseries_value,
+    get_actual_value,
+    clear_actual_value,
+    get_actual_scenario_id,
+    get_or_create_actual_scenario,
+    has_actual_value,
+    # Network operations
+    create_network,
+    get_network_info,
+    get_network_time_periods,
+    list_networks,
+    create_carrier,
+    list_carriers,
+    get_network_config,
+    set_network_config,
+    # Scenario operations
+    create_scenario,
+    list_scenarios,
+    get_scenario,
+    delete_scenario,
+)
+
+from pyconvexity.validation import (
+    get_validation_rule,
+    list_validation_rules,
+    validate_timeseries_alignment,
+)
+
+# High-level timeseries API - recommended for new code
+from pyconvexity.timeseries import (
+    get_timeseries,
+    set_timeseries,
+    get_timeseries_metadata,
+    get_multiple_timeseries,
+    timeseries_to_numpy,
+    numpy_to_timeseries,
+)
+
+# Dashboard configuration for Convexity app
+from pyconvexity.dashboard import (
+    DashboardConfig,
+    set_dashboard_config,
+    get_dashboard_config,
+    clear_dashboard_config,
+    auto_layout,
+)
+
+# High-level API functions
+__all__ = [
+    # Version info
+    "__version__",
+    "__author__",
+    # Core types
+    "StaticValue",
+    "Timeseries",
+    "TimeseriesMetadata",
+    "Component",
+    "Network",
+    "CreateNetworkRequest",
+    "CreateComponentRequest",
+    # Database operations
+    "create_database_with_schema",
+    "database_context",
+    "open_connection",
+    "validate_database",
+    # Database maintenance
+    "vacuum_database",
+    "analyze_database",
+    "optimize_database",
+    "get_database_size_info",
+    "should_optimize_database",
+    # Exceptions
+    "PyConvexityError",
+    "DatabaseError",
+    "ValidationError",
+    "ComponentNotFound",
+    "AttributeNotFound",
+    # Component operations
+    "get_component",
+    "create_component",
+    "update_component",
+    "delete_component",
+    "list_components_by_type",
+    "list_component_attributes",
+    # Attribute operations
+    "set_static_attribute",
+    "set_timeseries_attribute",
+    "get_attribute",
+    "delete_attribute",
+    # Actual value operations
+    "set_actual_static_value",
+    "set_actual_timeseries_value",
+    "get_actual_value",
+    "clear_actual_value",
+    "get_actual_scenario_id",
+    "get_or_create_actual_scenario",
+    "has_actual_value",
+    # Network operations
+    "create_network",
+    "get_network_info",
+    "get_network_time_periods",
+    "list_networks",
+    "create_carrier",
+    "list_carriers",
+    "get_network_config",
+    "set_network_config",
+    # Scenario operations
+    "create_scenario",
+    "list_scenarios",
+    "get_scenario",
+    "delete_scenario",
+    # Validation
+    "get_validation_rule",
+    "list_validation_rules",
+    "validate_timeseries_alignment",
+    # High-level timeseries API
+    "get_timeseries",
+    "set_timeseries",
+    "get_timeseries_metadata",
+    "get_multiple_timeseries",
+    "timeseries_to_numpy",
+    "numpy_to_timeseries",
+    # Dashboard configuration
+    "DashboardConfig",
+    "set_dashboard_config",
+    "get_dashboard_config",
+    "clear_dashboard_config",
+    "auto_layout",
+]
+
+# Data module imports
+try:
+    from pyconvexity import data
+
+    __all__.append("data")
+except ImportError:
+    # Data dependencies not available
+    pass
+
+# Optional imports with graceful fallbacks
+try:
+    from pyconvexity.solvers.pypsa import (
+        solve_network,
+        build_pypsa_network,
+        solve_pypsa_network,
+        load_network_components,
+        apply_constraints,
+        store_solve_results,
+    )
+
+    __all__.extend(
+        [
+            "solve_network",
+            "build_pypsa_network",
+            "solve_pypsa_network",
+            "load_network_components",
+            "apply_constraints",
+            "store_solve_results",
+        ]
+    )
+except ImportError:
+    # PyPSA not available
+    pass
+
+# Excel I/O functionality
+try:
+    from pyconvexity.io import ExcelModelExporter, ExcelModelImporter
+
+    __all__.extend(["ExcelModelExporter", "ExcelModelImporter"])
+except ImportError:
+    # Excel dependencies not available
+    pass
+
+
+try:
+    from pyconvexity.io import NetCDFModelExporter, NetCDFModelImporter
+
+    __all__.extend(["NetCDFModelExporter", "NetCDFModelImporter"])
+except ImportError:
+    # NetCDF dependencies not available
+    pass
+
+# Transformation operations
+try:
+    from pyconvexity.transformations import modify_time_axis
+
+    __all__.append("modify_time_axis")
+except ImportError:
+    # Transformation dependencies (pandas, numpy) not available
+    pass

pyconvexity-0.5.1.post1/src/pyconvexity/_version.py

@@ -0,0 +1 @@
+__version__ = "0.5.1.post1"

pyconvexity-0.5.1.post1/src/pyconvexity/core/__init__.py

@@ -0,0 +1,60 @@
+"""
+Core module for PyConvexity.
+
+Contains fundamental types, database operations, and error handling.
+"""
+
+from pyconvexity.core.errors import (
+    PyConvexityError,
+    DatabaseError,
+    ValidationError,
+    ComponentNotFound,
+    AttributeNotFound,
+    InvalidDataType,
+    TimeseriesError,
+)
+
+from pyconvexity.core.types import (
+    StaticValue,
+    AttributeValue,
+    ValidationRule,
+    Component,
+    Network,
+    TimePeriod,
+    TimeseriesValidationResult,
+    CreateComponentRequest,
+    CreateNetworkRequest,
+)
+
+from pyconvexity.core.database import (
+    DatabaseContext,
+    open_connection,
+    validate_database,
+    create_database_with_schema,
+)
+
+__all__ = [
+    # Errors
+    "PyConvexityError",
+    "DatabaseError",
+    "ValidationError",
+    "ComponentNotFound",
+    "AttributeNotFound",
+    "InvalidDataType",
+    "TimeseriesError",
+    # Types
+    "StaticValue",
+    "AttributeValue",
+    "ValidationRule",
+    "Component",
+    "Network",
+    "TimePeriod",
+    "TimeseriesValidationResult",
+    "CreateComponentRequest",
+    "CreateNetworkRequest",
+    # Database
+    "DatabaseContext",
+    "open_connection",
+    "validate_database",
+    "create_database_with_schema",
+]