argopy.ArgoFloat.config

argopy.ArgoFloat.config#

ArgoFloat.config()#

Extension providing access to configuration parameters

Warning

Configuration parameters are float settings selected by the PI, not measurements reported by the float.

Examples

Listing 25 Configuration parameters and missions#
from argopy import ArgoFloat
af = ArgoFloat(6903091)

# Total number and list of configuration parameters:
af.config.n_params
af.config.parameters

# Total number and list of missions:
af.config.n_missions
af.config.missions

# Read one parameter value, with explicit or implicit parameter name:
# ('CONFIG_' is not mandatory, but string is case-sensitive)
af.config['CONFIG_CycleTime_hours']
af.config['CycleTime_hours']

# Read parameter value for one or more mission numbers:
# (! 2nd index is not 0-based, it's an integer key to look for in mission numbers)
af.config['CycleTime_hours', 1]
af.config['CycleTime_hours', 1:3]
Listing 26 Configuration parameters and cycle numbers#
from argopy import ArgoFloat
af = ArgoFloat(6903091)

# Get a dictionary mapping cycle on mission numbers:
af.config.cycles

# Read parameter value for one or more cycle numbers:
# (! 2nd index is not 0-based, it's an integer key to look for in cycle numbers)
af.config.for_cycles('CycleTime_hours', 1)
af.config.for_cycles('CycleTime_hours', [10, 11])
Listing 27 Export configuration parameters#
from argopy import ArgoFloat
af = ArgoFloat(6903091)

# Export to a DataFrame:
af.config.to_dataframe()
af.config.to_dataframe(missions=1)
af.config.to_dataframe(missions=[1, 2])

Notes

  • When called online, data are retrieved from the Euro-Argo Fleet-Monitoring web-API.

  • When called offline, data are retrieved from local meta-data and prof-data netcdf files and variables N_MISSIONS, CONFIG_PARAMETER_NAME, CONFIG_PARAMETER_VALUE, CONFIG_MISSION_NUMBER and CYCLE_NUMBER.

References

import argopy
# User manual section on "Configuration parameters"
argopy.ArgoDocs(29825).open_pdf(55)  # as of Version 3.44.0