virtualship package

Code for the Virtual Ship Classroom, where Marine Scientists can combine Copernicus Marine Data with an OceanParcels ship to go on a virtual expedition.

Subpackages

• virtualship.cli package
  • Submodules
  • virtualship.cli.commands module
  • virtualship.cli.main module
• virtualship.expedition package
  • InputData
    • InputData.adcp_fieldset
    • InputData.argo_float_fieldset
    • InputData.ctd_bgc_fieldset
    • InputData.ctd_fieldset
    • InputData.drifter_fieldset
    • InputData.load()
    • InputData.ship_underwater_st_fieldset
    • InputData.xbt_fieldset
  • do_expedition()
  • Submodules
  • virtualship.expedition.checkpoint module
    • Checkpoint
      • Checkpoint.from_yaml()
      • Checkpoint.model_config
      • Checkpoint.past_schedule
      • Checkpoint.to_yaml()
      • Checkpoint.verify()
  • virtualship.expedition.do_expedition module
    • do_expedition()
  • virtualship.expedition.expedition_cost module
    • expedition_cost()
  • virtualship.expedition.input_data module
    • InputData
      • InputData.adcp_fieldset
      • InputData.argo_float_fieldset
      • InputData.ctd_bgc_fieldset
      • InputData.ctd_fieldset
      • InputData.drifter_fieldset
      • InputData.load()
      • InputData.ship_underwater_st_fieldset
      • InputData.xbt_fieldset
  • virtualship.expedition.simulate_measurements module
    • simulate_measurements()
  • virtualship.expedition.simulate_schedule module
    • MeasurementsToSimulate
      • MeasurementsToSimulate.adcps
      • MeasurementsToSimulate.argo_floats
      • MeasurementsToSimulate.ctd_bgcs
      • MeasurementsToSimulate.ctds
      • MeasurementsToSimulate.drifters
      • MeasurementsToSimulate.ship_underwater_sts
      • MeasurementsToSimulate.xbts
    • ScheduleOk
      • ScheduleOk.measurements_to_simulate
      • ScheduleOk.time
    • ScheduleProblem
      • ScheduleProblem.failed_waypoint_i
      • ScheduleProblem.time
    • simulate_schedule()
• virtualship.instruments package
  • Submodules
  • virtualship.instruments.adcp module
    • simulate_adcp()
  • virtualship.instruments.argo_float module
    • ArgoFloat
      • ArgoFloat.cycle_days
      • ArgoFloat.drift_days
      • ArgoFloat.drift_depth
      • ArgoFloat.max_depth
      • ArgoFloat.min_depth
      • ArgoFloat.spacetime
      • ArgoFloat.vertical_speed
    • simulate_argo_floats()
  • virtualship.instruments.ctd module
    • CTD
      • CTD.max_depth
      • CTD.min_depth
      • CTD.spacetime
    • simulate_ctd()
  • virtualship.instruments.ctd_bgc module
    • CTD_BGC
      • CTD_BGC.max_depth
      • CTD_BGC.min_depth
      • CTD_BGC.spacetime
    • simulate_ctd_bgc()
  • virtualship.instruments.drifter module
    • Drifter
      • Drifter.depth
      • Drifter.lifetime
      • Drifter.spacetime
    • simulate_drifters()
  • virtualship.instruments.ship_underwater_st module
    • simulate_ship_underwater_st()
  • virtualship.instruments.xbt module
    • XBT
      • XBT.deceleration_coefficient
      • XBT.fall_speed
      • XBT.max_depth
      • XBT.min_depth
      • XBT.spacetime
    • simulate_xbt()
• virtualship.make_realistic package
  • adcp_make_realistic()
  • ctd_make_realistic()
  • Submodules
  • virtualship.make_realistic.adcp_make_realistic module
    • adcp_make_realistic()
  • virtualship.make_realistic.ctd_make_realistic module
    • ctd_make_realistic()
• virtualship.models package
  • ADCPConfig
    • ADCPConfig.max_depth_meter
    • ADCPConfig.model_config
    • ADCPConfig.num_bins
    • ADCPConfig.period
  • ArgoFloatConfig
    • ArgoFloatConfig.cycle_days
    • ArgoFloatConfig.drift_days
    • ArgoFloatConfig.drift_depth_meter
    • ArgoFloatConfig.max_depth_meter
    • ArgoFloatConfig.min_depth_meter
    • ArgoFloatConfig.model_config
    • ArgoFloatConfig.vertical_speed_meter_per_second
  • CTDConfig
    • CTDConfig.max_depth_meter
    • CTDConfig.min_depth_meter
    • CTDConfig.model_config
    • CTDConfig.stationkeeping_time
  • CTD_BGCConfig
    • CTD_BGCConfig.max_depth_meter
    • CTD_BGCConfig.min_depth_meter
    • CTD_BGCConfig.model_config
    • CTD_BGCConfig.stationkeeping_time
  • DrifterConfig
    • DrifterConfig.depth_meter
    • DrifterConfig.lifetime
    • DrifterConfig.model_config
  • InstrumentType
    • InstrumentType.ARGO_FLOAT
    • InstrumentType.CTD
    • InstrumentType.CTD_BGC
    • InstrumentType.DRIFTER
    • InstrumentType.XBT
  • Location
    • Location.lat
    • Location.latitude
    • Location.lon
    • Location.longitude
  • Schedule
    • Schedule.from_yaml()
    • Schedule.get_instruments()
    • Schedule.model_config
    • Schedule.space_time_region
    • Schedule.to_yaml()
    • Schedule.verify()
    • Schedule.waypoints
  • ShipConfig
    • ShipConfig.adcp_config
    • ShipConfig.argo_float_config
    • ShipConfig.ctd_bgc_config
    • ShipConfig.ctd_config
    • ShipConfig.drifter_config
    • ShipConfig.from_yaml()
    • ShipConfig.model_config
    • ShipConfig.ship_speed_knots
    • ShipConfig.ship_underwater_st_config
    • ShipConfig.to_yaml()
    • ShipConfig.verify()
    • ShipConfig.xbt_config
  • ShipUnderwaterSTConfig
    • ShipUnderwaterSTConfig.model_config
    • ShipUnderwaterSTConfig.period
  • SpaceTimeRegion
    • SpaceTimeRegion.model_config
    • SpaceTimeRegion.spatial_range
    • SpaceTimeRegion.time_range
  • Spacetime
    • Spacetime.location
    • Spacetime.time
  • SpatialRange
    • SpatialRange.maximum_depth
    • SpatialRange.maximum_latitude
    • SpatialRange.maximum_longitude
    • SpatialRange.minimum_depth
    • SpatialRange.minimum_latitude
    • SpatialRange.minimum_longitude
    • SpatialRange.model_config
  • TimeRange
    • TimeRange.end_time
    • TimeRange.model_config
    • TimeRange.start_time
  • Waypoint
    • Waypoint.instrument
    • Waypoint.location
    • Waypoint.model_config
    • Waypoint.serialize_instrument()
    • Waypoint.time
  • XBTConfig
    • XBTConfig.deceleration_coefficient
    • XBTConfig.fall_speed_meter_per_second
    • XBTConfig.max_depth_meter
    • XBTConfig.min_depth_meter
    • XBTConfig.model_config
  • Submodules
  • virtualship.models.location module
    • Location
      • Location.lat
      • Location.latitude
      • Location.lon
      • Location.longitude
  • virtualship.models.schedule module
    • Schedule
      • Schedule.from_yaml()
      • Schedule.get_instruments()
      • Schedule.model_config
      • Schedule.space_time_region
      • Schedule.to_yaml()
      • Schedule.verify()
      • Schedule.waypoints
    • Waypoint
      • Waypoint.instrument
      • Waypoint.location
      • Waypoint.model_config
      • Waypoint.serialize_instrument()
      • Waypoint.time
  • virtualship.models.ship_config module
    • ADCPConfig
      • ADCPConfig.max_depth_meter
      • ADCPConfig.model_config
      • ADCPConfig.num_bins
      • ADCPConfig.period
    • ArgoFloatConfig
      • ArgoFloatConfig.cycle_days
      • ArgoFloatConfig.drift_days
      • ArgoFloatConfig.drift_depth_meter
      • ArgoFloatConfig.max_depth_meter
      • ArgoFloatConfig.min_depth_meter
      • ArgoFloatConfig.model_config
      • ArgoFloatConfig.vertical_speed_meter_per_second
    • CTDConfig
      • CTDConfig.max_depth_meter
      • CTDConfig.min_depth_meter
      • CTDConfig.model_config
      • CTDConfig.stationkeeping_time
    • CTD_BGCConfig
      • CTD_BGCConfig.max_depth_meter
      • CTD_BGCConfig.min_depth_meter
      • CTD_BGCConfig.model_config
      • CTD_BGCConfig.stationkeeping_time
    • DrifterConfig
      • DrifterConfig.depth_meter
      • DrifterConfig.lifetime
      • DrifterConfig.model_config
    • InstrumentType
      • InstrumentType.ARGO_FLOAT
      • InstrumentType.CTD
      • InstrumentType.CTD_BGC
      • InstrumentType.DRIFTER
      • InstrumentType.XBT
    • ShipConfig
      • ShipConfig.adcp_config
      • ShipConfig.argo_float_config
      • ShipConfig.ctd_bgc_config
      • ShipConfig.ctd_config
      • ShipConfig.drifter_config
      • ShipConfig.from_yaml()
      • ShipConfig.model_config
      • ShipConfig.ship_speed_knots
      • ShipConfig.ship_underwater_st_config
      • ShipConfig.to_yaml()
      • ShipConfig.verify()
      • ShipConfig.xbt_config
    • ShipUnderwaterSTConfig
      • ShipUnderwaterSTConfig.model_config
      • ShipUnderwaterSTConfig.period
    • XBTConfig
      • XBTConfig.deceleration_coefficient
      • XBTConfig.fall_speed_meter_per_second
      • XBTConfig.max_depth_meter
      • XBTConfig.min_depth_meter
      • XBTConfig.model_config
  • virtualship.models.space_time_region module
    • SpaceTimeRegion
      • SpaceTimeRegion.model_config
      • SpaceTimeRegion.spatial_range
      • SpaceTimeRegion.time_range
    • SpatialRange
      • SpatialRange.maximum_depth
      • SpatialRange.maximum_latitude
      • SpatialRange.maximum_longitude
      • SpatialRange.minimum_depth
      • SpatialRange.minimum_latitude
      • SpatialRange.minimum_longitude
      • SpatialRange.model_config
    • TimeRange
      • TimeRange.end_time
      • TimeRange.model_config
      • TimeRange.start_time
  • virtualship.models.spacetime module
    • Spacetime
      • Spacetime.location
      • Spacetime.time
• virtualship.static package

Submodules

virtualship.errors module

exception virtualship.errors.CheckpointError

Bases: RuntimeError

An error in the checkpoint.

exception virtualship.errors.ConfigError

Bases: RuntimeError

An error in the config.

exception virtualship.errors.CredentialFileError

Bases: Exception

Exception raised for errors in the input file format.

exception virtualship.errors.IncompleteDownloadError

Bases: Exception

Exception raised for incomplete downloads.

exception virtualship.errors.ScheduleError

Bases: RuntimeError

An error in the schedule.

virtualship.utils module

virtualship.utils.get_example_config() → str

Get the example configuration file.

virtualship.utils.get_example_schedule() → str

Get the example schedule file.

virtualship.utils.load_coordinates(file_path)

Loads coordinates from a file based on its extension.

virtualship.utils.load_static_file(name: str) → str

Load static file from the virtualship.static module by file name.

virtualship.utils.mfp_to_yaml(coordinates_file_path: str, yaml_output_path: str)

Generates a YAML file with spatial and temporal information based on instrument data from MFP excel file.

Parameters:

• (str) (- excel_file_path)

• function (The)

• file. (1. Reads instrument and location data from the Excel)

• present. (2. Determines the maximum depth and buffer based on the instruments)

• adjustments. (3. Ensures longitude and latitude values remain valid after applying buffer)

• information. (4. returns the yaml)

virtualship.utils.validate_coordinates(coordinates_data)