Package 'PEcAn.ModelName'

Title: PEcAn Package for Integration of the ModelName Model
Description: This module provides functions to link the (ModelName) to PEcAn.
Authors: Jane Doe [aut, cre], John Doe [aut]
Maintainer: Jane Doe <[email protected]>
License: BSD_3_clause + file LICENSE
Version: 1.8.0.9000
Built: 2024-11-20 21:35:14 UTC
Source: https://github.com/PecanProject/pecan

Help Index


Write MODEL met files

Description

Converts a met CF file to a model specific met file. The input files are calld <in.path>/<in.prefix>.YYYY.cf

Usage

met2model.MODEL(in.path, in.prefix, outfolder, overwrite = FALSE)

Arguments

in.path

path on disk where CF file lives

in.prefix

prefix for each file

outfolder

location where model specific output is written.

overwrite

logical: replace output files if they already exist?

Value

OK if everything was succesful.

Author(s)

Rob Kooper


Code to convert MODELS's output into netCDF format

Description

Convert MODEL output into the NACP Intercomparison format (ALMA using netCDF)

Usage

model2netcdf.MODEL(outdir, sitelat, sitelon, start_date, end_date)

Arguments

outdir

Location of model output

sitelat

Latitude of the site

sitelon

Longitude of the site

start_date

Start time of the simulation

end_date

End time of the simulation

Author(s)

Rob Kooper


Read restart template for SDA

Description

Read restart files from model.

Usage

read_restart.ModelName(outdir, runid, stop.time, settings, var.names, params)

Arguments

outdir

Output directory

runid

Run ID

stop.time

Year that is being read

settings

PEcAn settings object

var.names

Variable names to be extracted

params

Any parameters required for state calculations

Value

Forecast numeric matrix

Author(s)

Alexey Shiklomanov


Write restart template for SDA

Description

Write restart files for model

Usage

write_restart.ModelName(
  outdir,
  runid,
  start.time,
  stop.time,
  settings,
  new.state,
  RENAME,
  new.params,
  inputs
)

Arguments

outdir

outout directory

runid

run id

start.time

Time of current assimilation step

stop.time

Time of next assimilation step

settings

pecan settings list

new.state

Analysis state matrix returned by sda.enkf

RENAME

flag to either rename output file or not

new.params

optional, additionals params to pass write.configs that are deterministically related to the parameters updated by the analysis

inputs

new input paths updated by the SDA workflow, will be passed to write.configs

Author(s)

Alexey Shiklomanov


Write MODEL configuration files

Description

Writes a MODEL config file.

Usage

write.config.MODEL(defaults, trait.values, settings, run.id)

Arguments

defaults

list of defaults to process

trait.values

vector of samples for a given trait

settings

list of settings from pecan settings file

run.id

id of run

Details

Requires a pft xml object, a list of trait values for a single model run, and the name of the file to create

Value

configuration file for MODEL for given run

Author(s)

Rob Kooper