Index

_

_state (models.Boat attribute) (models.boat.Boat attribute) (models.Charger attribute) (models.charger.Charger attribute)

A

add_bess() (models.Port method) (models.port.Port method) add_boat() (models.Port method) (models.port.Port method) add_charger() (models.Port method) (models.port.Port method)

add_pv() (models.Port method) (models.port.Port method) assign_daily_trips() (simulation.trip_manager.TripManager method) azimuth (models.PV attribute), [1] (models.pv.PV attribute), [1]

B

BaseOptimizationResult (class in optimization) (class in optimization.base_optimizer) BaseOptimizer (class in optimization) (class in optimization.base_optimizer) BATCH (config.settings.SimulationMode attribute) (config.SimulationMode attribute) battery_capacity (models.Boat attribute), [1] (models.boat.Boat attribute), [1] BESS (class in models) (class in models.bess) bess_systems (models.Port attribute), [1] (models.port.Port attribute), [1] BESSControlStrategy (class in models) (class in models.bess)

Boat (class in models) (class in models.boat) boat_available (forecasting.EnergyForecast attribute), [1] (forecasting.port_forecaster.EnergyForecast attribute), [1] boat_required_energy_kwh (forecasting.EnergyForecast attribute), [1] (forecasting.port_forecaster.EnergyForecast attribute), [1] boat_schedules (optimization.base_optimizer.BaseOptimizationResult attribute) (optimization.BaseOptimizationResult attribute) boats (models.Port attribute), [1] (models.port.Port attribute), [1] BoatState (class in models) (class in models.boat)

C

calculate_production() (models.PV method) (models.pv.PV method) capacity (models.BESS attribute), [1] (models.bess.BESS attribute), [1] (models.PV attribute), [1] (models.pv.PV attribute), [1] charge() (models.BESS method) (models.bess.BESS method) Charger (class in models) (class in models.charger) charger_schedules (optimization.base_optimizer.BaseOptimizationResult attribute) (optimization.BaseOptimizationResult attribute) chargers (models.Port attribute), [1] (models.port.Port attribute), [1] ChargerState (class in models) (class in models.charger) CHARGING (models.boat.BoatState attribute) (models.BoatState attribute) (models.charger.ChargerState attribute) (models.ChargerState attribute) clear_caches() (database.DatabaseManager method) (database.db_manager.DatabaseManager method)

clear_records() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) close() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) config module config.settings module connect() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) connected_boat (models.Charger attribute), [1] (models.charger.Charger attribute), [1] contracted_power (models.Port attribute), [1] (models.port.Port attribute), [1] control_strategy (models.BESS attribute), [1] (models.bess.BESS attribute), [1] current_power (models.BESS attribute), [1] (models.bess.BESS attribute), [1] current_production (models.PV attribute), [1] (models.pv.PV attribute), [1] current_soc (models.BESS attribute), [1] (models.bess.BESS attribute), [1]

D

database module database.db_manager module DatabaseManager (class in database) (class in database.db_manager) db_path (config.Settings attribute), [1] (config.settings.Settings attribute), [1] DEFAULT (models.bess.BESSControlStrategy attribute) (models.BESSControlStrategy attribute)

delete_metric() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) delete_source() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) discharge() (models.BESS method) (models.bess.BESS method) duration (models.Trip attribute) (models.trip.Trip attribute)

E

effective_power (models.Charger property) (models.charger.Charger property) efficiency (models.BESS attribute), [1] (models.bess.BESS attribute), [1] (models.Charger attribute), [1] (models.charger.Charger attribute), [1]

EnergyForecast (class in forecasting) (class in forecasting.port_forecaster) estimate_energy_required() (models.Trip method) (models.trip.Trip method)

F

fetch_forecast() (weather.openmeteo.OpenMeteoClient method) (weather.OpenMeteoClient method) FORECAST_URL (weather.openmeteo.OpenMeteoClient attribute) (weather.OpenMeteoClient attribute)

forecasting module forecasting.port_forecaster module

G

generate_daily_forecast() (forecasting.port_forecaster.PortForecaster method) (forecasting.PortForecaster method) get_all_metrics() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) get_all_sources() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) get_available_charge_capacity() (models.BESS method) (models.bess.BESS method) get_available_energy() (models.BESS method) (models.bess.BESS method) get_connection() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) get_current_conditions() (weather.openmeteo.OpenMeteoClient method) (weather.OpenMeteoClient method) get_energy_between() (models.Trip method) (models.trip.Trip method) get_energy_stored() (models.BESS method) (models.bess.BESS method) get_max_charge_power_available() (models.BESS method) (models.bess.BESS method)

get_max_discharge_power_available() (models.BESS method) (models.bess.BESS method) get_metric() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) get_metric_id() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) get_or_create_source() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) get_point_at_elapsed_time() (models.Trip method) (models.trip.Trip method) get_records() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) get_source() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) get_tariff_price() (models.Port method) (models.port.Port method) get_trip_for_slot() (simulation.trip_manager.TripManager method) get_trips_for_date() (simulation.trip_manager.TripManager method)

H

heading (models.trip.TripPoint attribute), [1] (models.TripPoint attribute), [1]

HISTORICAL_URL (weather.openmeteo.OpenMeteoClient attribute) (weather.OpenMeteoClient attribute)

I

IDLE (models.boat.BoatState attribute) (models.BoatState attribute) (models.charger.ChargerState attribute) (models.ChargerState attribute) idle() (models.BESS method) (models.bess.BESS method)

initial_soc (models.BESS attribute), [1] (models.bess.BESS attribute), [1] initialize_default_metrics() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) initialize_schema() (database.DatabaseManager method) (database.db_manager.DatabaseManager method)

K

k (models.Boat property) (models.boat.Boat property)

L

lat (models.Port attribute), [1] (models.port.Port attribute), [1] latitude (models.PV attribute), [1] (models.pv.PV attribute), [1] (models.trip.TripPoint attribute), [1] (models.TripPoint attribute), [1] length (models.Boat attribute), [1] (models.boat.Boat attribute), [1]

lon (models.Port attribute), [1] (models.port.Port attribute), [1] longitude (models.PV attribute), [1] (models.pv.PV attribute), [1] (models.trip.TripPoint attribute), [1] (models.TripPoint attribute), [1]

M

main module main() (in module main) max_charge_power (models.BESS attribute), [1] (models.bess.BESS attribute), [1] max_discharge_power (models.BESS attribute), [1] (models.bess.BESS attribute), [1] max_power (models.Charger attribute), [1] (models.charger.Charger attribute), [1] mode (config.Settings attribute), [1] (config.settings.Settings attribute), [1] models module models.bess module models.boat module models.charger module models.port module models.pv module models.trip module

module config config.settings database database.db_manager forecasting forecasting.port_forecaster main models models.bess models.boat models.charger models.port models.pv models.trip optimization optimization.base_optimizer simulation simulation.engine simulation.trip_manager weather weather.openmeteo motor_power (models.Boat attribute), [1] (models.boat.Boat attribute), [1]

N

name (models.BESS attribute), [1] (models.bess.BESS attribute), [1] (models.Boat attribute), [1] (models.boat.Boat attribute), [1] (models.Charger attribute), [1] (models.charger.Charger attribute), [1] (models.Port attribute), [1] (models.port.Port attribute), [1] (models.PV attribute), [1] (models.pv.PV attribute), [1]

O

OpenMeteoClient (class in weather) (class in weather.openmeteo) optimization module

optimization.base_optimizer module optimize_daily_schedule() (optimization.base_optimizer.BaseOptimizer method) (optimization.BaseOptimizer method)

P

peak_power_kw (optimization.base_optimizer.BaseOptimizationResult attribute) (optimization.BaseOptimizationResult attribute) point_type (models.trip.TripPoint attribute), [1] (models.TripPoint attribute), [1] points (models.Trip attribute) (models.trip.Trip attribute), [1] Port (class in models) (class in models.port) PortForecaster (class in forecasting) (class in forecasting.port_forecaster) power (models.Charger attribute), [1] (models.charger.Charger attribute), [1]

power_active_production_kw (forecasting.EnergyForecast attribute), [1] (forecasting.port_forecaster.EnergyForecast attribute), [1] power_active_production_kw_by_source (forecasting.EnergyForecast attribute), [1] (forecasting.port_forecaster.EnergyForecast attribute), [1] power_limit_mode (config.Settings attribute), [1] (config.settings.Settings attribute), [1] print_forecast_summary() (forecasting.port_forecaster.PortForecaster method) (forecasting.PortForecaster method) PV (class in models) (class in models.pv) pv_systems (models.Port attribute), [1] (models.port.Port attribute), [1]

R

range_speed (models.Boat attribute), [1] (models.boat.Boat attribute), [1] REAL_TIME (config.settings.SimulationMode attribute) (config.SimulationMode attribute)

route_name (models.Trip attribute) (models.trip.Trip attribute) run() (simulation.engine.SimulationEngine method) (simulation.SimulationEngine method)

S

SAILING (models.boat.BoatState attribute) (models.BoatState attribute) save_forecasts_to_db() (forecasting.port_forecaster.PortForecaster method) (forecasting.PortForecaster method) save_metric() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) save_record() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) save_records_batch() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) save_schedules_to_db() (optimization.base_optimizer.BaseOptimizer method) (optimization.BaseOptimizer method) save_source() (database.DatabaseManager method) (database.db_manager.DatabaseManager method) Settings (class in config) (class in config.settings) simulation module simulation.engine module

simulation.trip_manager module SimulationEngine (class in simulation) (class in simulation.engine) SimulationMode (class in config) (class in config.settings) soc (models.Boat attribute), [1] (models.boat.Boat attribute), [1] soc_max (models.BESS attribute), [1] (models.bess.BESS attribute), [1] soc_min (models.BESS attribute), [1] (models.bess.BESS attribute), [1] speed (models.trip.TripPoint attribute), [1] (models.TripPoint attribute), [1] state (models.Boat property) (models.boat.Boat property) (models.Charger property) (models.charger.Charger property) status (optimization.base_optimizer.BaseOptimizationResult attribute) (optimization.BaseOptimizationResult attribute)

T

tariff (models.Port property) (models.port.Port property) tariff_path (models.Port attribute), [1] (models.port.Port attribute), [1] tilt (models.PV attribute), [1] (models.pv.PV attribute), [1] timestamp (forecasting.EnergyForecast attribute), [1] (forecasting.port_forecaster.EnergyForecast attribute), [1] (models.trip.TripPoint attribute), [1] (models.TripPoint attribute), [1] timestep (config.Settings attribute), [1] (config.settings.Settings attribute), [1]

total_cost (optimization.base_optimizer.BaseOptimizationResult attribute) (optimization.BaseOptimizationResult attribute) total_energy_kwh (optimization.base_optimizer.BaseOptimizationResult attribute) (optimization.BaseOptimizationResult attribute) Trip (class in models) (class in models.trip) trip_schedule (config.Settings attribute), [1] (config.settings.Settings attribute), [1] TripManager (class in simulation.trip_manager) TripPoint (class in models) (class in models.trip)

U

use_optimizer (config.Settings attribute), [1] (config.settings.Settings attribute), [1]

W

weather module weather.openmeteo module

weight (models.Boat attribute), [1] (models.boat.Boat attribute), [1]