fidgate-sdk 1.14.0__py3-none-any.whl

fidgate_sdk/__init__.py

@@ -0,0 +1,188 @@
+"""FIDgate SDK — a standalone, curated public data-model surface.
+
+The SDK carries its own standalone copies of the data models and has no runtime
+dependency on the core library. Its runtime dependencies stay small — ``numpy``
+and ``pydantic`` for the models, ``httpx`` for the client, ``pyyaml`` for the
+config-document surface, and ``pyarrow`` to render the run's Parquet result
+tables to CSV in :meth:`FidgateClient.get_results`. The full set of public data
+models is exposed at the top level::
+
+    from fidgate_sdk import AssetConfigSchema, ProjectResult, ProjectSnapshot
+
+See ``fidgate_sdk.models`` for the categorised model modules and the
+"add a new model" convention in the package README.
+"""
+
+from fidgate_sdk import models
+from fidgate_sdk.models import *  # noqa: F401,F403
+
+__version__ = "1.14.0"  # x-release-please-version
+
+# Client surface is imported after ``__version__`` so the client can stamp it
+# into its User-Agent at import time without a circular-import hazard.
+from fidgate_sdk.builder import (  # noqa: E402
+    CostModel,
+    PriceCurve,
+    ProjectBuilder,
+    SiteMeteo,
+    absolute_cost,
+    annual_price_csv,
+    area_sizing,
+    as_produced_commitment,
+    baseload_commitment,
+    buyback_penalty,
+    cec_inverter,
+    cec_module,
+    composite_cost,
+    constant_price,
+    debt,
+    depreciation,
+    escalating_price,
+    fixed_mount,
+    generation_degradation,
+    global_availability,
+    hourly_da_price_csv,
+    linear_degradation,
+    maintenance_window,
+    maintenance_windows,
+    module_parameters,
+    monthly_profile_price,
+    per_mw_cost,
+    per_mwh_shortfall_penalty,
+    pvgis_tmy,
+    pvgis_tmy_meteo,
+    pvlib_generation,
+    quantity_arc,
+    quantity_expression,
+    quantity_reference,
+    sat_mount,
+    soh_curves_degradation,
+    span,
+    steps,
+    topology_sizing,
+    weather_csv_meteo,
+)
+from fidgate_sdk.client import FidgateClient  # noqa: E402
+from fidgate_sdk.config_document import ProjectConfig  # noqa: E402
+from fidgate_sdk.exceptions import (  # noqa: E402
+    AuthenticationError,
+    AuthorizationError,
+    ConfigValidationError,
+    ConflictError,
+    FidgateAPIError,
+    FidgateBuilderWarning,
+    FidgateConnectionError,
+    FidgateError,
+    OverrideValidationError,
+    PartialUploadError,
+    RateLimitError,
+    RequestValidationError,
+    ServiceUnavailableError,
+)
+from fidgate_sdk.overrides import (  # noqa: E402
+    Finding,
+    check_optimization,
+    count_scenarios,
+    override_problem,
+)
+from fidgate_sdk.presentation import ResponseList, ResponseModel  # noqa: E402
+from fidgate_sdk.projects import (  # noqa: E402
+    Project,
+    ProjectExport,
+    ProjectVersion,
+    S3File,
+    format_files,
+    format_projects,
+    format_results,
+    format_versions,
+)
+from fidgate_sdk.report import BuildReport  # noqa: E402
+from fidgate_sdk.responses import (  # noqa: E402
+    JobState,
+    RunJob,
+    RunResults,
+    SimulationJob,
+    SimulationStatus,
+)
+from fidgate_sdk.sweep import ParameterSweep, apply_override  # noqa: E402
+
+__all__ = [
+    *models.__all__,
+    "AuthenticationError",
+    "AuthorizationError",
+    "BuildReport",
+    "ConfigValidationError",
+    "ConflictError",
+    "CostModel",
+    "FidgateAPIError",
+    "FidgateBuilderWarning",
+    "FidgateClient",
+    "FidgateConnectionError",
+    "FidgateError",
+    "Finding",
+    "JobState",
+    "OverrideValidationError",
+    "ParameterSweep",
+    "PartialUploadError",
+    "PriceCurve",
+    "Project",
+    "ProjectBuilder",
+    "ProjectConfig",
+    "ProjectExport",
+    "ProjectVersion",
+    "RateLimitError",
+    "RequestValidationError",
+    "ResponseList",
+    "ResponseModel",
+    "RunJob",
+    "RunResults",
+    "S3File",
+    "ServiceUnavailableError",
+    "SimulationJob",
+    "SimulationStatus",
+    "SiteMeteo",
+    "absolute_cost",
+    "annual_price_csv",
+    "apply_override",
+    "area_sizing",
+    "as_produced_commitment",
+    "baseload_commitment",
+    "buyback_penalty",
+    "cec_inverter",
+    "cec_module",
+    "check_optimization",
+    "composite_cost",
+    "constant_price",
+    "count_scenarios",
+    "debt",
+    "depreciation",
+    "escalating_price",
+    "fixed_mount",
+    "format_files",
+    "format_projects",
+    "format_results",
+    "format_versions",
+    "generation_degradation",
+    "global_availability",
+    "hourly_da_price_csv",
+    "linear_degradation",
+    "maintenance_window",
+    "maintenance_windows",
+    "module_parameters",
+    "monthly_profile_price",
+    "override_problem",
+    "per_mw_cost",
+    "per_mwh_shortfall_penalty",
+    "pvgis_tmy",
+    "pvgis_tmy_meteo",
+    "pvlib_generation",
+    "quantity_arc",
+    "quantity_expression",
+    "quantity_reference",
+    "sat_mount",
+    "soh_curves_degradation",
+    "span",
+    "steps",
+    "topology_sizing",
+    "weather_csv_meteo",
+]