API Reference

Complete API documentation for pyconvexity.

Installation

pip install pyconvexity

Quick Import

import pyconvexity as px

API Sections

• Database Operations - Functions for creating and managing database connections.
• Network Operations - Functions for creating and managing networks and time periods.
• Component Operations - Functions for creating and managing network components (buses, generators, loads, etc.).
• Attribute Operations - Functions for setting and retrieving component attributes.
• Carrier Operations - Functions for managing energy carriers.
• Scenario Operations - Functions for managing scenarios.
• Timeseries Operations - High-level functions for working with time series data.
• Solving - Functions for building and solving optimization models.
• Types & Exceptions - Core data types and exception classes.