CruisePlan v0.3.5
User Guide
Quick Start
Workflows
YAML Basics
Reference
CLI Commands
YAML Configuration Reference
Output Formats
Advanced
API Examples
CruisePlan Demo
CruisePlan Developer Guide
Manual Testing and Verification
Development Workflow Integration
API Reference
CruisePlan v0.3.5
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
_
__bool__() (cruiseplan.api.types.BaseResult method)
__init__() (cruiseplan.api.stations_api.StationPickerResult method)
(cruiseplan.api.types.StationPickerResult method)
(cruiseplan.data.bathymetry.BathymetryManager method)
(cruiseplan.data.pangaea.PangaeaManager method)
(cruiseplan.interactive.campaign_selector.CampaignSelector method)
(cruiseplan.interactive.widgets.ModeIndicator method)
(cruiseplan.interactive.widgets.StatusDisplay method)
(cruiseplan.output.csv_generator.CSVGenerator method)
(cruiseplan.output.html_generator.HTMLGenerator method)
(cruiseplan.output.kml_generator.KMLGenerator method)
(cruiseplan.runtime.cruise.CruiseInstance method)
(cruiseplan.runtime.operations.AreaOperation method)
(cruiseplan.runtime.operations.BaseOperation method)
(cruiseplan.runtime.operations.LineOperation method)
(cruiseplan.runtime.operations.PointOperation method)
(cruiseplan.runtime.organizational.Cluster method)
(cruiseplan.runtime.organizational.Leg method)
(cruiseplan.timeline.scheduler.ActivityRecord method)
(cruiseplan.utils.cache.CacheManager method)
__post_init__() (cruiseplan.timeline.scheduler.OperationCoordinates method)
__repr__() (cruiseplan.runtime.organizational.Cluster method)
(cruiseplan.runtime.organizational.Leg method)
__str__() (cruiseplan.api.stations_api.StationPickerResult method)
(cruiseplan.api.types.BaseResult method)
(cruiseplan.api.types.StationPickerResult method)
(cruiseplan.runtime.organizational.Cluster method)
(cruiseplan.runtime.organizational.Leg method)
_dataset (cruiseplan.data.bathymetry.BathymetryManager attribute)
_is_mock (cruiseplan.data.bathymetry.BathymetryManager attribute)
_lats (cruiseplan.data.bathymetry.BathymetryManager attribute)
_lons (cruiseplan.data.bathymetry.BathymetryManager attribute)
A
action (cruiseplan.config.activities.AreaDefinition attribute)
,
[1]
(cruiseplan.config.activities.LineDefinition attribute)
,
[1]
(cruiseplan.config.activities.PointDefinition attribute)
,
[1]
(cruiseplan.runtime.operations.PointOperation attribute)
(cruiseplan.timeline.scheduler.ActivityRecord attribute)
ActionEnum (class in cruiseplan.config.values)
activities (cruiseplan.config.cruise_config.ClusterDefinition attribute)
,
[1]
(cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
activity (cruiseplan.timeline.scheduler.ActivityRecord attribute)
ActivityRecord (class in cruiseplan.timeline.scheduler)
ADCP (cruiseplan.config.values.ActionEnum attribute)
add_cluster() (cruiseplan.runtime.organizational.Leg method)
add_coordinate_displays() (cruiseplan.runtime.cruise.CruiseInstance method)
(in module cruiseplan.runtime.enrichment)
add_custom_port() (in module cruiseplan.config.ports)
add_error() (cruiseplan.api.types.BaseResult method)
add_file() (cruiseplan.api.types.BaseResult method)
add_operation() (cruiseplan.runtime.organizational.Cluster method)
(cruiseplan.runtime.organizational.Leg method)
add_station_defaults() (cruiseplan.runtime.cruise.CruiseInstance method)
(in module cruiseplan.runtime.enrichment)
add_warning() (cruiseplan.api.types.BaseResult method)
allows_reordering() (cruiseplan.runtime.organizational.BaseOrganizationUnit method)
(cruiseplan.runtime.organizational.Cluster method)
(cruiseplan.runtime.organizational.Leg method)
area_km2 (cruiseplan.runtime.operations.AreaOperation attribute)
area_registry (cruiseplan.runtime.cruise.CruiseInstance attribute)
AreaDefinition (class in cruiseplan.config.activities)
AreaOperation (class in cruiseplan.runtime.operations)
AreaOperationTypeEnum (class in cruiseplan.config.values)
areas (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
arrival_port (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
(cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Leg attribute)
ax (cruiseplan.interactive.widgets.ModeIndicator attribute)
(cruiseplan.interactive.widgets.StatusDisplay attribute)
ax_campaign (cruiseplan.interactive.campaign_selector.CampaignSelector attribute)
B
BaseOperation (class in cruiseplan.runtime.operations)
BaseOrganizationUnit (class in cruiseplan.runtime.organizational)
BaseResult (class in cruiseplan.api.types)
BATHYMETRY (cruiseplan.config.values.ActionEnum attribute)
bathymetry() (in module cruiseplan.api)
(in module cruiseplan.api.data)
bathymetry_with_config() (in module cruiseplan.api)
(in module cruiseplan.api.data)
BathymetryError
BathymetryManager (class in cruiseplan.data.bathymetry)
BathymetryResult (class in cruiseplan.api.types)
boundary_polygon (cruiseplan.runtime.operations.AreaOperation attribute)
buffer_time (cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
C
cache (cruiseplan.data.pangaea.PangaeaManager attribute)
cache_dir (cruiseplan.utils.cache.CacheManager attribute)
CacheManager (class in cruiseplan.utils.cache)
calculate_ctd_time() (cruiseplan.timeline.duration.DurationCalculator method)
calculate_duration() (cruiseplan.runtime.operations.AreaOperation method)
(cruiseplan.runtime.operations.BaseOperation method)
(cruiseplan.runtime.operations.LineOperation method)
(cruiseplan.runtime.operations.PointOperation method)
(cruiseplan.timeline.scheduler.NavigationalTransit method)
calculate_map_bounds() (in module cruiseplan.utils.coordinates)
calculate_optimal_figsize() (in module cruiseplan.output.map_generator)
calculate_route_distance() (in module cruiseplan.timeline.routing)
calculate_timeline_statistics() (in module cruiseplan.timeline.scheduler)
calculate_total_duration() (cruiseplan.runtime.organizational.Cluster method)
calculate_total_duration_legacy() (cruiseplan.runtime.organizational.Leg method)
calculate_transit_time() (cruiseplan.timeline.duration.DurationCalculator method)
calculate_wait_time() (cruiseplan.timeline.duration.DurationCalculator method)
CALIBRATION (cruiseplan.config.values.ActionEnum attribute)
(cruiseplan.config.values.OperationTypeEnum attribute)
callbacks (cruiseplan.interactive.widgets.ModeIndicator attribute)
campaign_artists (cruiseplan.interactive.campaign_selector.CampaignSelector attribute)
campaign_data (cruiseplan.interactive.campaign_selector.CampaignSelector attribute)
CampaignSelector (class in cruiseplan.interactive.campaign_selector)
cf_conventions (cruiseplan.output.netcdf_generator.NetCDFGenerator attribute)
check_bathymetry_availability() (in module cruiseplan.data.bathymetry)
check_buttons (cruiseplan.interactive.campaign_selector.CampaignSelector attribute)
check_matplotlib_available() (in module cruiseplan.utils.plot_config)
clear() (cruiseplan.utils.cache.CacheManager method)
close() (cruiseplan.data.bathymetry.BathymetryManager method)
Cluster (class in cruiseplan.runtime.organizational)
ClusterDefinition (class in cruiseplan.config.cruise_config)
clusters (cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Leg attribute)
colors (cruiseplan.interactive.widgets.ModeIndicator attribute)
comment (cruiseplan.config.activities.AreaDefinition attribute)
,
[1]
(cruiseplan.config.activities.LineDefinition attribute)
,
[1]
(cruiseplan.config.activities.PointDefinition attribute)
,
[1]
(cruiseplan.runtime.operations.BaseOperation attribute)
compute_final_limits() (in module cruiseplan.utils.coordinates)
config (cruiseplan.runtime.cruise.CruiseInstance attribute)
(cruiseplan.timeline.duration.DurationCalculator attribute)
config_path (cruiseplan.runtime.cruise.CruiseInstance attribute)
configure_logging() (in module cruiseplan.utils.logging)
CoordConverter (class in cruiseplan.utils.coordinates)
corners (cruiseplan.config.activities.AreaDefinition attribute)
,
[1]
create_bathymetry_colormap() (in module cruiseplan.utils.plot_config)
create_coordinate_variables() (in module cruiseplan.output.netcdf_metadata)
create_global_attributes() (in module cruiseplan.output.netcdf_metadata)
create_map() (cruiseplan.data.pangaea.PangaeaManager method)
create_operation() (cruiseplan.timeline.scheduler.OperationFactory method)
create_operation_variables() (in module cruiseplan.output.netcdf_metadata)
cruise_name (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
CruiseConfig (class in cruiseplan.config.cruise_config)
CruiseInstance (class in cruiseplan.runtime.cruise)
cruiseplan.api
module
cruiseplan.api.data
module
cruiseplan.api.init_utils
module
cruiseplan.api.map_cruise
module
cruiseplan.api.process_cruise
module
cruiseplan.api.schedule_cruise
module
cruiseplan.api.stations_api
module
cruiseplan.api.types
module
cruiseplan.cli
module
cruiseplan.cli.bathymetry
module
cruiseplan.cli.enrich
module
cruiseplan.cli.main
module
cruiseplan.cli.map
module
cruiseplan.cli.pangaea
module
cruiseplan.cli.process
module
cruiseplan.cli.schedule
module
cruiseplan.cli.stations
module
cruiseplan.cli.validate
module
cruiseplan.config
module
cruiseplan.config.activities
module
cruiseplan.config.cruise_config
module
cruiseplan.config.exceptions
module
cruiseplan.config.fields
module
cruiseplan.config.ports
module
cruiseplan.config.values
module
cruiseplan.config.yaml_io
module
cruiseplan.data
module
cruiseplan.data.bathymetry
module
cruiseplan.data.pangaea
module
cruiseplan.interactive
module
cruiseplan.interactive.campaign_selector
module
cruiseplan.interactive.widgets
module
cruiseplan.output
module
cruiseplan.output.csv_generator
module
cruiseplan.output.html_generator
module
cruiseplan.output.kml_generator
module
cruiseplan.output.map_generator
module
cruiseplan.output.netcdf_generator
module
cruiseplan.output.netcdf_metadata
module
cruiseplan.runtime
module
cruiseplan.runtime.cruise
module
cruiseplan.runtime.enrichment
module
cruiseplan.runtime.operations
module
cruiseplan.runtime.organizational
module
cruiseplan.runtime.serialization
module
cruiseplan.timeline
module
cruiseplan.timeline.distance
module
cruiseplan.timeline.duration
module
cruiseplan.timeline.routing
module
cruiseplan.timeline.scheduler
module
cruiseplan.utils
module
cruiseplan.utils.cache
module
cruiseplan.utils.coordinates
module
cruiseplan.utils.io
module
cruiseplan.utils.logging
module
cruiseplan.utils.plot_config
module
cruiseplan.utils.units
module
CSVGenerator (class in cruiseplan.output.csv_generator)
CTD (cruiseplan.config.values.LineOperationTypeEnum attribute)
(cruiseplan.config.values.OperationTypeEnum attribute)
ctd_ascent_rate (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
ctd_descent_rate (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
current_mode (cruiseplan.interactive.widgets.ModeIndicator attribute)
D
data_dir (cruiseplan.data.bathymetry.BathymetryManager attribute)
day_end_hour (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
(cruiseplan.timeline.duration.DurationCalculator attribute)
DAY_NIGHT_SPLIT (cruiseplan.config.values.StrategyEnum attribute)
day_start_hour (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
(cruiseplan.timeline.duration.DurationCalculator attribute)
decimal_degrees_to_ddm() (cruiseplan.utils.coordinates.CoordConverter static method)
DEFAULT (cruiseplan.config.values.AreaOperationTypeEnum attribute)
(cruiseplan.config.values.LineOperationTypeEnum attribute)
(cruiseplan.config.values.OperationTypeEnum attribute)
DEFAULT_AREA (cruiseplan.config.values.ActionEnum attribute)
default_distance_between_stations (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
DEFAULT_LINE (cruiseplan.config.values.ActionEnum attribute)
DEFAULT_POINT (cruiseplan.config.values.ActionEnum attribute)
default_vessel_speed (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
delay_end (cruiseplan.config.activities.PointDefinition attribute)
,
[1]
delay_start (cruiseplan.config.activities.PointDefinition attribute)
,
[1]
DEMOB (cruiseplan.config.values.ActionEnum attribute)
departure_port (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
(cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Leg attribute)
DEPLOYMENT (cruiseplan.config.values.ActionEnum attribute)
depth (cruiseplan.runtime.operations.PointOperation attribute)
derive_area_operations() (cruiseplan.output.netcdf_generator.NetCDFGenerator method)
derive_line_operations() (cruiseplan.output.netcdf_generator.NetCDFGenerator method)
derive_point_operations() (cruiseplan.output.netcdf_generator.NetCDFGenerator method)
description (cruiseplan.config.cruise_config.ClusterDefinition attribute)
,
[1]
(cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
(cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Cluster attribute)
(cruiseplan.runtime.organizational.Leg attribute)
deserialize_inline_definition() (in module cruiseplan.runtime.serialization)
determine_bathymetry_source() (in module cruiseplan.data.bathymetry)
determine_coordinate_bounds() (in module cruiseplan.api.stations_api)
determine_workflow_mode() (in module cruiseplan.cli.pangaea)
dict_to_yaml_string() (in module cruiseplan.config.yaml_io)
display_name (cruiseplan.config.activities.PointDefinition attribute)
,
[1]
dist_nm (cruiseplan.timeline.scheduler.ActivityRecord attribute)
distance_between_stations (cruiseplan.config.activities.LineDefinition attribute)
(cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Leg attribute)
download_bathymetry() (in module cruiseplan.data.bathymetry)
dump_yaml_simple() (in module cruiseplan.config.yaml_io)
duration (cruiseplan.config.activities.AreaDefinition attribute)
,
[1]
(cruiseplan.config.activities.PointDefinition attribute)
,
[1]
(cruiseplan.runtime.operations.AreaOperation attribute)
duration_minutes (cruiseplan.timeline.scheduler.ActivityRecord attribute)
DurationCalculator (class in cruiseplan.timeline.duration)
E
end_point (cruiseplan.runtime.operations.AreaOperation attribute)
end_time (cruiseplan.timeline.scheduler.ActivityRecord attribute)
enrich() (in module cruiseplan.api)
(in module cruiseplan.api.process_cruise)
enrich_configuration() (in module cruiseplan.api.process_cruise)
enrich_depths() (cruiseplan.runtime.cruise.CruiseInstance method)
(in module cruiseplan.runtime.enrichment)
enrich_main() (in module cruiseplan.cli.main)
enrich_with_config() (in module cruiseplan.api)
(in module cruiseplan.api.process_cruise)
EnrichResult (class in cruiseplan.api.types)
ensure_gebco_2025() (cruiseplan.data.bathymetry.BathymetryManager method)
entry (cruiseplan.timeline.scheduler.OperationCoordinates attribute)
entry_lat (cruiseplan.timeline.scheduler.ActivityRecord attribute)
entry_lon (cruiseplan.timeline.scheduler.ActivityRecord attribute)
equipment (cruiseplan.config.activities.PointDefinition attribute)
,
[1]
exit (cruiseplan.timeline.scheduler.OperationCoordinates attribute)
exit_lat (cruiseplan.timeline.scheduler.ActivityRecord attribute)
exit_lon (cruiseplan.timeline.scheduler.ActivityRecord attribute)
expand_ports() (cruiseplan.runtime.cruise.CruiseInstance method)
(in module cruiseplan.runtime.enrichment)
expand_sections() (cruiseplan.runtime.cruise.CruiseInstance method)
(in module cruiseplan.runtime.enrichment)
extract_areas_from_cruise() (in module cruiseplan.output.map_generator)
extract_areas_from_timeline() (in module cruiseplan.output.map_generator)
extract_coordinates_from_cruise() (in module cruiseplan.utils.coordinates)
extract_lines_from_cruise() (in module cruiseplan.output.map_generator)
extract_lines_from_timeline() (in module cruiseplan.output.map_generator)
extract_map_data() (in module cruiseplan.output.map_generator)
extract_points_from_cruise() (in module cruiseplan.output.map_generator)
extract_points_from_timeline() (in module cruiseplan.output.map_generator)
F
fetch_datasets() (cruiseplan.data.pangaea.PangaeaManager method)
FileError
files_count (cruiseplan.api.types.BaseResult property)
first_activity (cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Leg attribute)
FlexibleLocationModel (class in cruiseplan.config.activities)
format_ddm_comment() (in module cruiseplan.utils.coordinates)
format_position_latex() (in module cruiseplan.utils.coordinates)
from_definition() (cruiseplan.runtime.organizational.Cluster class method)
(cruiseplan.runtime.organizational.Leg class method)
from_dict() (cruiseplan.runtime.cruise.CruiseInstance class method)
from_port() (cruiseplan.runtime.operations.PointOperation class method)
from_pydantic() (cruiseplan.runtime.operations.AreaOperation class method)
(cruiseplan.runtime.operations.LineOperation class method)
(cruiseplan.runtime.operations.PointOperation class method)
G
generate_all_netcdf_outputs() (cruiseplan.output.netcdf_generator.NetCDFGenerator method)
generate_area_operations() (cruiseplan.output.netcdf_generator.NetCDFGenerator method)
generate_cruise_schedule() (in module cruiseplan.timeline.scheduler)
generate_csv_format() (in module cruiseplan.api.init_utils)
generate_csv_schedule() (in module cruiseplan.output.csv_generator)
generate_folium_map() (in module cruiseplan.output.map_generator)
generate_html_format() (in module cruiseplan.api.init_utils)
generate_html_schedule() (in module cruiseplan.output.html_generator)
generate_kml_catalog() (in module cruiseplan.output.kml_generator)
generate_kml_schedule() (in module cruiseplan.output.kml_generator)
generate_latex_format() (in module cruiseplan.api.init_utils)
generate_line_operations() (cruiseplan.output.netcdf_generator.NetCDFGenerator method)
generate_map() (in module cruiseplan.output.map_generator)
generate_map_from_timeline() (in module cruiseplan.output.map_generator)
generate_map_from_yaml() (in module cruiseplan.output.map_generator)
generate_master_schedule() (cruiseplan.output.netcdf_generator.NetCDFGenerator method)
generate_netcdf_format() (in module cruiseplan.api.init_utils)
generate_netcdf_outputs() (in module cruiseplan.output.netcdf_generator)
generate_output_filename() (in module cruiseplan.utils.io)
generate_png_format() (in module cruiseplan.api.init_utils)
generate_point_operations() (cruiseplan.output.netcdf_generator.NetCDFGenerator method)
generate_schedule_csv() (cruiseplan.output.csv_generator.CSVGenerator method)
generate_schedule_kml() (cruiseplan.output.kml_generator.KMLGenerator method)
generate_schedule_report() (cruiseplan.output.html_generator.HTMLGenerator method)
generate_ship_schedule() (cruiseplan.output.netcdf_generator.NetCDFGenerator method)
generate_specialized_netcdf() (in module cruiseplan.api.init_utils)
generate_timeline() (cruiseplan.timeline.scheduler.TimelineGenerator method)
(in module cruiseplan.timeline)
(in module cruiseplan.timeline.scheduler)
GeoPoint (class in cruiseplan.config.activities)
get() (cruiseplan.utils.cache.CacheManager method)
get_all_clusters() (cruiseplan.runtime.organizational.Leg method)
get_all_operations() (cruiseplan.runtime.organizational.BaseOrganizationUnit method)
(cruiseplan.runtime.organizational.Cluster method)
(cruiseplan.runtime.organizational.Leg method)
get_available_ports() (in module cruiseplan.config.ports)
get_bathymetry_singleton() (in module cruiseplan.data.bathymetry)
get_boundary_waypoints() (cruiseplan.runtime.organizational.Leg method)
get_colormap() (in module cruiseplan.utils.plot_config)
get_coordinates() (cruiseplan.runtime.operations.BaseOperation method)
get_ddm_comment() (cruiseplan.config.activities.PointDefinition method)
get_depth() (cruiseplan.runtime.operations.PointOperation method)
get_depth_at_point() (cruiseplan.data.bathymetry.BathymetryManager method)
get_entry_point() (cruiseplan.runtime.operations.AreaOperation method)
(cruiseplan.runtime.operations.BaseOperation method)
(cruiseplan.runtime.operations.LineOperation method)
(cruiseplan.runtime.operations.PointOperation method)
(cruiseplan.runtime.organizational.BaseOrganizationUnit method)
(cruiseplan.runtime.organizational.Cluster method)
(cruiseplan.runtime.organizational.Leg method)
(cruiseplan.timeline.scheduler.NavigationalTransit method)
get_exit_point() (cruiseplan.runtime.operations.AreaOperation method)
(cruiseplan.runtime.operations.BaseOperation method)
(cruiseplan.runtime.operations.LineOperation method)
(cruiseplan.runtime.operations.PointOperation method)
(cruiseplan.runtime.organizational.BaseOrganizationUnit method)
(cruiseplan.runtime.organizational.Cluster method)
(cruiseplan.runtime.organizational.Leg method)
(cruiseplan.timeline.scheduler.NavigationalTransit method)
get_grid_subset() (cruiseplan.data.bathymetry.BathymetryManager method)
get_label() (cruiseplan.runtime.operations.BaseOperation method)
get_legend_entries() (in module cruiseplan.utils.plot_config)
get_logger() (in module cruiseplan.utils.logging)
get_operation() (cruiseplan.runtime.organizational.Cluster method)
get_operation_count() (cruiseplan.runtime.organizational.BaseOrganizationUnit method)
(cruiseplan.runtime.organizational.Cluster method)
(cruiseplan.runtime.organizational.Leg method)
get_operation_distance_nm() (cruiseplan.runtime.operations.LineOperation method)
(cruiseplan.timeline.scheduler.NavigationalTransit method)
get_operation_names() (cruiseplan.runtime.organizational.Cluster method)
get_operation_type() (cruiseplan.runtime.operations.BaseOperation method)
(cruiseplan.runtime.operations.PointOperation method)
(cruiseplan.timeline.scheduler.NavigationalTransit method)
get_operational_entry_point() (cruiseplan.runtime.organizational.Leg method)
get_operational_exit_point() (cruiseplan.runtime.organizational.Leg method)
get_plot_style() (in module cruiseplan.utils.plot_config)
get_port_positions() (cruiseplan.runtime.organizational.Leg method)
get_selected_campaigns() (cruiseplan.interactive.campaign_selector.CampaignSelector method)
get_station_spacing() (cruiseplan.runtime.organizational.Leg method)
get_turnaround_time() (cruiseplan.runtime.organizational.Leg method)
get_variable_attributes() (in module cruiseplan.output.netcdf_metadata)
get_vessel_speed() (cruiseplan.runtime.organizational.Leg method)
(cruiseplan.timeline.scheduler.NavigationalTransit method)
H
has_issues (cruiseplan.api.types.BaseResult property)
haversine_distance() (in module cruiseplan.timeline.distance)
hours_to_days() (in module cruiseplan.utils.units)
hours_to_minutes() (in module cruiseplan.utils.units)
HTMLGenerator (class in cruiseplan.output.html_generator)
I
interpolate_great_circle_position() (in module cruiseplan.utils.plot_config)
is_empty() (cruiseplan.runtime.organizational.Cluster method)
is_same_port_leg() (cruiseplan.runtime.organizational.Leg method)
K
km_to_nm() (in module cruiseplan.utils.units)
KMLGenerator (class in cruiseplan.output.kml_generator)
L
label (cruiseplan.timeline.scheduler.ActivityRecord attribute)
last_activity (cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Leg attribute)
latitude (cruiseplan.config.activities.FlexibleLocationModel attribute)
,
[1]
(cruiseplan.config.activities.GeoPoint attribute)
,
[1]
Leg (class in cruiseplan.runtime.organizational)
leg_name (cruiseplan.timeline.scheduler.ActivityRecord attribute)
LegDefinition (class in cruiseplan.config.cruise_config)
legs (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
line_registry (cruiseplan.runtime.cruise.CruiseInstance attribute)
LineDefinition (class in cruiseplan.config.activities)
LineOperation (class in cruiseplan.runtime.operations)
LineOperationTypeEnum (class in cruiseplan.config.values)
lines (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
list_ports_in_region() (in module cruiseplan.config.ports)
load_campaign_data() (in module cruiseplan.data.pangaea)
load_pangaea_campaign_data() (in module cruiseplan.api.stations_api)
load_yaml() (in module cruiseplan.config.yaml_io)
load_yaml_safe() (in module cruiseplan.config.yaml_io)
longitude (cruiseplan.config.activities.FlexibleLocationModel attribute)
,
[1]
(cruiseplan.config.activities.GeoPoint attribute)
,
[1]
M
main() (in module cruiseplan.cli.bathymetry)
(in module cruiseplan.cli.enrich)
(in module cruiseplan.cli.main)
(in module cruiseplan.cli.map)
(in module cruiseplan.cli.pangaea)
(in module cruiseplan.cli.process)
(in module cruiseplan.cli.schedule)
(in module cruiseplan.cli.stations)
(in module cruiseplan.cli.validate)
manual_duration (cruiseplan.runtime.operations.PointOperation attribute)
map() (in module cruiseplan.api)
(in module cruiseplan.api.map_cruise)
map_ax (cruiseplan.interactive.campaign_selector.CampaignSelector attribute)
map_with_config() (in module cruiseplan.api)
(in module cruiseplan.api.map_cruise)
MapResult (class in cruiseplan.api.types)
max_depth (cruiseplan.config.activities.LineDefinition attribute)
merge_campaign_tracks() (in module cruiseplan.data.pangaea)
MICROSTRUCTURE (cruiseplan.config.values.ActionEnum attribute)
minutes_to_days() (in module cruiseplan.utils.units)
minutes_to_hours() (in module cruiseplan.utils.units)
MOB (cruiseplan.config.values.ActionEnum attribute)
ModeIndicator (class in cruiseplan.interactive.widgets)
model_config (cruiseplan.config.activities.AreaDefinition attribute)
(cruiseplan.config.activities.FlexibleLocationModel attribute)
(cruiseplan.config.activities.GeoPoint attribute)
(cruiseplan.config.activities.LineDefinition attribute)
(cruiseplan.config.activities.PointDefinition attribute)
(cruiseplan.config.cruise_config.ClusterDefinition attribute)
(cruiseplan.config.cruise_config.CruiseConfig attribute)
(cruiseplan.config.cruise_config.LegDefinition attribute)
modes (cruiseplan.interactive.widgets.ModeIndicator attribute)
module
cruiseplan.api
cruiseplan.api.data
cruiseplan.api.init_utils
cruiseplan.api.map_cruise
cruiseplan.api.process_cruise
cruiseplan.api.schedule_cruise
cruiseplan.api.stations_api
cruiseplan.api.types
cruiseplan.cli
cruiseplan.cli.bathymetry
cruiseplan.cli.enrich
cruiseplan.cli.main
cruiseplan.cli.map
cruiseplan.cli.pangaea
cruiseplan.cli.process
cruiseplan.cli.schedule
cruiseplan.cli.stations
cruiseplan.cli.validate
cruiseplan.config
cruiseplan.config.activities
cruiseplan.config.cruise_config
cruiseplan.config.exceptions
cruiseplan.config.fields
cruiseplan.config.ports
cruiseplan.config.values
cruiseplan.config.yaml_io
cruiseplan.data
cruiseplan.data.bathymetry
cruiseplan.data.pangaea
cruiseplan.interactive
cruiseplan.interactive.campaign_selector
cruiseplan.interactive.widgets
cruiseplan.output
cruiseplan.output.csv_generator
cruiseplan.output.html_generator
cruiseplan.output.kml_generator
cruiseplan.output.map_generator
cruiseplan.output.netcdf_generator
cruiseplan.output.netcdf_metadata
cruiseplan.runtime
cruiseplan.runtime.cruise
cruiseplan.runtime.enrichment
cruiseplan.runtime.operations
cruiseplan.runtime.organizational
cruiseplan.runtime.serialization
cruiseplan.timeline
cruiseplan.timeline.distance
cruiseplan.timeline.duration
cruiseplan.timeline.routing
cruiseplan.timeline.scheduler
cruiseplan.utils
cruiseplan.utils.cache
cruiseplan.utils.coordinates
cruiseplan.utils.io
cruiseplan.utils.logging
cruiseplan.utils.plot_config
cruiseplan.utils.units
MOORING (cruiseplan.config.values.OperationTypeEnum attribute)
N
name (cruiseplan.config.activities.AreaDefinition attribute)
,
[1]
(cruiseplan.config.activities.LineDefinition attribute)
,
[1]
(cruiseplan.config.activities.PointDefinition attribute)
,
[1]
(cruiseplan.config.cruise_config.ClusterDefinition attribute)
,
[1]
(cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.operations.BaseOperation attribute)
(cruiseplan.runtime.organizational.Cluster attribute)
(cruiseplan.runtime.organizational.Leg attribute)
NavigationalTransit (class in cruiseplan.timeline.scheduler)
NetCDFGenerator (class in cruiseplan.output.netcdf_generator)
nm_to_km() (in module cruiseplan.utils.units)
normalize_operation_type() (cruiseplan.config.activities.PointDefinition class method)
O
on_mode_change() (cruiseplan.interactive.widgets.ModeIndicator method)
op_type (cruiseplan.runtime.operations.PointOperation attribute)
(cruiseplan.timeline.scheduler.ActivityRecord attribute)
operation_class (cruiseplan.timeline.scheduler.ActivityRecord attribute)
operation_depth (cruiseplan.config.activities.PointDefinition attribute)
,
[1]
(cruiseplan.timeline.scheduler.ActivityRecord attribute)
operation_type (cruiseplan.config.activities.AreaDefinition attribute)
,
[1]
(cruiseplan.config.activities.LineDefinition attribute)
,
[1]
(cruiseplan.config.activities.PointDefinition attribute)
,
[1]
OperationCoordinates (class in cruiseplan.timeline.scheduler)
OperationFactory (class in cruiseplan.timeline.scheduler)
operations (cruiseplan.runtime.organizational.Cluster attribute)
(cruiseplan.runtime.organizational.Leg attribute)
OperationTypeEnum (class in cruiseplan.config.values)
optimize_composite_route() (in module cruiseplan.timeline.routing)
ordered (cruiseplan.config.cruise_config.ClusterDefinition attribute)
,
[1]
(cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Cluster attribute)
(cruiseplan.runtime.organizational.Leg attribute)
P
pangaea() (in module cruiseplan.api)
(in module cruiseplan.api.data)
pangaea_main() (in module cruiseplan.cli.main)
pangaea_with_config() (in module cruiseplan.api)
(in module cruiseplan.api.data)
PangaeaManager (class in cruiseplan.data.pangaea)
parse_route_strings() (cruiseplan.config.activities.LineDefinition class method)
plot_bathymetry() (in module cruiseplan.output.map_generator)
plot_cruise_elements() (in module cruiseplan.output.map_generator)
point_registry (cruiseplan.runtime.cruise.CruiseInstance attribute)
PointDefinition (class in cruiseplan.config.activities)
PointOperation (class in cruiseplan.runtime.operations)
points (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
PORT (cruiseplan.config.values.OperationTypeEnum attribute)
port_registry (cruiseplan.runtime.cruise.CruiseInstance attribute)
ports (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
position (cruiseplan.runtime.operations.PointOperation attribute)
position_string (cruiseplan.config.activities.PointDefinition attribute)
,
[1]
process() (in module cruiseplan.api)
(in module cruiseplan.api.process_cruise)
process_with_config() (in module cruiseplan.api)
(in module cruiseplan.api.process_cruise)
ProcessResult (class in cruiseplan.api.types)
PROFILE (cruiseplan.config.values.ActionEnum attribute)
R
rate_per_second_to_rate_per_minute() (in module cruiseplan.utils.units)
raw_data (cruiseplan.runtime.cruise.CruiseInstance attribute)
read_doi_list() (in module cruiseplan.data.pangaea)
RECOVERY (cruiseplan.config.values.ActionEnum attribute)
ReferenceError
remove_operation() (cruiseplan.runtime.organizational.Cluster method)
resolve_port_reference() (in module cruiseplan.config.ports)
route (cruiseplan.config.activities.LineDefinition attribute)
,
[1]
(cruiseplan.runtime.operations.LineOperation attribute)
route_distance() (in module cruiseplan.timeline.distance)
runtime_legs (cruiseplan.runtime.cruise.CruiseInstance attribute)
S
SAMPLING (cruiseplan.config.values.ActionEnum attribute)
sampling_density (cruiseplan.runtime.operations.AreaOperation attribute)
save_campaign_data() (in module cruiseplan.data.pangaea)
save_selection() (cruiseplan.interactive.campaign_selector.CampaignSelector method)
save_yaml() (in module cruiseplan.config.yaml_io)
schedule() (in module cruiseplan.api)
(in module cruiseplan.api.schedule_cruise)
schedule_main() (in module cruiseplan.cli.main)
schedule_with_config() (in module cruiseplan.api)
(in module cruiseplan.api.schedule_cruise)
ScheduleResult (class in cruiseplan.api.types)
search() (cruiseplan.data.pangaea.PangaeaManager method)
seconds_to_minutes() (in module cruiseplan.utils.units)
SECTION (cruiseplan.config.values.ActionEnum attribute)
SEISMIC (cruiseplan.config.values.ActionEnum attribute)
selected_campaigns (cruiseplan.interactive.campaign_selector.CampaignSelector attribute)
SEQUENTIAL (cruiseplan.config.values.StrategyEnum attribute)
serialize_area_definition() (in module cruiseplan.runtime.serialization)
serialize_cluster_definition() (in module cruiseplan.runtime.serialization)
serialize_definition() (in module cruiseplan.runtime.serialization)
serialize_leg_definition() (in module cruiseplan.runtime.serialization)
serialize_line_definition() (in module cruiseplan.runtime.serialization)
serialize_point_definition() (in module cruiseplan.runtime.serialization)
set() (cruiseplan.utils.cache.CacheManager method)
set_mode() (cruiseplan.interactive.widgets.ModeIndicator method)
setup_output_paths() (in module cruiseplan.utils.io)
setup_ui() (cruiseplan.interactive.campaign_selector.CampaignSelector method)
source (cruiseplan.data.bathymetry.BathymetryManager attribute)
SPATIAL_INTERLEAVED (cruiseplan.config.values.StrategyEnum attribute)
speed (cruiseplan.runtime.operations.LineOperation attribute)
start_date (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
start_point (cruiseplan.runtime.operations.AreaOperation attribute)
start_time (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
(cruiseplan.timeline.scheduler.ActivityRecord attribute)
StationPickerResult (class in cruiseplan.api.stations_api)
(class in cruiseplan.api.types)
stations() (in module cruiseplan.api)
(in module cruiseplan.api.stations_api)
stations_main() (in module cruiseplan.cli.main)
stations_with_config() (in module cruiseplan.api)
(in module cruiseplan.api.stations_api)
status_lines (cruiseplan.interactive.widgets.StatusDisplay attribute)
StatusDisplay (class in cruiseplan.interactive.widgets)
strategy (cruiseplan.config.cruise_config.ClusterDefinition attribute)
,
[1]
(cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Cluster attribute)
(cruiseplan.runtime.organizational.Leg attribute)
StrategyEnum (class in cruiseplan.config.values)
SURVEY (cruiseplan.config.values.AreaOperationTypeEnum attribute)
T
text_obj (cruiseplan.interactive.widgets.ModeIndicator attribute)
THERMOSALINOGRAPH (cruiseplan.config.values.ActionEnum attribute)
TimelineGenerator (class in cruiseplan.timeline.scheduler)
timezone (cruiseplan.config.activities.PointDefinition attribute)
,
[1]
to_commented_dict() (cruiseplan.runtime.cruise.CruiseInstance method)
(in module cruiseplan.runtime.serialization)
to_coords() (in module cruiseplan.timeline.distance)
to_dict() (cruiseplan.timeline.scheduler.ActivityRecord method)
to_yaml() (cruiseplan.runtime.cruise.CruiseInstance method)
(in module cruiseplan.runtime.serialization)
toggle_all() (cruiseplan.interactive.campaign_selector.CampaignSelector method)
TOW_YO (cruiseplan.config.values.ActionEnum attribute)
TOWING (cruiseplan.config.values.LineOperationTypeEnum attribute)
turnaround_time (cruiseplan.config.cruise_config.CruiseConfig attribute)
,
[1]
(cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Leg attribute)
U
UNDERWAY (cruiseplan.config.values.LineOperationTypeEnum attribute)
unify_coordinates() (cruiseplan.config.activities.FlexibleLocationModel class method)
update_coordinates() (cruiseplan.interactive.widgets.StatusDisplay method)
update_counts() (cruiseplan.interactive.widgets.StatusDisplay method)
update_depth() (cruiseplan.interactive.widgets.StatusDisplay method)
V
validate() (in module cruiseplan.api)
(in module cruiseplan.api.process_cruise)
validate_cluster_activities() (cruiseplan.config.cruise_config.ClusterDefinition method)
validate_configuration() (in module cruiseplan.api.process_cruise)
validate_corners_minimum() (cruiseplan.config.activities.AreaDefinition class method)
validate_cruise_structure() (cruiseplan.config.cruise_config.CruiseConfig method)
validate_duration() (cruiseplan.config.activities.AreaDefinition class method)
validate_input_file() (in module cruiseplan.utils.io)
validate_lat() (cruiseplan.config.activities.GeoPoint class method)
validate_lat_lon_bounds() (in module cruiseplan.cli.pangaea)
validate_leg_structure() (cruiseplan.config.cruise_config.LegDefinition method)
validate_lon() (cruiseplan.config.activities.GeoPoint class method)
validate_main() (in module cruiseplan.cli.main)
validate_operation_depth() (cruiseplan.config.activities.PointDefinition class method)
validate_output_directory() (in module cruiseplan.utils.io)
validate_ports() (cruiseplan.config.cruise_config.LegDefinition class method)
validate_station_spacing() (cruiseplan.config.cruise_config.LegDefinition class method)
validate_strategy() (cruiseplan.config.cruise_config.ClusterDefinition class method)
validate_time_fields() (cruiseplan.config.cruise_config.LegDefinition class method)
validate_vessel_speed() (cruiseplan.config.activities.LineDefinition class method)
(cruiseplan.config.cruise_config.LegDefinition class method)
validate_water_depth() (cruiseplan.config.activities.PointDefinition class method)
validate_with_config() (in module cruiseplan.api)
(in module cruiseplan.api.process_cruise)
ValidationError
ValidationResult (class in cruiseplan.api.types)
vessel_speed (cruiseplan.config.activities.LineDefinition attribute)
,
[1]
(cruiseplan.config.cruise_config.LegDefinition attribute)
,
[1]
(cruiseplan.runtime.organizational.Leg attribute)
vessel_speed_kt (cruiseplan.timeline.scheduler.ActivityRecord attribute)
W
water_depth (cruiseplan.config.activities.PointDefinition attribute)
,
[1]
(cruiseplan.timeline.scheduler.ActivityRecord attribute)
WATER_SAMPLING (cruiseplan.config.values.OperationTypeEnum attribute)
WAYPOINT (cruiseplan.config.values.OperationTypeEnum attribute)
Y
YAMLIOError