site-calc-investment 1.2.0__py3-none-any.whl

site_calc_investment-1.2.0.dist-info/METADATA

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: site-calc-investment
+Version: 1.2.0
+Summary: Python client for Site-Calc investment planning (capacity sizing, ROI analysis)
+Project-URL: Homepage, https://github.com/stranma/site-calc-investment
+Project-URL: Documentation, https://github.com/stranma/site-calc-investment#readme
+Project-URL: Repository, https://github.com/stranma/site-calc-investment
+Project-URL: Issues, https://github.com/stranma/site-calc-investment/issues
+Author-email: Site-Calc Team <info@site-calc.example.com>
+License: MIT
+License-File: LICENSE
+Keywords: capacity-planning,energy,investment,npv,roi
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.24
+Requires-Dist: numpy>=1.24
+Requires-Dist: pydantic>=2.0
+Requires-Dist: python-dateutil>=2.8
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pandas>=2.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.2; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Requires-Dist: tzdata>=2024.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Site-Calc Investment Client
+
+Python client for Site-Calc investment planning API - long-term capacity planning and ROI analysis.
+
+## Installation
+
+```bash
+pip install site-calc-investment
+```
+
+## Quick Start
+
+```python
+from datetime import datetime
+from zoneinfo import ZoneInfo
+from site_calc_investment import InvestmentClient
+from site_calc_investment.models import (
+    TimeSpan, Resolution, Site, Battery, ElectricityImport,
+    InvestmentPlanningRequest, InvestmentParameters, OptimizationConfig
+)
+
+# Initialize client
+client = InvestmentClient(
+    base_url="https://api.site-calc.example.com",
+    api_key="inv_your_api_key_here"
+)
+
+# Create 10-year planning horizon (1-hour resolution)
+timespan = TimeSpan(
+    start=datetime(2025, 1, 1, tzinfo=ZoneInfo("Europe/Prague")),
+    intervals=87600,  # 10 years × 8760 hours/year
+    resolution=Resolution.HOUR_1
+)
+
+# Define devices (NO ancillary_services field)
+battery = Battery(
+    name="Battery1",
+    properties={
+        "capacity": 10.0,
+        "max_power": 5.0,
+        "efficiency": 0.90,
+        "initial_soc": 0.5
+    }
+)
+
+grid_import = ElectricityImport(
+    name="GridImport",
+    properties={"price": prices_10y, "max_import": 8.0}
+)
+
+site = Site(site_id="investment_site", devices=[battery, grid_import])
+
+# Investment parameters
+inv_params = InvestmentParameters(
+    discount_rate=0.05,
+    device_capital_costs={"Battery1": 500000},  # €500k CAPEX
+    device_annual_opex={"Battery1": 5000}       # €5k/year O&M
+)
+
+# Create and submit optimization request
+request = InvestmentPlanningRequest(
+    sites=[site],
+    timespan=timespan,
+    investment_parameters=inv_params,
+    optimization_config=OptimizationConfig(
+        objective="maximize_npv",
+        time_limit_seconds=3600
+    )
+)
+
+job = client.create_planning_job(request)
+result = client.wait_for_completion(job.job_id, poll_interval=30, timeout=7200)
+
+# Display investment metrics
+metrics = result.summary.investment_metrics
+print(f"NPV: €{metrics.npv:,.0f}")
+print(f"IRR: {metrics.irr*100:.2f}%")
+print(f"Payback: {metrics.payback_period_years:.1f} years")
+```
+
+## Features
+
+- ✅ Long-term capacity planning (1-10 years)
+- ✅ Investment ROI analysis (NPV, IRR, payback)
+- ✅ Scenario comparison utilities
+- ✅ Financial analysis helpers
+- ✅ 1-hour resolution optimization
+- ✅ Multi-site optimization
+- ✅ Type-safe Pydantic models
+- ✅ Automatic retry and error handling
+- ✅ Job management (cancel single or all jobs)
+
+## Capabilities
+
+| Feature | Value |
+|---------|-------|
+| Max Horizon | 100,000 intervals (~11 years at 1-hour) |
+| Resolution | 1-hour only |
+| ANS Support | No |
+| Binary Variables | Relaxed to continuous |
+| Timeout | 3600 seconds (1 hour) |
+
+## Supported Devices
+
+- Battery (NO ANS)
+- CHP - Combined Heat and Power (continuous operation)
+- Heat Accumulator
+- Photovoltaic
+- Heat Demand
+- Electricity Demand
+- Electricity Import/Export (market interface)
+- Gas Import (market interface)
+- Heat Export (market interface)
+
+## Job Management
+
+The client provides methods for managing optimization jobs:
+
+```python
+# Create a job
+job = client.create_planning_job(request)
+print(f"Job ID: {job.job_id}")
+
+# Check job status
+status = client.get_job_status(job.job_id)
+print(f"Status: {status.status}, Progress: {status.progress}%")
+
+# Wait for completion
+result = client.wait_for_completion(job.job_id, poll_interval=30, timeout=7200)
+
+# Cancel a single job
+cancelled = client.cancel_job(job.job_id)
+
+# Cancel all pending/running jobs (bulk cancel)
+result = client.cancel_all_jobs()
+print(f"Cancelled {result['cancelled_count']} jobs")
+```
+
+## Financial Analysis
+
+```python
+from site_calc_investment.analysis import (
+    calculate_npv,
+    calculate_irr,
+    calculate_payback_period,
+    compare_scenarios
+)
+
+# NPV calculation
+npv = calculate_npv(
+    cash_flows=annual_revenues,
+    discount_rate=0.05,
+    initial_investment=-1500000
+)
+
+# IRR calculation
+irr = calculate_irr([-1500000] + annual_revenues)
+
+# Scenario comparison
+comparison = compare_scenarios(
+    [result_5mw, result_10mw, result_15mw],
+    names=["5 MW", "10 MW", "15 MW"]
+)
+print(comparison)  # DataFrame with NPV, IRR, costs, revenues
+```
+
+## Documentation
+
+Full documentation available at: https://docs.site-calc.example.com/investment-client
+
+## Examples
+
+See `examples/` directory for complete examples:
+- `capacity_planning.py` - 10-year capacity planning workflow
+- `roi_analysis.py` - Investment ROI calculation
+- `scenario_comparison.py` - Compare device configurations
+
+## Requirements
+
+- Python ≥ 3.10
+- API key with `inv_` prefix (investment client)
+
+## Key Differences from Operational Client
+
+- ❌ No `/optimal-bidding` endpoint
+- ❌ No `ancillary_services` on devices
+- ❌ No 15-minute resolution (1-hour only)
+- ✅ Up to 100,000 intervals (vs. 296)
+- ✅ Investment metrics (NPV, IRR, payback)
+- ✅ Financial analysis helpers
+
+## Development
+
+```bash
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+ruff format .
+
+# Type check
+mypy site_calc_investment
+```
+
+## License
+
+MIT License
+
+## Support
+
+- Issues: https://github.com/stranma/site-calc-investment/issues
+- Documentation: https://github.com/stranma/site-calc-investment#readme
+
+---
+
+Part of the [Site-Calc](https://github.com/stranma/site-calc) platform.

site_calc_investment-1.2.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+site_calc_investment/__init__.py,sha256=V7A9Rf_xLhkx2jqzxcrowiI6n8nsEAmUXFknYVXjvZ4,2084
+site_calc_investment/exceptions.py,sha256=dz1wXM3Y4hHzK-PaQPY7sFPgLwUd6bZyWfJDVH9aBZk,2108
+site_calc_investment/analysis/__init__.py,sha256=u6nwlhY3gQnxn-nkUGc68ynmoBU7NUt3uoUuM9AfQIs,414
+site_calc_investment/analysis/comparison.py,sha256=3aqKpVcGy-2YfQZjS6qAzN12vuzvwDmE1JgZn6fuuIE,4487
+site_calc_investment/analysis/financial.py,sha256=gzKYmylGDKZDqx1ZBefZwJMS9NuflH5NYjnFm6Tyw0g,6361
+site_calc_investment/api/__init__.py,sha256=LmrMw5jO24beExGtcau7B34NnMkJUmDsHngEdzuCans,140
+site_calc_investment/api/client.py,sha256=Uh4yYPIC9oL1uiaaTe36xFeb5yfOsxkMetZojxRZoJs,15064
+site_calc_investment/models/__init__.py,sha256=aJsKxZGYe8AwsB7ZVrjRJs961iCd6KNKN5fpeYe52FY,1779
+site_calc_investment/models/common.py,sha256=r6Acg8uICJTETQ1FoVuBEdM8ThLQqwCVhclYO3kmCAY,5817
+site_calc_investment/models/devices.py,sha256=RmlbcxjavC3nFRyCJ6n8aUp2ZosVTpszmMmJfqpgd9c,9895
+site_calc_investment/models/requests.py,sha256=K3ESSgh3Qkq26jIL3TLTD6TRGmttVSiUUPTdbCmwRiw,5089
+site_calc_investment/models/responses.py,sha256=pmFfhSCAlCUZTxRDh0IdBn5znJiiFjF7U3LHZON_yQY,5482
+site_calc_investment-1.2.0.dist-info/METADATA,sha256=-HNe_BKFtvJ98IlTsXgZvGsCvLwR0RpIxycwe9n6a0w,6949
+site_calc_investment-1.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+site_calc_investment-1.2.0.dist-info/licenses/LICENSE,sha256=tmWogc4edAjn_ccDCKSLvMGW7asakJnAlQWuNqgApIs,1071
+site_calc_investment-1.2.0.dist-info/RECORD,,

site_calc_investment-1.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

site_calc_investment-1.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Site-Calc Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.