Scenario Data Models#

pydantic model emerge.scenarios.data_model.CustomerModel#

Interface for representing customer used in pv scenario development.

field cust_type: str | None = None#

field distance: float [Required]#

field kw: float [Required]#

field name: str [Required]#

pydantic model emerge.scenarios.data_model.EnergyBasedSolarSizingStrategyInput#

Input model for default solar sizing strategy.

field capacity_factor: float = 0.3#

field load_factor: float = 0.33#

field max_pct_production: float = 100#

field profile: str [Required]#

pydantic model emerge.scenarios.data_model.SizeWithProbabilityModel#

Use this model if you want to pick sizes with probabilities.

field probabilites: List[float] | float [Required]#

field profile: List[str] | str [Required]#

field sizes: List[float] | float [Required]#

validator validate_lengths_are_same » all fields#

pydantic model emerge.scenarios.data_model.DERScenarioInput#

Input model for der scenarios.

field other_ders: List[_DERScenarioInput] [Required]#

field selection_strategy: SelectionStrategyEnum [Required]#

pydantic model emerge.scenarios.data_model.BasicDERModel#

Basic DER model used in solar scenario development.

field customer: CustomerModel [Required]#

field der_tag: str = ''#

field der_type: DERType [Required]#

field kw: float [Required]#

field name: str [Required]#

field profile: str [Required]#

pydantic model emerge.scenarios.data_model.DistDERScenarioModel#

Model for storing solars in a given scenario.

field ders: List[BasicDERModel] [Required]#

field name: str [Required]#

field penetration: float [Required]#

field sample_id: int [Required]#

pydantic model emerge.scenarios.data_model.LoadMetadataModel#

Interface for representing OpenDSS load metadata.

field bus: str [Required]#

field kv: float [Required]#

field name: str [Required]#

field num_phase: int [Required]#

field yearly: str | None = None#

pydantic model emerge.scenarios.data_model.DERScenarioInputModel#

Interface for der scenario input model.

field file_name: str [Required]#

field other_ders: List[_DERScenarioInput] [Required]#

field selection_strategy: SelectionStrategyEnum [Required]#

pydantic model emerge.scenarios.data_model.ScenarioBaseConfig#

Interface for basic settings in defining scenario.

field max_num_of_samples: int = 1#

field num_of_penetration: int [Required]#

field pct_resolution: float [Required]#: Percentage resolution or step resolution

pydantic model emerge.scenarios.data_model.DERScenarioConfigModel#

CLI interface model for generating solar scenarios.

field der_scenario: List[DERScenarioInputModel] [Required]#

field master_file: str [Required]#

field opendss_attr: Literal['yearly', 'class'] = 'class'#

field output_folder: str [Required]#