hysplit_dispersion: Conduct HYSPLIT dispersion runs

In rich-iannone/splitr: Use the HYSPLIT model from inside R

Description

The function executes single/multiple forward or backward HYSPLIT dispersion runs using specified meteorological datasets.

Usage

hysplit_dispersion(lat = 49.263, lon = -123.25, height = 50,
  start_day = "2015-07-01", start_hour = 0, duration = 24,
  direction = "forward", met_type = "reanalysis", vert_motion = 0,
  model_height = 20000, particle_num = 2500, particle_max = 10000,
  species, disp_name = NULL, binary_path = NULL, exec_dir = NULL,
  met_dir = NULL, clean_up = TRUE)

Arguments

lat	The receptor position in terms of latitude and longitude (both in decimal degrees), and height in meters above ground level.
lon	The receptor position in terms of latitude and longitude (both in decimal degrees), and height in meters above ground level.
height	The receptor position in terms of latitude and longitude (both in decimal degrees), and height in meters above ground level.
start_day	the day that the model will initialize and run. This should take the form of a single-length vector for a day ("YYYY-MM-DD").
start_hour	a single daily hour as an integer hour (from 0 to 23).
duration	The duration of each model run (whether it is in the forward direction or running backwards) in hours.
direction	An option to select whether to conduct the model in the "forward" (default) or "backward" directions.
met_type	The type of meteorological data files to use. The options are: "reanalysis" (NCAR/NCEP global reanalysis data, the default), "gdas1" and "gdas0.5" (Global Data Assimilation System 1-degree and 0.5-degree resolution data), "narr" (North American Regional Reanalysis), "gfs0.25" (Global Forecast System 0.25 degree data), and "nam12" (North American Mesoscale Forecast System, 12-km/6-hour resolution data).
vert_motion	A numbered option to select the method used to simulation vertical motion. The methods are: 0 (input model data), 1 (isobaric), 2 (isentropic), 3 (constant density), 4 (isosigma), 5 (from divergence), 6 (remap MSL to AGL), 7 (average data), and 8 (damped magnitude).
model_height	The upper limit of the model domain in meters.
particle_num	The number of particles released by a source during each release cycle.
particle_max	The maximum number of particles released by a source during a model run.
species	A list of parameters corresponding to an emissions source..
disp_name	An optional, descriptive name for the output file collection.
binary_path	An optional path to a HYSPLIT trajectory model binary. When not specified, the model binary will be chosen from several available in the package (based on the user's platform).
exec_dir	An optional file path for the working directory of the model input and output files.
met_dir	An optional file path for storage and access of meteorological data files.
clean_up	An option to make the exec_dir directory clean after completion of all trajectory runs. By default, this is set to TRUE.

rich-iannone/splitr documentation built on Nov. 3, 2021, 6:51 a.m.