hyr_run: Function to command HYSPLIT (Hybrid Single Particle...

View source: R/hyr_run.R

hyr_runR Documentation

Function to command HYSPLIT (Hybrid Single Particle Lagrangian Integrated Trajectory Model) from R.

Description

Function to command HYSPLIT (Hybrid Single Particle Lagrangian Integrated Trajectory Model) from R.

Usage

hyr_run(
  df,
  directory_exec = "exec/",
  directory_input,
  directory_output,
  verbose = FALSE,
  progress = FALSE
)

Arguments

df

Data frame/tibble which contains a set of variables. See examples for an example of what variables need to be included.

directory_exec

Location of HYSPLIT's executable files. Ensure executable permissions have been set for the hyts_std application if on a Unix system.

directory_input

Location of input meteorological files for HYSPLIT.

directory_output

Location of where HYSPLIT should write its trajectory outputs to.

verbose

Should the function give messages?

progress

Should a progress bar be displayed?

Author(s)

Stuart K. Grange

See Also

importTraj, trajPlot, HYSPLIT home, read_hyr

Examples


## Not run: 

# Create a tibble with all the things the hyr_run function requires
data_receptor <- tribble(
  ~latitude, ~longitude, ~runtime, ~interval, ~start_height, ~model_height, ~start, ~end,            
  36.150735, -5.349437, -120, "24 hour", 10, 10000, "2018-06-25", "2018-07-02"
  ) %>%
 mutate(start = as.POSIXct(start),
        end = as.POSIXct(end))
      
# Run hysplit, directories will be different on your system
hyr_run(
  data_receptor,
  directory_exec = "~/programmes/hysplit/trunk/exec",
  directory_input = "/media/storage/data/hysplit",
  directory_output = "~/Desktop/hysplit_outputs",
  verbose = TRUE
)


## End(Not run)


skgrange/hyr documentation built on March 27, 2024, 12:38 a.m.