Package: lpjmlkit 1.8.2

Jannes Breier

lpjmlkit: Toolkit for Basic LPJmL Handling

A collection of basic functions to facilitate the work with the Dynamic Global Vegetation Model (DGVM) Lund-Potsdam-Jena managed Land (LPJmL) hosted at the Potsdam Institute for Climate Impact Research (PIK). It provides functions for performing LPJmL simulations, as well as reading, processing and writing model-related data such as inputs and outputs or configuration files.

Authors:Jannes Breier [aut, cre], Sebastian Ostberg [aut], Stephen Björn Wirth [aut], Sara Minoli [aut], Fabian Stenzel [aut], David Hötten [aut], Christoph Müller [aut]

lpjmlkit_1.8.2.tar.gz
lpjmlkit_1.8.2.zip(r-4.7-any)lpjmlkit_1.8.2.zip(r-4.6-any)lpjmlkit_1.8.2.zip(r-4.5-any)
lpjmlkit_1.8.2.tgz(r-4.6-any)lpjmlkit_1.8.2.tgz(r-4.5-any)
lpjmlkit_1.8.2.tar.gz(r-4.7-any)lpjmlkit_1.8.2.tar.gz(r-4.6-any)
lpjmlkit_1.8.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
lpjmlkit/json (API)

# Install 'lpjmlkit' in R:
install.packages('lpjmlkit', repos = c('https://pik-piam.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/pik-lpjml/lpjmlkit/issues

On CRAN:

Conda:

7.58 score 10 stars 16 packages 32 scripts 2 downloads 34 exports 24 dependencies

Last updated from:74bcb36f22. Checks:9 OK. Indexed: no.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK182
source / vignettesOK258
linux-release-x86_64OK167
macos-release-arm64OK121
macos-oldrel-arm64OK90
windows-develOK249
windows-releaseOK134
windows-oldrelOK127
wasm-releaseOK151

Exports:add_gridas_arrayas_headeras_listas_rasteras_terraasubcalc_cellareacheck_configcreate_headerdetect_io_typefind_varfileget_cellindexget_datatypeget_header_itemget_headersizeLPJmLDataLPJmLGridDataLPJmLMetaDatamake_lpjmlplot.LPJmLDataread_configread_gridread_headerread_ioread_metarun_lpjmlset_header_itemsplit_time_namessubmit_lpjmlsubset.LPJmLDatatransformwrite_configwrite_header

Dependencies:abindclicodetoolsdoParalleldplyrforeachgenericsglueiteratorsjsonlitelifecyclemagrittrpillarpkgconfigprocessxpsR6rlangstringitibbletidyselectutf8vctrswithr

LPJmL Data
Overview | 1. r if (!knitr::is_latex_output()) {"📖"} Read function read_io | 2. r if (!knitr::is_latex_output()) {"📁"} Data class LPJmLData | 3. r if (!knitr::is_latex_output()) {"📈"} Basic statistics of LPJmLData objects | 4. r if (!knitr::is_latex_output()) {"✏"} Modify LPJmLData objects | 5. r if (!knitr::is_latex_output()) {"📦"} Export LPJmLData objects | Miscellaneous | Usage | 1. Example Global Trend in net primary productivity (NPP) over the years | 2. Example Runoff in northern hemisphere during summertime | 3. Example Gross primary productivity (GPP) per latitude | 4. Example CFT fractions for area around Potsdam | Notes & tips
Rendered fromlpjml-data.Rmdusingknitr::rmarkdown

Last update: 2026-02-24
Started: 2023-01-23

LPJmL Runner
r if (!knitr::is_latex_output()) {"⚙"} Setup | Overview | 1. r if (!knitr::is_latex_output()) {"📋"} Define a table of modified configuration parameters\ | 2. r if (!knitr::is_latex_output()) {"✍"} Create corresponding Configuration files\ | 3. r if (!knitr::is_latex_output()) {"🔍"} Check validity of Configurations\ | 4. r if (!knitr::is_latex_output()) {"▶"} Run or r if (!knitr::is_latex_output()) {"🚀"} submit LPJmL\ | miscellaneous \ | Usage | Single cell simulations\ | Example Potential natural vegetation and land-use run | Example Old vs. new phenology and old land-use vs. input toolbox | Global simulations on the PIK cluster | Example Compare old vs new land use (lpjml input toolbox) | Notes & tips
Rendered fromlpjml-runner.Rmdusingknitr::rmarkdown

Last update: 2025-03-17
Started: 2022-02-21

Readme and manuals

Help Manual

Help pageTopics
lpjmlkit: Toolkit for Basic LPJmL Handlinglpjmlkit-package lpjmlkit
Add grid to an LPJmLData objectadd_grid
Coerce an LPJmLData object to an arrayas_array
Coerce LPJmLMetaData to an LPJmL header objectas_header
Coerce LPJmLMetaData to a listas_list
Coerce an LPJmLData object to a raster objectas_raster
Coerce an LPJmLData object to a terra objectas_rast as_SpatRaster as_terra
Coerce an LPJmLData object to a tibbleas_tibble.LPJmLData
Subset a named arrayasub
Calculate the cell area of LPJmL cellscalc_cellarea
Check the validity of LPJmL config JSON filescheck_config
Create a new LPJmL input/output file headercreate_header
Detect the file type of an LPJmL input/output filedetect_io_type
Dimensions of an LPJmLData data arraydim.LPJmLData
Dimnames of an LPJmLData data arraydimnames.LPJmLData
Search for a variable file in a directoryfind_varfile
Get Cell Indexget_cellindex
Data type of an LPJmL input/output fileget_datatype
Retrieve information from an LPJmL input/output file headerget_header_item
Determine the size of an LPJmL input/output file headerget_headersize
Length of an LPJmLData data arraylength.LPJmLData
LPJmL data classLPJmLData
LPJmL grid data classLPJmLGridData
LPJmL meta data classLPJmLMetaData
Compile LPJmL modelmake_lpjml
Plot an LPJmLData objectplot.LPJmLData
Reads netcdf and returns it as arrayread_cdf
Reads netcdf and returns it header inforead_cdf_meta
Read an LPJmL configuration fileread_config
Read LPJmL input and output grid filesread_grid
Read header (any version) from LPJmL input/output fileread_header
Read LPJmL input and output filesread_input read_io read_output
Read an LPJmL meta file, NetCDF or binary file headerread_meta
Run LPJmL modelrun_lpjml
Set information in an LPJmL input (or output) file headerset_header_item
Split date strings into years, months and dayssplit_time_names
Submit LPJmL model simulation to SLURMsubmit_lpjml
Subset an LPJmLData objectsubset.LPJmLData
LPJmLData object summarysummary.LPJmLData
Transform an LPJmLData objecttransform
Write LPJmL config files (JSON)write_config
Write LPJmL header object to an LPJmL input (or output) filewrite_header