MadrigalWeb

A class that encapsulates information about a Madrigal Experiment.

Similar to the MadrigalExperiment class in the madrigalWeb python module.

Instrument

A struct that encapsulates information about a Madrigal Instrument.

Fields

• name: Instrument name (e.g., 'Millstone Hill Incoherent Scatter Radar')
• code: Instrument code (e.g., 30)
• mnemonic: Three-character mnemonic (e.g., 'mlh')
• latitude: Instrument latitude in degrees
• longitude: Instrument longitude in degrees
• altitude: Instrument altitude in km
• category: Instrument category (e.g., 'Incoherent Scatter Radars')

Similar to the MadrigalInstrument class in the madrigalWeb python module.

Parameter

A struct that encapsulates information about a Madrigal parameter.

Similar to the MadrigalParameter class in the madrigalWeb python module.

throw controls whether to throw or silently return nothing on request error

download_files(inst, kindat, t0, t1; kws...)

Download files for a given instrument code inst, data code kindat, and time range t0 to t1.

filter_by_kindat(expFileList, kindat)

Returns a subset of the experiment files in expFileList whose kindat is found in kindat argument.

get_all_instruments(url)
get_all_instruments(server::Server = Default_server[])

Returns a list of all Madrigal instruments at the given Madrigal site url or server.

Examples

# Get all instruments from the default server
instruments = get_all_instruments()

# Get all instruments from a specific server
server = Server("https://cedar.openmadrigal.org")
instruments = get_all_instruments(server)

get_experiment_file_parameters(file, url)
get_experiment_file_parameters(file, server::Server = Default_server[])

Returns a list of all measured and derivable parameters in the given experiment file.

Examples

# Get parameters for a specific file
file = first(get_experiment_files(experiment))
parameters = get_experiment_file_parameters(file)

Similar to the getExperimentFileParameters method in the madrigalWeb python module.

get_experiment_files(exp; server = Default_server[], getNonDefault = false)

Get all default experiment files for a given experiment exp.

get_experiments(code, t0, t1; server = Default_server[])

Get a list of experiments for a given instrument code and time range t0 to t1.