API Reference

assetra UML Class Diagram

Open full-size diagram in a new tab

Modules

• assetra.unit
  • EnergyUnit
    • EnergyUnit.to_unit_dataset()
    • EnergyUnit.from_unit_dataset()
    • EnergyUnit.get_probabilistic_capacity_matrix()
  • StaticUnit
    • StaticUnit.to_unit_dataset()
    • StaticUnit.from_unit_dataset()
    • StaticUnit.get_probabilistic_capacity_matrix()
  • StochasticUnit
    • StochasticUnit.to_unit_dataset()
    • StochasticUnit.from_unit_dataset()
    • StochasticUnit.get_probabilistic_capacity_matrix()
  • StorageUnit
    • StorageUnit.to_unit_dataset()
    • StorageUnit.from_unit_dataset()
    • StorageUnit.get_probabilistic_capacity_matrix()
  • DemandUnit
  • HydroUnit
    • HydroUnit.to_unit_dataset()
    • HydroUnit.from_unit_dataset()
    • HydroUnit.get_probabilistic_capacity_matrix()
• assetra.system
  • EnergySystem
    • EnergySystem.size
    • EnergySystem.system_capacity
    • EnergySystem.unit_datasets
    • EnergySystem.get_system_by_type()
    • EnergySystem.save()
    • EnergySystem.load()
  • EnergySystemBuilder
    • EnergySystemBuilder.energy_units
    • EnergySystemBuilder.size
    • EnergySystemBuilder.add_unit()
    • EnergySystemBuilder.remove_unit()
    • EnergySystemBuilder.build()
    • EnergySystemBuilder.from_energy_system()
• assetra.simulation
  • ProbabilisticSimulation
    • ProbabilisticSimulation.copy()
    • ProbabilisticSimulation.assign_energy_system()
    • ProbabilisticSimulation.net_hourly_capacity_matrix
    • ProbabilisticSimulation.get_hourly_capacity_matrix_by_type()
    • ProbabilisticSimulation.run()
• assetra.metrics
  • ResourceAdequacyMetric
    • ResourceAdequacyMetric.evaluate()
  • ExpectedUnservedEnergy
    • ExpectedUnservedEnergy.evaluate()
  • LossOfLoadHours
    • LossOfLoadHours.evaluate()
  • LossOfLoadDays
    • LossOfLoadDays.evaluate()
  • LossOfLoadFrequency
    • LossOfLoadFrequency.evaluate()
• assetra.contribution
  • ResourceContributionMetric
    • ResourceContributionMetric.evaluate()
  • EffectiveLoadCarryingCapability
    • EffectiveLoadCarryingCapability.original_net_capacity_matrix
    • EffectiveLoadCarryingCapability.intermediate_net_capacity_matrices
    • EffectiveLoadCarryingCapability.evaluate()
• assetra.utils
  • get_hourly_time_series_xr()