API reference#

This page provides an auto-generated summary of VirtualFleet’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

Top-levels classes#

VirtualFleet#

VirtualFleet(plan, fieldset, mission[, isglobal])

Argo Virtual Fleet simulator.

Methods

VirtualFleet.simulate(duration[, step, ...])

Execute a Virtual Fleet simulation

VirtualFleet.to_index([file_name])

Return last simulated profile index dataframe

VirtualFleet.plot_positions()

Plot the last position of virtual Argo Floats

Attributes

VirtualFleet.ParticleSet

Return ParticleSet

VirtualFleet.fieldset

Return FieldSet

VirtualFleet.output

Return absolute path to the last simulation trajectory output file

FloatConfiguration#

FloatConfiguration([name])

Float mission configuration manager

FloatConfiguration.to_json(*args, **kwargs)

Return a dictionary serialisable in json or write to file

FloatConfiguration.update(key, new_value)

Update value to an existing parameter

FloatConfiguration.mission

Return the float configuration as a dictionary to be used by a VirtualFleet

FloatConfiguration.tech

Float configuration as a dictionary using Argo technical keys

FloatConfiguration.params

List of parameter keys

Velocity/Field#

Velocity([model])

Function to return a VelocityField instance for known products

VelocityField()

Class prototype to manage a Virtual Fleet velocity field

VelocityField.add_mask()

Create mask for grounding management

VelocityField.set_global()

Ensure a global fieldset

VelocityField.plot()

Quick plot of the ParticleSet

VelocityField.fieldset

Instance of parcels.fieldset.FieldSet created using the field attribute

Utilities#

utilities.simu2index(ds[, N])

Convert a trajectory simulation xarray.Dataset to an Argo index of profiles

utilities.simu2csv(simu_file[, index_file, df])

Save simulation results profile index to file, as Argo index

utilities.set_WMO(ds, argo_index)

Identify virtual floats with their real WMO

utilities.get_float_config(wmo[, cyc])

Download float configuration using the Euro-Argo meta-data API

Parcels Particles and kernels#

app_parcels.ArgoFloatKernel(particle, ...)

Default kernel to simulate an Argo float

app_parcels.ArgoParticle(*args, **kwargs)

Default class to represent an Argo float

app_parcels.ArgoFloatKernel_exp(particle, ...)

Argo float kernel to simulate an Argo float cycle with change of mission parameters in a specific geographical area

app_parcels.ArgoParticle_exp(*args, **kwargs)

Class used to represent an Argo float that can temporarily change its mission parameters