API#
Caution
This project is in active development, and the Python API is subject to change. This documentation serves as reference for developers or those interested in the internals of the project. Pivate methods (i.e., preceding with an underscore) are not included here.
- virtualship package
LocationSpacetime- Subpackages
- virtualship.cli package
- virtualship.expedition package
ADCPConfigArgoFloatConfigCTDConfigCTD_BGCConfigDrifterConfigInputDataScheduleShipConfigShipConfig.adcp_configShipConfig.argo_float_configShipConfig.ctd_bgc_configShipConfig.ctd_configShipConfig.drifter_configShipConfig.from_yaml()ShipConfig.model_configShipConfig.ship_speed_knotsShipConfig.ship_underwater_st_configShipConfig.to_yaml()ShipConfig.verify()ShipConfig.xbt_config
ShipUnderwaterSTConfigSpaceTimeRegionWaypointdo_expedition()- Submodules
- virtualship.expedition.checkpoint module
- virtualship.expedition.do_expedition module
- virtualship.expedition.expedition_cost module
- virtualship.expedition.input_data module
- virtualship.expedition.schedule module
- virtualship.expedition.ship_config module
ADCPConfigArgoFloatConfigCTDConfigCTD_BGCConfigConfigErrorDrifterConfigInstrumentTypeShipConfigShipConfig.adcp_configShipConfig.argo_float_configShipConfig.ctd_bgc_configShipConfig.ctd_configShipConfig.drifter_configShipConfig.from_yaml()ShipConfig.model_configShipConfig.ship_speed_knotsShipConfig.ship_underwater_st_configShipConfig.to_yaml()ShipConfig.verify()ShipConfig.xbt_config
ShipUnderwaterSTConfigXBTConfig
- virtualship.expedition.simulate_measurements module
- virtualship.expedition.simulate_schedule module
- virtualship.expedition.space_time_region module
- virtualship.instruments package
- virtualship.make_realistic package
- virtualship.static package
- Submodules
- virtualship.location module
- virtualship.spacetime module
- virtualship.utils module