Madrigal.jl

Parameter

A struct that encapsulates information about a Madrigal parameter.

Similar to the MadrigalParameter class in the madrigalWeb python module.

cached_get(url; max_age_days=7, cache_dir=CACHE_DIR, kw...)

Get URL with persistent disk caching.

Cache files are stored in cache_dir and expire after max_age_days days (default: 7). Since the Madrigal server doesn't provide Last-Modified headers, we rely on age-based expiration.

clear_metadata_cache!()

Clear all cached metadata results.

This forces fresh data to be downloaded on the next call to metadata functions. Useful if you know the server data has been updated.

download_file(file, destination = nothing; kws...)

Download the corresponding data file for a given experiment file file.

Set throw = true to throw an error on request failure, otherwise return nothing.

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

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

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(; server = Default_server[], kw...)
get_experiment_files(id; server, getNonDefault = false, source = :cache, kw...)

Get all experiment files from the server, optionally filtered by given experiment id.

By default uses cached metadata from fileTab.txt for faster access. Set source=:web for direct web service access.

Examples

get_experiment_files(100000009)  # From cache
get_experiment_files(100000009, source=:web)  # From web service

get_experiments(; server = Default_server[])
get_experiments(code, t0 = Date(1950, 1, 1), t1 = Dates.now(); server, source = :cache, kw...)

Get all experiments from the server, optionally filtered by instrument code and time range t0 to t1.

By default uses cached metadata from expTab.txt for faster access. Set source=:web for direct web service access.

Examples

get_experiments()  # All experiments from cache
get_experiments(30, Date(2020, 1, 1), Date(2020, 12, 31))  # Filtered by instrument and dates
get_experiments(30, Date(2020, 1, 1), Date(2020, 12, 31), source=:web)  # From web service

get_instrument_files(inst, [kindat], t0, t1; server = Default_server[])

Get all experiment files for a given instrument inst (code or common name) and time range t0 to t1, optionally filtered by data code kindat.

get_instruments(server = Default_server[]; source = :cache)

Returns all Madrigal instruments from the server.

By default uses cached metadata for faster access. Set source=:web for direct web service access.

Examples

# Get all instruments using cached metadata (fast)
get_instruments()

# Get all instruments using web service (up-to-date but slower)
get_instruments(source=:web)

get_metadata(id; server = Default_server[])::CSV.File

Get consolidated metadata file from OpenMadrigal server.

Example

# Get all experiments
get_metadata(:experiments)

# Get all files  
get_metadata(:files)