Package index • FLAREr

Core Workflow

Function for default end-to-end application of FLARE

Functions for reading and managing run configuration

Functions for initializing simulations and environments

set_up_simulation(): Set and create directories in the configuration file
initialize_faasr(): Validate FaaSr / S3 / local-mode configuration at setup time.

Helper functions for automation and checks

check_noaa_present(): Check if NOAA forecasts have been downloaded and processed

Lower-level functions for building custom workflows

run_da_forecast(): Run ensemble data assimilation and/or produce forecasts
generate_initial_conditions(): Generate initial conditions for FLARE
generate_states_to_obs_mapping(): Map the states to the observations
initiate_model_error(): Generate model error matrix from configuration files

create_met_files(): Convert historical meteorology and NOAA forecasts to GLM format
create_met_files_openmet(): Generate GLM ready met files from the Open-Meteo ensemble API
create_inflow_outflow_files(): Generating inflow and outflow files in the GLM format using arrow
create_obs_matrix(): Create matrix of observations in the format required by run_da_forecast

write_forecast(): Generate parquet output file
write_restart(): Generate netcdf restart file
plotting_general(): Generate diagnostic plot of FLARE output with observations

get_targets(): Download target data from s3
put_targets(): Save target files to s3 bucket
get_restart_file(): Download restart file from s3 bucket
put_restart_file(): Upload restart netcdf file to s3 bucket
delete_restart(): Delete restart file on s3 bucket
delete_sim(): Delete simulation on s3 bucket
get_driver_forecast_path(): Get file path for driver forecasts
flare_arrow_s3_bucket(): Return an arrow::s3_bucket() (or local) handle for a partitioned dataset under a server/prefix.
flare_get_file(): Download a single object to a local path.
flare_put_file(): Upload a single local file as an object.
flare_delete_file(): Delete a single remote object.
flare_get_folder_list(): List object keys under a prefix.
flare_io_mode(): Resolve the I/O backend for a FLARE run from config$run_config.

read_nml(): Read a GLM/ELCOM namelist file into an R list
write_nml(): Write an nml list to a namelist file
modify_nml(): Apply in-memory updates to a parsed GLM/ELCOM namelist
update_nml(): Update multiple variables in a GLM/ELCOM namelist file (read-modify-write)
print(<nml>): Print NML

build_R_matrix(): Build observation error covariance matrix
propose_parameters(): Propose new parameters for use in data assimilation and forecasting
create_flow_files(): Generating a list of flow files in the flare_tempdir