pyconvexity 0.1.0__tar.gz

pyconvexity-0.1.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: pyconvexity
+Version: 0.1.0
+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/convexity-js
+Project-URL: Repository, https://github.com/bayesian-energy/convexity-js
+Project-URL: Issues, https://github.com/bayesian-energy/convexity-js/issues
+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: 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[excel,netcdf,pypsa]; extra == "all"
+
+# PyConvexity
+
+**Energy system modeling library for optimization and analysis.**
+
+PyConvexity provides the core functionality of the [Convexity](https://github.com/bayesian-energy/convexity-js) desktop application as a reusable, pip-installable Python library.
+
+## Installation
+
+```bash
+pip install pyconvexity
+```
+
+## Quick Start
+
+```python
+import pyconvexity as px
+
+# Create a new energy system 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 Energy Network",
+        description="Example renewable energy system",
+        start_time="2024-01-01 00:00:00",
+        end_time="2024-01-02 00:00:00",
+        time_resolution="H"
+    )
+    network_id = px.create_network(conn, network_req)
+    
+    # Create carriers (energy types)
+    ac_carrier = px.create_carrier(conn, network_id, "AC")
+    
+    # Create components
+    bus_id = px.create_component(
+        conn, network_id, "BUS", "Main Bus",
+        latitude=40.7128, longitude=-74.0060,
+        carrier_id=ac_carrier
+    )
+    
+    # Set component attributes
+    px.set_static_attribute(conn, bus_id, "v_nom", px.StaticValue(230.0))
+    
+    conn.commit()
+
+print(f"✅ Created network {network_id} with bus {bus_id}")
+```
+
+## Features
+
+- **Database Management**: SQLite-based energy system model storage
+- **Component Modeling**: Buses, generators, loads, lines, storage, etc.
+- **Time Series Support**: Efficient storage and retrieval of temporal data
+- **Validation**: Built-in validation rules for energy system components
+- **PyPSA Integration**: Compatible with PyPSA energy system modeling
+- **Type Safety**: Full type hints and data validation
+
+## Core Concepts
+
+### Networks
+Energy system models organized as networks with time periods and carriers.
+
+### Components
+Physical and virtual elements: buses, generators, loads, transmission lines, storage units, etc.
+
+### Attributes
+Component properties that can be static values or time series data.
+
+### Scenarios
+Different parameter sets for the same network topology.
+
+## Documentation
+
+- **Full Documentation**: [Convexity Documentation](https://github.com/bayesian-energy/convexity-js)
+- **API Reference**: See docstrings in the code
+- **Examples**: Check the `examples/` directory
+
+## Development
+
+PyConvexity is developed as part of the [Convexity](https://github.com/bayesian-energy/convexity-js) project by [Bayesian Energy](https://bayesianenergy.com).
+
+## License
+
+MIT License - see [LICENSE](https://github.com/bayesian-energy/convexity-js/blob/main/LICENSE) file for details.
+
+## Related Projects
+
+- **[Convexity](https://github.com/bayesian-energy/convexity-js)**: Desktop application for energy system modeling
+- **[PyPSA](https://pypsa.org/)**: Python for Power System Analysis
+- **[Linopy](https://linopy.readthedocs.io/)**: Linear optimization with Python

pyconvexity-0.1.0/README.md

@@ -0,0 +1,91 @@
+# PyConvexity
+
+**Energy system modeling library for optimization and analysis.**
+
+PyConvexity provides the core functionality of the [Convexity](https://github.com/bayesian-energy/convexity-js) desktop application as a reusable, pip-installable Python library.
+
+## Installation
+
+```bash
+pip install pyconvexity
+```
+
+## Quick Start
+
+```python
+import pyconvexity as px
+
+# Create a new energy system 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 Energy Network",
+        description="Example renewable energy system",
+        start_time="2024-01-01 00:00:00",
+        end_time="2024-01-02 00:00:00",
+        time_resolution="H"
+    )
+    network_id = px.create_network(conn, network_req)
+    
+    # Create carriers (energy types)
+    ac_carrier = px.create_carrier(conn, network_id, "AC")
+    
+    # Create components
+    bus_id = px.create_component(
+        conn, network_id, "BUS", "Main Bus",
+        latitude=40.7128, longitude=-74.0060,
+        carrier_id=ac_carrier
+    )
+    
+    # Set component attributes
+    px.set_static_attribute(conn, bus_id, "v_nom", px.StaticValue(230.0))
+    
+    conn.commit()
+
+print(f"✅ Created network {network_id} with bus {bus_id}")
+```
+
+## Features
+
+- **Database Management**: SQLite-based energy system model storage
+- **Component Modeling**: Buses, generators, loads, lines, storage, etc.
+- **Time Series Support**: Efficient storage and retrieval of temporal data
+- **Validation**: Built-in validation rules for energy system components
+- **PyPSA Integration**: Compatible with PyPSA energy system modeling
+- **Type Safety**: Full type hints and data validation
+
+## Core Concepts
+
+### Networks
+Energy system models organized as networks with time periods and carriers.
+
+### Components
+Physical and virtual elements: buses, generators, loads, transmission lines, storage units, etc.
+
+### Attributes
+Component properties that can be static values or time series data.
+
+### Scenarios
+Different parameter sets for the same network topology.
+
+## Documentation
+
+- **Full Documentation**: [Convexity Documentation](https://github.com/bayesian-energy/convexity-js)
+- **API Reference**: See docstrings in the code
+- **Examples**: Check the `examples/` directory
+
+## Development
+
+PyConvexity is developed as part of the [Convexity](https://github.com/bayesian-energy/convexity-js) project by [Bayesian Energy](https://bayesianenergy.com).
+
+## License
+
+MIT License - see [LICENSE](https://github.com/bayesian-energy/convexity-js/blob/main/LICENSE) file for details.
+
+## Related Projects
+
+- **[Convexity](https://github.com/bayesian-energy/convexity-js)**: Desktop application for energy system modeling
+- **[PyPSA](https://pypsa.org/)**: Python for Power System Analysis
+- **[Linopy](https://linopy.readthedocs.io/)**: Linear optimization with Python

pyconvexity-0.1.0/pyproject.toml

@@ -0,0 +1,89 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyconvexity"
+version = "0.1.0"
+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",
+]
+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]",
+]
+
+[project.urls]
+Homepage = "https://github.com/bayesian-energy/convexity-js"
+Repository = "https://github.com/bayesian-energy/convexity-js"
+Issues = "https://github.com/bayesian-energy/convexity-js/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+
+[tool.setuptools.package-data]
+pyconvexity = ["data/**/*", "schema/**/*"]
+
+[tool.black]
+line-length = 100
+target-version = ['py39']
+
+[tool.isort]
+profile = "black"
+line_length = 100
+
+[tool.mypy]
+python_version = "3.9"
+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.1.0/setup.cfg

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

pyconvexity-0.1.0/src/pyconvexity/__init__.py

@@ -0,0 +1,120 @@
+"""
+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,
+    TimeseriesPoint,
+    Component,
+    Network,
+    CreateNetworkRequest,
+    CreateComponentRequest,
+)
+
+from pyconvexity.core.database import (
+    create_database_with_schema,
+    database_context,
+    open_connection,
+    validate_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,
+    
+    # Network operations
+    create_network, get_network_info, get_network_time_periods, list_networks,
+    create_carrier, list_carriers, get_network_config, set_network_config,
+    get_master_scenario_id, resolve_scenario_id,
+)
+
+from pyconvexity.validation import (
+    get_validation_rule, list_validation_rules, validate_timeseries_alignment
+)
+
+# High-level API functions
+__all__ = [
+    # Version info
+    "__version__",
+    "__author__",
+    
+    # Core types
+    "StaticValue",
+    "TimeseriesPoint", 
+    "Component",
+    "Network",
+    "CreateNetworkRequest",
+    "CreateComponentRequest",
+    
+    # Database operations
+    "create_database_with_schema",
+    "database_context", 
+    "open_connection",
+    "validate_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",
+    
+    # Network operations
+    "create_network", "get_network_info", "get_network_time_periods", "list_networks",
+    "create_carrier", "list_carriers", "get_network_config", "set_network_config",
+    "get_master_scenario_id", "resolve_scenario_id",
+    
+    # Validation
+    "get_validation_rule", "list_validation_rules", "validate_timeseries_alignment",
+]
+
+# Optional imports with graceful fallbacks
+try:
+    from pyconvexity.solvers.pypsa import PyPSASolver
+    __all__.append("PyPSASolver")
+except ImportError:
+    # PyPSA not available
+    pass
+
+try:
+    from pyconvexity.io.excel import ExcelImporter, ExcelExporter
+    __all__.extend(["ExcelImporter", "ExcelExporter"])
+except ImportError:
+    # Excel dependencies not available
+    pass
+
+try:
+    from pyconvexity.io.netcdf import NetCDFImporter, NetCDFExporter
+    __all__.extend(["NetCDFImporter", "NetCDFExporter"])
+except ImportError:
+    # NetCDF dependencies not available
+    pass

pyconvexity-0.1.0/src/pyconvexity/_version.py

@@ -0,0 +1,2 @@
+# This file is automatically updated by GitHub Actions during release
+__version__ = "0.1.0"  # Default version for local development

pyconvexity-0.1.0/src/pyconvexity/core/__init__.py

@@ -0,0 +1,64 @@
+"""
+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,
+    TimeseriesPoint,
+    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",
+    "TimeseriesPoint",
+    "AttributeValue", 
+    "ValidationRule",
+    "Component",
+    "Network",
+    "TimePeriod",
+    "TimeseriesValidationResult",
+    "CreateComponentRequest",
+    "CreateNetworkRequest",
+    
+    # Database
+    "DatabaseContext",
+    "open_connection",
+    "validate_database", 
+    "create_database_with_schema",
+]