Function reference • FLAREr

Out-of-box workflow

Function for default application of FLARE

run_flare(): Run FLARE for a single forecast

Building custom workflow

Functions used to build a custom FLARE workflow

create_inflow_outflow_files_arrow(): Generating inflow and output files in the GLM format using arrow

create_obs_matrix(): Create matrix of observations in the format required by run_da_forecast

generate_met_files_arrow(): Convert historical meteorology and NOAA forecasts to GLM format via arrow connection

generate_states_to_obs_mapping(): Map the states to the observations

generate_initial_conditions(): Generate initial conditions for FLARE

initiate_model_error(): Generate model error matrix from configuration files

run_da_forecast(): Run ensemble data assimilation and/or produce forecasts

set_configuration(): Set and create directories in the configuration file

write_forecast_netcdf(): Generate netcdf output file

write_forecast_arrow(): Generate parquet output file

generate_forecast_score_arrow(): Score a forecast using score4cast package and arrow

plotting_general_2(): Generate diagnostic plot of FLARE output with observations

Iteration

Functions for automation and interation

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

get_run_config(): Get run configuration from s3 bucket

update_run_config2(): Update run configuration

get_git_repo(): Get data from Github repository

get_edi_file(): Download file from EDI data portal

S3 intergration

Functions used for S3 intergration

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

get_targets(): Download target data from s3

put_targets(): Save target files to s3 bucket

ignore_sigpipe(): ignore sigpipe

put_forecast(): Upload forecast file and metadata to s3 bucket

get_restart_file(): Download restart file from s3 bucket