run_disperser_parallel: run the fac model in parallel

Description Usage Arguments Details Value

View source: R/run_disperser_parallel.R

Description

run_disperser_parallel

Usage

1
2
3
run_disperser_parallel(input.refs = NULL, pbl.height = NULL,
  species = "so2", proc_dir = proc_dir, overwrite = F, npart = 100,
  mc.cores = parallel::detectCores(), keep.hysplit.files = FALSE)

Arguments

input.refs

should be the data table that is the result of the 'define_input()' function or a subset of that dataset

pbl.height

Monthly mean planetary boundary layer heights. See vignettes for more information

species

The package has the possibility to use two types of species. The default one is ‘species = ’so2'‘, but you can also use particulate sulfate 'species = ’so4p''.

proc_dir

directory where the function saves temporary files while running. This is automatically defined by 'create_dirs()'

overwrite

if output files already exist should they be overwritten? This is 'false' by default.

npart

number of air parcels tracked by HYSPLIT. Defaults to 100

mc.cores

on how many cores should R split the computations. set to parallel::detectCores() or set to 1 if you want to serial computation.

keep.hysplit.files

logical. If FALSE (the default), clears storage space in the 'proc_dir' by removing all HYSPLIT files

Details

It is possible that running the below code with output a warning "WARNING: map background file not found ../graphics/arlmap". It is safe to ignore it.

Value

This function returns fac model results.


lhenneman/disperseR documentation built on Nov. 14, 2021, 6:24 p.m.