From e5714e2c244b637eae5bf8ea06bfd415203605f9 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 4 Jun 2024 15:57:10 +0000 Subject: [PATCH] cli-151032-408 --- pkgdown.yml | 2 +- reference/index.html | 5 ++ reference/read_obsnode.html | 6 +++ reference/read_profile.html | 95 +++++++++++++++++++++++++++++++++++++ search.json | 2 +- sitemap.xml | 3 ++ 6 files changed, 111 insertions(+), 2 deletions(-) create mode 100644 reference/read_profile.html diff --git a/pkgdown.yml b/pkgdown.yml index afd869e..a3ff794 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.0.9 pkgdown_sha: ~ articles: workflow: workflow.html -last_built: 2024-06-04T15:22Z +last_built: 2024-06-04T15:56Z urls: reference: https://kwb-r.github.io/kwb.hydrus1d/reference article: https://kwb-r.github.io/kwb.hydrus1d/articles diff --git a/reference/index.html b/reference/index.html index d572105..508f051 100644 --- a/reference/index.html +++ b/reference/index.html @@ -124,6 +124,11 @@

Read Outputread_profile() + +
Read PROFILE.out
+
+ read_runinf()
Read Run_Inf.out
diff --git a/reference/read_obsnode.html b/reference/read_obsnode.html index 9e81b6e..8bce55d 100644 --- a/reference/read_obsnode.html +++ b/reference/read_obsnode.html @@ -70,6 +70,12 @@

Arguments +

Value

+ + +

tibble with Obs_Node time series data

+ diff --git a/reference/read_profile.html b/reference/read_profile.html new file mode 100644 index 0000000..416ac1c --- /dev/null +++ b/reference/read_profile.html @@ -0,0 +1,95 @@ + +Read PROFILE.out — read_profile • kwb.hydrus1d + Skip to contents + + +
+
+
+

Read PROFILE.out

+ Source: R/read_profile.R +
read_profile.Rd
+
+ +
+

Read PROFILE.out

+
+ +
+

Usage

+ 
read_profile(path)
+
+ +
+

Arguments

+
path
+

path to PROFILE.out

+ +
+
+

Value

+ + +

tibble with PROFILE.out data

+
+ +
+ + +
+ + + + + + + diff --git a/search.json b/search.json index db4a792..f99295c 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://kwb-r.github.io/kwb.hydrus1d/articles/workflow.html","id":"install-r-package","dir":"Articles","previous_headings":"","what":"Install R Package","title":"Workflow","text":"","code":"# Enable this universe options(repos = c( kwbr = 'https://kwb-r.r-universe.dev', CRAN = 'https://cloud.r-project.org')) # Install R package install.packages('kwb.hydrus1d')"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/articles/workflow.html","id":"define-paths","dir":"Articles","previous_headings":"","what":"Define Paths","title":"Workflow","text":"","code":"paths_list <- list( exe_dir = system.file(\"extdata/model\", package = \"kwb.hydrus1d\"), model_name = \"test\", model_dir = \"/\", atmosphere = \"/ATMOSPH.IN\", a_level = \"/A_LEVEL.out\", t_level = \"/T_LEVEL.out\", runinf = \"/Run_Inf.out\", solute_id = 1L, solute = \"/solute.out\" ) paths <- kwb.utils::resolve(paths_list)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/articles/workflow.html","id":"run-model","dir":"Articles","previous_headings":"","what":"Run Model","title":"Workflow","text":"","code":"exe_path <- kwb.hydrus1d::check_hydrus_exe(dir = paths$exe_dir, skip_preinstalled = TRUE) #> Checking if download of HYDRUS1D executable v4.17.0140 from 'https://github.com/mrustl/hydrus1d/archive/refs/tags/v4.17.0140.zip' was successful ... ok. (0.00 secs) kwb.hydrus1d::run_model(exe_path = exe_path, model_path = paths$model_dir) #> Warning in shell(cmd = sprintf(\"cd %s && %s\", fs::path_abs(target_dir), : 'cd #> D:/a/_temp/Library/kwb.hydrus1d/extdata/model && H1D_CALC.exe' execution failed #> with error code 24"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/articles/workflow.html","id":"read-results","dir":"Articles","previous_headings":"","what":"Read Results","title":"Workflow","text":"","code":"a_level <- kwb.hydrus1d::read_alevel(paths$a_level) a_level #> # A tibble: 1,279 × 10 #> time sum_r_top sum_r_root sum_v_top sum_v_root sum_v_bot h_top h_root #> * #> 1 1 0.25 0 0.0698 0 -0.00173 -1 e5 0 #> 2 2 -0.2 0 -0.380 0 -0.00346 -8.35e1 0 #> 3 3 -0.02 0 -0.200 0 -0.00520 -2.00e3 0 #> 4 4 -0.14 0 -0.320 0 -0.00693 -1.05e2 0 #> 5 5 -0.13 0 -0.310 0 -0.00866 -1.25e2 0 #> 6 6 -0.0000000270 0 -0.209 0 -0.0104 -1 e5 0 #> 7 7 0.22 0 -0.177 0 -0.0121 -1 e5 0 #> 8 8 0.27 0 -0.161 0 -0.0139 -1 e5 0 #> 9 9 0.45 0 -0.146 0 -0.0156 -1 e5 0 #> 10 10 0.63 0 -0.135 0 -0.0173 -1 e5 0 #> # ℹ 1,269 more rows #> # ℹ 2 more variables: h_bot , a_level t_level <- kwb.hydrus1d::read_tlevel(paths$t_level) t_level #> # A tibble: 17,649 × 22 #> time r_top r_root v_top v_root v_bot sum_r_top sum_r_root sum_v_top #> * #> 1 0.111 0.25 0 0.25 0 -0.00173 0.0278 0 0.0278 #> 2 0.148 0.25 0 0.25 0 -0.00173 0.0370 0 0.0370 #> 3 0.164 0.25 0 0.25 0 -0.00173 0.0410 0 0.0410 #> 4 0.171 0.25 0 0.25 0 -0.00173 0.0428 0 0.0428 #> 5 0.180 0.25 0 0.0977 0 -0.00173 0.0450 0 0.0437 #> 6 0.184 0.25 0 0.0786 0 -0.00173 0.0460 0 0.0440 #> 7 0.189 0.25 0 0.0819 0 -0.00173 0.0473 0 0.0444 #> 8 0.196 0.25 0 0.0840 0 -0.00173 0.0490 0 0.0450 #> 9 0.204 0.25 0 0.0816 0 -0.00173 0.0511 0 0.0457 #> 10 0.216 0.25 0 0.0774 0 -0.00173 0.0539 0 0.0465 #> # ℹ 17,639 more rows #> # ℹ 13 more variables: sum_v_root , sum_v_bot , h_top , #> # h_root , h_bot , run_off , sum_run_off , volume , #> # sum_infil , sum_evap , t_level , cum_w_trans , #> # snow_layer runinf <- kwb.hydrus1d::read_runinf(paths$runinf) runinf #> # A tibble: 17,649 × 11 #> t_level time dt itr_w itr_c it_cum kod_t kod_b converg peclet courant #> * #> 1 1 0.111 0.111 5 1 25 -4 -5 TRUE 0.1 0.18 #> 2 2 0.148 0.0370 3 1 38 -4 -5 TRUE 0.1 0.075 #> 3 3 0.164 0.0160 2 1 50 -4 -5 TRUE 0.1 0.034 #> 4 4 0.171 0.00695 2 1 62 -4 -5 TRUE 0.1 0.015 #> 5 5 0.180 0.00904 3 1 65 -4 -5 TRUE 0.1 0.009 #> 6 6 0.184 0.00392 2 1 77 4 -5 TRUE 0.1 0.003 #> 7 7 0.189 0.00509 2 1 79 4 -5 TRUE 0.1 0.004 #> 8 8 0.196 0.00662 2 1 81 4 -5 TRUE 0.1 0.006 #> 9 9 0.204 0.00861 2 1 83 4 -5 TRUE 0.1 0.007 #> 10 10 0.216 0.0112 2 1 85 4 -5 TRUE 0.1 0.009 #> # ℹ 17,639 more rows solute <- kwb.hydrus1d::read_solute(paths$solute) solute #> # A tibble: 17,649 × 19 #> time cv_top cv_bot sum_cv_top sum_cv_bot cv_ch0 cv_ch1 c_top c_root c_bot #> * #> 1 0.111 0 0 0 0 0 0 0 0 0 #> 2 0.148 0 0 0 0 0 0 0 0 0 #> 3 0.164 0 0 0 0 0 0 0 0 0 #> 4 0.171 0 0 0 0 0 0 0 0 0 #> 5 0.180 0 0 0 0 0 0 0 0 0 #> 6 0.184 0 0 0 0 0 0 0 0 0 #> 7 0.189 0 0 0 0 0 0 0 0 0 #> 8 0.196 0 0 0 0 0 0 0 0 0 #> 9 0.204 0 0 0 0 0 0 0 0 0 #> 10 0.216 0 0 0 0 0 0 0 0 0 #> # ℹ 17,639 more rows #> # ℹ 9 more variables: cv_root , sum_cv_root , sum_cv_n_eql , #> # t_level , c_gwl , c_run_off , sum_c_run_off , #> # cv_i , sum_cv_i "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Michael Rustler. Author, maintainer. Hauke Sonnenberg. Contributor. . Funder. . Copyright holder.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Rustler M (2024). kwb.hydrus1d: R Interface Last Official Release Hydrus1D (V4.17.0140) Windows. R package version 0.0.0.9000, https://github.com/KWB-R/kwb.hydrus1d.","code":"@Manual{, title = {kwb.hydrus1d: R Interface for the Last Official Release of Hydrus1D (V4.17.0140) for Windows}, author = {Michael Rustler}, year = {2024}, note = {R package version 0.0.0.9000}, url = {https://github.com/KWB-R/kwb.hydrus1d}, }"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"R Interface for the Last Official Release of Hydrus1D (V4.17.0140) for Windows","text":"installing latest release R package run following code :","code":"# Enable repository from kwb-r options(repos = c( kwbr = 'https://kwb-r.r-universe.dev', CRAN = 'https://cloud.r-project.org')) # Download and install kwb.hydrus1d in R install.packages('kwb.hydrus1d') # Browse the kwb.swmm manual pages help(package = 'kwb.hydrus1d')"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"R Interface for the Last Official Release of Hydrus1D (V4.17.0140) for Windows","text":"Checkout Workflow article use R package.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2022 Kompetenzzentrum Wasser Berlin gGmbH (KWB) Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/check_hydrus_exe.html","id":null,"dir":"Reference","previous_headings":"","what":"Check HYDRUS Executable and download if needed — check_hydrus_exe","title":"Check HYDRUS Executable and download if needed — check_hydrus_exe","text":"Check HYDRUS Executable download needed","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/check_hydrus_exe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check HYDRUS Executable and download if needed — check_hydrus_exe","text":"","code":"check_hydrus_exe( dir = file.path(system.file(package = \"kwb.hydrus1d\"), \"extdata/hydrus1d\"), skip_preinstalled = FALSE )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/check_hydrus_exe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check HYDRUS Executable and download if needed — check_hydrus_exe","text":"dir target directory (default: file.path(system.file(package = \"kwb.hydrus1d\"), \"extdata/hydrus1d\"), case compliant HYDRUS1D version available, executable downloaded https://github.com/mrustl/hydrus1d/archive/refs/tags/v4.17.0140.zip skip_preinstalled TRUE checking preinstalled HYDRUS-1D skipped executable downloaded, otherwise (default)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/check_hydrus_exe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check HYDRUS Executable and download if needed — check_hydrus_exe","text":"path preinstalled HYDRUS-1D executable (compliant parameter skip_preinstalled == FALSE), otherwise path downloaded HYDRUS-1D","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/check_hydrus_exe.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check HYDRUS Executable and download if needed — check_hydrus_exe","text":"","code":"check_hydrus_exe(skip_preinstalled = FALSE) #> Checking if download of HYDRUS1D executable v4.17.0140 from 'https://github.com/mrustl/hydrus1d/archive/refs/tags/v4.17.0140.zip' was successful ... ok. (0.00 secs) check_hydrus_exe(skip_preinstalled = TRUE) #> Checking if download of HYDRUS1D executable v4.17.0140 from 'https://github.com/mrustl/hydrus1d/archive/refs/tags/v4.17.0140.zip' was successful ... ok. (0.00 secs)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/defaults_atmosphere.html","id":null,"dir":"Reference","previous_headings":"","what":"Defaults for Atmosphere — defaults_atmosphere","title":"Defaults for Atmosphere — defaults_atmosphere","text":"Defaults Atmosphere","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/defaults_atmosphere.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Defaults for Atmosphere — defaults_atmosphere","text":"","code":"defaults_atmosphere( Prec = 0L, rSoil = 0L, rRoot = 0L, hCritA = 100000L, rB = 0L, hB = 0L, ht = 0L, tTop = 0L, tBot = 0L, Ampl = 0L, cTop = 0L, cBot = 0L, RootDepth = 0L )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/defaults_atmosphere.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Defaults for Atmosphere — defaults_atmosphere","text":"Prec Precipitation (default: 0) rSoil Evaporation (default: 0) rRoot Transpiration (default: 0) hCritA (default: 100000) rB rB (default: 0) hB hB (default: 0) ht ht (default: 0) tTop tTop (default: 0) tBot tBot (default: 0) Ampl Ampl (default: 0) cTop concentration solute 1 top (default: 0) cBot concentration solute 1 bottom (default: 0) RootDepth root depth (default: 0)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/defaults_atmosphere.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Defaults for Atmosphere — defaults_atmosphere","text":"tibble defaults atmospheric parameters","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/defaults_atmosphere.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Defaults for Atmosphere — defaults_atmosphere","text":"","code":"defaults_atmosphere() #> # A tibble: 1 × 13 #> Prec rSoil rRoot hCritA rB hB ht tTop tBot Ampl cTop cBot #> #> 1 0 0 0 100000 0 0 0 0 0 0 0 0 #> # ℹ 1 more variable: RootDepth "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_atmosphere_headers.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Atmosphere Headers — get_atmosphere_headers","title":"Get Atmosphere Headers — get_atmosphere_headers","text":"Get Atmosphere Headers","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_atmosphere_headers.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Atmosphere Headers — get_atmosphere_headers","text":"","code":"get_atmosphere_headers()"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_atmosphere_headers.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Atmosphere Headers — get_atmosphere_headers","text":"vector atmosphere headers \"ATMOSPH.\"","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_atmosphere_headers.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Atmosphere Headers — get_atmosphere_headers","text":"","code":"get_atmosphere_headers() #> [1] \"tAtm\" \"Prec\" \"rSoil\" \"rRoot\" \"hCritA\" \"rB\" #> [7] \"hB\" \"ht\" \"tTop\" \"tBot\" \"Ampl\" \"cTop\" #> [13] \"cBot\" \"RootDepth\""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_output_meta.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","title":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","text":"Helper Function: Get Metadata Outputs ('A_LEVEL.', 'T_LEVEL.')","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_output_meta.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","text":"","code":"get_output_meta(output)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_output_meta.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","text":"output imported output retrieved read_alevel read_tlevel","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_output_meta.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","text":"returns metainformation list sublists \"general\" \"units\" imported 'A_LEVEL.' 'T_LEVEL.' file","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_output_meta.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","text":"","code":"test_file <- function(x) system.file(\"extdata/model/test\", x, package = \"kwb.hydrus1d\") alevel <- read_alevel(path = test_file(\"A_LEVEL.out\")) get_output_meta(alevel) #> $general #> NULL #> #> $units #> # A tibble: 10 × 3 #> name col_width unit_general #> #> 1 time 12 \"T\" #> 2 sum_r_top 14 \"L\" #> 3 sum_r_root 14 \"L\" #> 4 sum_v_top 14 \"L\" #> 5 sum_v_root 14 \"L\" #> 6 sum_v_bot 14 \"L\" #> 7 h_top 11 \"L\" #> 8 h_root 11 \"L\" #> 9 h_bot 11 \"L\" #> 10 a_level 8 \"\" #> tlevel <- read_tlevel(path = test_file(\"T_LEVEL.out\")) get_output_meta(tlevel) #> $general #> # A tibble: 1 × 5 #> description modelstart_datetime unit_L unit_T unit_M #> #> 1 Flextreat Hydraulic Model 30.6.2022 12:49:10 cm days mmol #> #> $units #> # A tibble: 22 × 4 #> name col_width unit_general unit #> #> 1 time 13 T days #> 2 r_top 13 L/T cm/days #> 3 r_root 13 L/T cm/days #> 4 v_top 13 L/T cm/days #> 5 v_root 13 L/T cm/days #> 6 v_bot 13 L/T cm/days #> 7 sum_r_top 13 L cm #> 8 sum_r_root 13 L cm #> 9 sum_v_top 13 L cm #> 10 sum_v_root 13 L cm #> # ℹ 12 more rows #>"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_units_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper function: get units list from meta general — get_units_list","title":"Helper function: get units list from meta general — get_units_list","text":"Helper function: get units list meta general","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_units_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper function: get units list from meta general — get_units_list","text":"","code":"get_units_list(meta_general)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_units_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper function: get units list from meta general — get_units_list","text":"meta_general retrieved read_meta_general","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_units_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper function: get units list from meta general — get_units_list","text":"list elements unit_L, unit_T unit_M","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_units_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Helper function: get units list from meta general — get_units_list","text":"","code":"path_tlevel <- system.file(\"extdata/model/test/T_LEVEL.out\", package = \"kwb.hydrus1d\") content <- readLines(path_tlevel) content_general <- content[3:5] cat(content_general) #> Flextreat Hydraulic Model Date: 30. 6.2022 Time: 12:49:10 Units: L = cm , T = days , M = mmol meta_general <- read_meta_general(content_general) get_units_list(meta_general) #> $L #> [1] \"cm\" #> #> $T #> [1] \"days\" #> #> $M #> [1] \"mmol\" #>"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/pipe.html","id":null,"dir":"Reference","previous_headings":"","what":"Pipe operator — %>%","title":"Pipe operator — %>%","text":"See magrittr::%>% details.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/pipe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pipe operator — %>%","text":"","code":"lhs %>% rhs"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/pipe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pipe operator — %>%","text":"lhs value magrittr placeholder. rhs function call using magrittr semantics.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/pipe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pipe operator — %>%","text":"result calling rhs(lhs).","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/prepare_atmosphere_input.html","id":null,"dir":"Reference","previous_headings":"","what":"Prepare Atmosphere Input — prepare_atmosphere_input","title":"Prepare Atmosphere Input — prepare_atmosphere_input","text":"Prepare Atmosphere Input","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/prepare_atmosphere_input.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Prepare Atmosphere Input — prepare_atmosphere_input","text":"","code":"prepare_atmosphere_input(inputs, defaults = defaults_atmosphere())"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/prepare_atmosphere_input.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Prepare Atmosphere Input — prepare_atmosphere_input","text":"inputs tibble data.frame user defined inputs parameters defined get_atmosphere_headers defaults defaults undefined parameters. Default: defaults_atmosphere","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/prepare_atmosphere_input.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Prepare Atmosphere Input — prepare_atmosphere_input","text":"tibble atmosphere values","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/prepare_atmosphere_input.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Prepare Atmosphere Input — prepare_atmosphere_input","text":"","code":"inputs <- tibble::tibble(tAtm = 1:10, Prec = 10, rSoil = 0.4) prepare_atmosphere_input(inputs) #> # A tibble: 10 × 14 #> tAtm Prec rSoil rRoot hCritA rB hB ht tTop tBot Ampl cTop #> #> 1 1 10 0.4 0 100000 0 0 0 0 0 0 0 #> 2 2 10 0.4 0 100000 0 0 0 0 0 0 0 #> 3 3 10 0.4 0 100000 0 0 0 0 0 0 0 #> 4 4 10 0.4 0 100000 0 0 0 0 0 0 0 #> 5 5 10 0.4 0 100000 0 0 0 0 0 0 0 #> 6 6 10 0.4 0 100000 0 0 0 0 0 0 0 #> 7 7 10 0.4 0 100000 0 0 0 0 0 0 0 #> 8 8 10 0.4 0 100000 0 0 0 0 0 0 0 #> 9 9 10 0.4 0 100000 0 0 0 0 0 0 0 #> 10 10 10 0.4 0 100000 0 0 0 0 0 0 0 #> # ℹ 2 more variables: cBot , RootDepth "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":null,"dir":"Reference","previous_headings":"","what":"Read A_LEVEL.out — read_alevel","title":"Read A_LEVEL.out — read_alevel","text":"-level information printed time time-dependent boundary condition specified. information directed output file A_LEVEL..","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read A_LEVEL.out — read_alevel","text":"","code":"read_alevel(path, dbg = FALSE)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read A_LEVEL.out — read_alevel","text":"path full path A_LEVEL.file dbg show debug messages (default: FALSE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read A_LEVEL.out — read_alevel","text":"imports A_LEVEL tidy column names saves metainformation attributes 'meta_general' 'meta_units' time Time, t, current time-level [T] sum_r_top Cumulative potential surface flux [L] (infiltration/evaporation: -/+) sum_r_root Cumulative potential transpiration [L] sum_v_top Cumulative value actual surface flux [L] (infiltration/evaporation: -/+) [-] sum_v_root Cumulative value actual transpiration [L] sum_v_bot Cumulative value bottom boundary flux [L] (inflow/outflow: +/-) h_top Pressure head soil surface [L] h_root Mean value pressure head soil root zone Beta(n)>0 [L] h_bot Pressure head bottom soil profile [L] a_level -level number (current variable boundary condition number) [-]","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Read A_LEVEL.out — read_alevel","text":"https://www.pc-progress.com/Downloads/Pgm_Hydrus1D/HYDRUS1D-4.17.pdf#page=277","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read A_LEVEL.out — read_alevel","text":"","code":"path_alevel <- system.file(\"extdata/model/test/A_LEVEL.out\", package = \"kwb.hydrus1d\") alevel <- read_alevel(path = path_alevel) alevel #> # A tibble: 81 × 10 #> time sum_r_top sum_r_root sum_v_top sum_v_root sum_v_bot h_top h_root #> * #> 1 1 0.25 0 0.0698 0 -0.00173 -1 e5 0 #> 2 2 -0.2 0 -0.380 0 -0.00346 -8.35e1 0 #> 3 3 -0.02 0 -0.200 0 -0.00520 -2.00e3 0 #> 4 4 -0.14 0 -0.320 0 -0.00693 -1.05e2 0 #> 5 5 -0.13 0 -0.310 0 -0.00866 -1.25e2 0 #> 6 6 -0.0000000270 0 -0.209 0 -0.0104 -1 e5 0 #> 7 7 0.22 0 -0.177 0 -0.0121 -1 e5 0 #> 8 8 0.27 0 -0.161 0 -0.0139 -1 e5 0 #> 9 9 0.45 0 -0.146 0 -0.0156 -1 e5 0 #> 10 10 0.63 0 -0.135 0 -0.0173 -1 e5 0 #> # ℹ 71 more rows #> # ℹ 2 more variables: h_bot , a_level "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_atmosph.html","id":null,"dir":"Reference","previous_headings":"","what":"Read ATMOSPH.in — read_atmosph","title":"Read ATMOSPH.in — read_atmosph","text":"Read ATMOSPH.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_atmosph.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read ATMOSPH.in — read_atmosph","text":"","code":"read_atmosph( path = system.file(\"extdata/model/test/ATMOSPH.in\", package = \"kwb.hydrus1d\") )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_atmosph.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read ATMOSPH.in — read_atmosph","text":"path path ATMOSPH.(default: system.file(\"extdata/model/test/ATMOSPH.\", package = \"kwb.hydrus1d\"))","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_atmosph.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read ATMOSPH.in — read_atmosph","text":"list atmospheric config parameter sublist time series sublist","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_meta_general.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper Function: Read Meta General — read_meta_general","title":"Helper Function: Read Meta General — read_meta_general","text":"Helper Function: Read Meta General","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_meta_general.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper Function: Read Meta General — read_meta_general","text":"","code":"read_meta_general(content_general)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_meta_general.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper Function: Read Meta General — read_meta_general","text":"content_general lines content general (see example)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_meta_general.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper Function: Read Meta General — read_meta_general","text":"tibble columns description, modelstart_datetime unit L,T,M","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_meta_general.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Helper Function: Read Meta General — read_meta_general","text":"","code":"path_tlevel <- system.file(\"extdata/model/test/T_LEVEL.out\", package = \"kwb.hydrus1d\") content <- readLines(path_tlevel) content_general <- content[3:5] cat(content_general) #> Flextreat Hydraulic Model Date: 30. 6.2022 Time: 12:49:10 Units: L = cm , T = days , M = mmol read_meta_general(content_general) #> # A tibble: 1 × 5 #> description modelstart_datetime unit_L unit_T unit_M #> #> 1 Flextreat Hydraulic Model 30.6.2022 12:49:10 cm days mmol"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_obsnode.html","id":null,"dir":"Reference","previous_headings":"","what":"Read Obs_Node.out — read_obsnode","title":"Read Obs_Node.out — read_obsnode","text":"Read Obs_Node.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_obsnode.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read Obs_Node.out — read_obsnode","text":"","code":"read_obsnode(path, to_longer = TRUE)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_obsnode.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read Obs_Node.out — read_obsnode","text":"path path Obs_Node.to_longer convert table longer format (default: TRUE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":null,"dir":"Reference","previous_headings":"","what":"Read Run_Inf.out — read_runinf","title":"Read Run_Inf.out — read_runinf","text":"Contains time iteration information","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read Run_Inf.out — read_runinf","text":"","code":"read_runinf(path, dbg = FALSE)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read Run_Inf.out — read_runinf","text":"path full path Run_Inf.file dbg show debug messages (default: FALSE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read Run_Inf.out — read_runinf","text":"imports Run_Inf.tidy column names saves metainformation attributes 'meta_general' 'meta_units' tlevel Time-level (current time-step number) [-] time Time, t, current time-level [T] dt Time step, delta t [T] itr_w Number iterations necessary solution water flow equation [-] itr_c Number iterations necessary solution solute transport equation [-] it_cum Cumulative number iterations [-] kod_t Code boundary condition soil surface kod_b Code boundary condition bottom soil profile converg Information whether numerical convergence achieved current time-level peclet Maximum local Peclet number [-] courant Maximum local Courant number [-]","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Read Run_Inf.out — read_runinf","text":"https://www.pc-progress.com/Downloads/Pgm_Hydrus1D/HYDRUS1D-4.17.pdf#page=272","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read Run_Inf.out — read_runinf","text":"","code":"path_runinf <- system.file(\"extdata/model/test/Run_Inf.out\", package = \"kwb.hydrus1d\") runinf <- read_runinf(path = path_runinf) runinf #> # A tibble: 2,272 × 11 #> t_level time dt itr_w itr_c it_cum kod_t kod_b converg peclet courant #> * #> 1 1 0.111 0.111 5 1 25 -4 -5 TRUE 0.1 0.18 #> 2 2 0.148 0.0370 3 1 38 -4 -5 TRUE 0.1 0.075 #> 3 3 0.164 0.0160 2 1 50 -4 -5 TRUE 0.1 0.034 #> 4 4 0.171 0.00695 2 1 62 -4 -5 TRUE 0.1 0.015 #> 5 5 0.180 0.00904 3 1 65 -4 -5 TRUE 0.1 0.009 #> 6 6 0.184 0.00392 2 1 77 4 -5 TRUE 0.1 0.003 #> 7 7 0.189 0.00509 2 1 79 4 -5 TRUE 0.1 0.004 #> 8 8 0.196 0.00662 2 1 81 4 -5 TRUE 0.1 0.006 #> 9 9 0.204 0.00861 2 1 83 4 -5 TRUE 0.1 0.007 #> 10 10 0.216 0.0112 2 1 85 4 -5 TRUE 0.1 0.009 #> # ℹ 2,262 more rows"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":null,"dir":"Reference","previous_headings":"","what":"Read solute1.out — read_solute","title":"Read solute1.out — read_solute","text":"Reads Solute output","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read solute1.out — read_solute","text":"","code":"read_solute( path = system.file(\"extdata/model/test/solute1.out\", package = \"kwb.hydrus1d\"), dbg = FALSE )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read solute1.out — read_solute","text":"path full path solute_id.file (default: system.file(\"extdata/model/test/solute1.\", package = \"kwb.hydrus1d\")) dbg show debug messages (default: FALSE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read solute1.out — read_solute","text":"imports solute_id.tidy column names saves metainformation attributes 'meta_general' 'meta_units' time Time, t, current time-level [T] cv_top Actual solute flux across soil surface [ML-2 T -1] (inflow/outflow: +/-) cv_bot Actual solute flux across bottom soil profile [ML-2 T -1] (inflow/outflow: +/-) sum_cv_top Cumulative solute flux across soil surface [ML-2] (inflow/outflow: +/-) sum_cv_bot Cumulative solute flux across bottom soil profile [ML-2] (inflow/outflow: +/-) sum_cv_ch0 Cumulative amount solute added flow region zero-order reactions [ML-2] (negative removed system) sum_cv_ch1 Cumulative amount solute removed flow region first-order reactions [ML-2] (negative removed system). c_top Solute concentration soil surface [ML-3] c_root Mean solute concentration root zone [ML-3] c_bot Solute concentration bottom soil profile [ML-3] cv_root Actual root solute uptake root zone [ML-2 T -1] (positive removed system) sum_cv_root Cumulative amount solute removed flow region root water uptake S [ML-2] (positive removed system) sum_cv_n_eql Cumulative mass transfer either kinetic adsorption sites (type-2 adsorption sites), immobile liquid region [ML-2] (inflow/outflow: +/-). t_level Time-level (current time-step number) [-] c_gwl Average concentration saturated zone [ML-3] (groundwater) c_run_off Solute flux runoff ([ML-3] * [LT-1]) [ML-2T-1] sum_c_run_off Cumulative solute flux runoff ([ML-3] * [LT-1]* [T]) [ML-2] cv_i Solute flux first third observation node ([ML-3] * [LT-1]) [ML-2T-1] sum_cv_i cumulative solute flux first third observation node ([ML-3] * [LT-1] * [T]) [ML-2]. Total solute fluxes reported one solute simulated. convective fluxes (first solute) reported 2 solutes simulated","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Read solute1.out — read_solute","text":"https://www.pc-progress.com/Downloads/Pgm_Hydrus1D/HYDRUS1D-4.17.pdf#page=273","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read solute1.out — read_solute","text":"","code":"path_solute <- system.file(\"extdata/model/test/solute1.out\", package = \"kwb.hydrus1d\") solute <- read_solute(path = path_solute) solute #> # A tibble: 2,272 × 19 #> time cv_top cv_bot sum_cv_top sum_cv_bot cv_ch0 cv_ch1 c_top c_root c_bot #> * #> 1 0.111 0 0 0 0 0 0 0 0 0 #> 2 0.148 0 0 0 0 0 0 0 0 0 #> 3 0.164 0 0 0 0 0 0 0 0 0 #> 4 0.171 0 0 0 0 0 0 0 0 0 #> 5 0.180 0 0 0 0 0 0 0 0 0 #> 6 0.184 0 0 0 0 0 0 0 0 0 #> 7 0.189 0 0 0 0 0 0 0 0 0 #> 8 0.196 0 0 0 0 0 0 0 0 0 #> 9 0.204 0 0 0 0 0 0 0 0 0 #> 10 0.216 0 0 0 0 0 0 0 0 0 #> # ℹ 2,262 more rows #> # ℹ 9 more variables: cv_root , sum_cv_root , sum_cv_n_eql , #> # t_level , c_gwl , c_run_off , sum_c_run_off , #> # cv_i , sum_cv_i "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":null,"dir":"Reference","previous_headings":"","what":"Read T_LEVEL.out — read_tlevel","title":"Read T_LEVEL.out — read_tlevel","text":"Stores pressure heads fluxes boundaries root zone.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read T_LEVEL.out — read_tlevel","text":"","code":"read_tlevel(path, dbg = FALSE)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read T_LEVEL.out — read_tlevel","text":"path full path T_LEVEL.file dbg show debug messages (default: FALSE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read T_LEVEL.out — read_tlevel","text":"imports T_LEVEL tidy column names saves metainformation attributes 'meta_general' 'meta_units' time Time, t, current time-level [T] r_top Potential surface flux [LT-1] (infiltration/evaporation: -/+) r_root Potential transpiration rate [LT-1] v_top Actual surface flux [LT-1] (infiltration/evaporation: -/+) v_root Actual transpiration rate [LT-1] v_bot Actual flux across bottom soil profile [LT-1] (inflow/outflow +/-) sum_r_top Cumulative value potential surface flux [L] (infiltration/evaporation: -/+) sum_r_root Cumulative value potential transpiration rate [L] sum_v_top Cumulative value actual surface flux [L] sum_v_root Cumulative value actual transpiration rate [L] (infiltration/evaporation: -/+) sum_v_bot Cumulative value actual flux across bottom soil profile [LT-1] (inflow/outflow +/-) h_top Pressure head soil surface [L] h_root Mean value pressure head region Beta(n) > 0 (.e. within root zone) [L] h_bot Pressure head bottom soil profile [L] run_off Surface runoff [LT-1] sum_run_off Cumulative surface runoff [L] volume Volume water entire flow domain [L] sum_infil Cumulative infiltration [L] sum_evap Cumulative actual evaporation [L] t_level Time-level (current time-step number) [-] cum_w_trans Cumulative mass transfer mobile immobile regions dual porosity model [L] snow_layer Thickness snow layer, expressed \"snow water equivalent\" (amount water contained within snowpack) [L]","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Read T_LEVEL.out — read_tlevel","text":"https://www.pc-progress.com/Downloads/Pgm_Hydrus1D/HYDRUS1D-4.17.pdf#page=271","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read T_LEVEL.out — read_tlevel","text":"","code":"path_tlevel <- system.file(\"extdata/model/test/T_LEVEL.out\", package = \"kwb.hydrus1d\") tlevel <- read_tlevel(path = path_tlevel) tlevel #> # A tibble: 2,272 × 22 #> time r_top r_root v_top v_root v_bot sum_r_top sum_r_root sum_v_top #> * #> 1 0.111 0.25 0 0.25 0 -0.00173 0.0278 0 0.0278 #> 2 0.148 0.25 0 0.25 0 -0.00173 0.0370 0 0.0370 #> 3 0.164 0.25 0 0.25 0 -0.00173 0.0410 0 0.0410 #> 4 0.171 0.25 0 0.25 0 -0.00173 0.0428 0 0.0428 #> 5 0.180 0.25 0 0.0977 0 -0.00173 0.0450 0 0.0437 #> 6 0.184 0.25 0 0.0786 0 -0.00173 0.0460 0 0.0440 #> 7 0.189 0.25 0 0.0819 0 -0.00173 0.0473 0 0.0444 #> 8 0.196 0.25 0 0.0840 0 -0.00173 0.0490 0 0.0450 #> 9 0.204 0.25 0 0.0816 0 -0.00173 0.0511 0 0.0457 #> 10 0.216 0.25 0 0.0774 0 -0.00173 0.0539 0 0.0465 #> # ℹ 2,262 more rows #> # ℹ 13 more variables: sum_v_root , sum_v_bot , h_top , #> # h_root , h_bot , run_off , sum_run_off , volume , #> # sum_infil , sum_evap , t_level , cum_w_trans , #> # snow_layer "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/run_model.html","id":null,"dir":"Reference","previous_headings":"","what":"Run Model — run_model","title":"Run Model — run_model","text":"Run Model","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/run_model.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run Model — run_model","text":"","code":"run_model( exe_path = check_hydrus_exe(), model_path = system.file(\"extdata/model/test\", package = \"kwb.hydrus1d\"), ... )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/run_model.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run Model — run_model","text":"exe_path path Hydrus1D executable v4.17.040 (default: retrieved check_hydrus_exe) model_path path model directory (default: system.file(\"extdata/model/test\", package = \"kwb.hydrus1d\")) ... additional arguments passed shell","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/run_model.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run Model — run_model","text":"runs HYDRUS 1D model","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/run_model.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Run Model — run_model","text":"","code":"run_model() #> Checking if download of HYDRUS1D executable v4.17.0140 from 'https://github.com/mrustl/hydrus1d/archive/refs/tags/v4.17.0140.zip' was successful ... ok. (0.00 secs) #> Warning: 'cd D:/a/_temp/Library/kwb.hydrus1d/extdata/model && H1D_CALC.exe' execution failed with error code 1"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/write_atmosphere.html","id":null,"dir":"Reference","previous_headings":"","what":"Write ","title":"Write ","text":"Write \"ATMOSPH.\" input file","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/write_atmosphere.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Write ","text":"","code":"write_atmosphere( atm, MaxAL = 365, DailyVar = FALSE, SinusVar = FALSE, lLai = FALSE, lBCCycles = FALSE, lInterc = FALSE, hCritS = 0, round_digits = 2, remove_scientific = TRUE )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/write_atmosphere.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Write ","text":"atm tibble input data defined prepare_atmospherice_input MaxAL Number meteorological records DailyVar TRUE HYDRUS-1D generate daily variations evaporation transpiration (see section 2.7.2.)., otherwise: FALSE (default: FALSE) SinusVar TRUE HYDRUS-1D generate sinusoidal variations precipitation (see section 2.7.2.), otherwise: FALSE(default: FALSE) lLai Logical variable indicating potential evapotranspiration divided potential evaporation potential transpiration using eq. (2.75). (default: FALSE) lBCCycles TRUE set boundary conditions repeated multiple times, otherwise FALSE(default: FALSE) lInterc TRUE interception considered using eq. (2.78), otherwise FALSE (default: FALSE) hCritS Maximum allowed pressure head soil surface (L). (default: 0) round_digits digits used rounding values (default: 2) columns besides \"tAtm\" remove_scientific TRUE scientific notation numbers removed, otherwise (default: TRUE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/write_atmosphere.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Write ","text":"Creates ATMOSPH.input textfile","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/write_atmosphere.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Write ","text":"","code":"inputs <- tibble::tibble(tAtm = 1:10, Prec = 10, rSoil = 0.4) atm <- prepare_atmosphere_input(inputs) atm #> # A tibble: 10 × 14 #> tAtm Prec rSoil rRoot hCritA rB hB ht tTop tBot Ampl cTop #> #> 1 1 10 0.4 0 100000 0 0 0 0 0 0 0 #> 2 2 10 0.4 0 100000 0 0 0 0 0 0 0 #> 3 3 10 0.4 0 100000 0 0 0 0 0 0 0 #> 4 4 10 0.4 0 100000 0 0 0 0 0 0 0 #> 5 5 10 0.4 0 100000 0 0 0 0 0 0 0 #> 6 6 10 0.4 0 100000 0 0 0 0 0 0 0 #> 7 7 10 0.4 0 100000 0 0 0 0 0 0 0 #> 8 8 10 0.4 0 100000 0 0 0 0 0 0 0 #> 9 9 10 0.4 0 100000 0 0 0 0 0 0 0 #> 10 10 10 0.4 0 100000 0 0 0 0 0 0 0 #> # ℹ 2 more variables: cBot , RootDepth atm_string <- write_atmosphere(atm = atm, MaxAL = nrow(atm)) cat(atm_string) #> Pcp_File_Version=4 #> *** BLOCK I: ATMOSPHERIC INFORMATION ********************************** #> MaxAL (MaxAL = number of atmospheric data-records) #> 10 #> DailyVar SinusVar lLay lBCCycles lInterc lDummy lDummy lDummy lDummy lDummy #> f f f f f f f f f f #> hCritS (max. allowed pressure head at the soil surface) #> 0 #> tAtm Prec rSoil rRoot hCritA rB hB ht tTop tBot Ampl cTop cBot RootDepth #> 1 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 2 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 3 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 4 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 5 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 6 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 7 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 8 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 9 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 10 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> end*** END OF INPUT FILE 'ATMOSPH.IN' **********************************"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/news/index.html","id":"kwbhydrus1d-0009000","dir":"Changelog","previous_headings":"","what":"kwb.hydrus1d 0.0.0.9000","title":"kwb.hydrus1d 0.0.0.9000","text":"Added NEWS.md file track changes package. see https://style.tidyverse.org/news.html writing good NEWS.md","code":""}] +[{"path":"https://kwb-r.github.io/kwb.hydrus1d/articles/workflow.html","id":"install-r-package","dir":"Articles","previous_headings":"","what":"Install R Package","title":"Workflow","text":"","code":"# Enable this universe options(repos = c( kwbr = 'https://kwb-r.r-universe.dev', CRAN = 'https://cloud.r-project.org')) # Install R package install.packages('kwb.hydrus1d')"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/articles/workflow.html","id":"define-paths","dir":"Articles","previous_headings":"","what":"Define Paths","title":"Workflow","text":"","code":"paths_list <- list( exe_dir = system.file(\"extdata/model\", package = \"kwb.hydrus1d\"), model_name = \"test\", model_dir = \"/\", atmosphere = \"/ATMOSPH.IN\", a_level = \"/A_LEVEL.out\", t_level = \"/T_LEVEL.out\", runinf = \"/Run_Inf.out\", solute_id = 1L, solute = \"/solute.out\" ) paths <- kwb.utils::resolve(paths_list)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/articles/workflow.html","id":"run-model","dir":"Articles","previous_headings":"","what":"Run Model","title":"Workflow","text":"","code":"exe_path <- kwb.hydrus1d::check_hydrus_exe(dir = paths$exe_dir, skip_preinstalled = TRUE) #> Checking if download of HYDRUS1D executable v4.17.0140 from 'https://github.com/mrustl/hydrus1d/archive/refs/tags/v4.17.0140.zip' was successful ... ok. (0.00 secs) kwb.hydrus1d::run_model(exe_path = exe_path, model_path = paths$model_dir) #> Warning in shell(cmd = sprintf(\"cd %s && %s\", fs::path_abs(target_dir), : 'cd #> D:/a/_temp/Library/kwb.hydrus1d/extdata/model && H1D_CALC.exe' execution failed #> with error code 24"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/articles/workflow.html","id":"read-results","dir":"Articles","previous_headings":"","what":"Read Results","title":"Workflow","text":"","code":"a_level <- kwb.hydrus1d::read_alevel(paths$a_level) a_level #> # A tibble: 1,279 × 10 #> time sum_r_top sum_r_root sum_v_top sum_v_root sum_v_bot h_top h_root #> * #> 1 1 0.25 0 0.0698 0 -0.00173 -1 e5 0 #> 2 2 -0.2 0 -0.380 0 -0.00346 -8.35e1 0 #> 3 3 -0.02 0 -0.200 0 -0.00520 -2.00e3 0 #> 4 4 -0.14 0 -0.320 0 -0.00693 -1.05e2 0 #> 5 5 -0.13 0 -0.310 0 -0.00866 -1.25e2 0 #> 6 6 -0.0000000270 0 -0.209 0 -0.0104 -1 e5 0 #> 7 7 0.22 0 -0.177 0 -0.0121 -1 e5 0 #> 8 8 0.27 0 -0.161 0 -0.0139 -1 e5 0 #> 9 9 0.45 0 -0.146 0 -0.0156 -1 e5 0 #> 10 10 0.63 0 -0.135 0 -0.0173 -1 e5 0 #> # ℹ 1,269 more rows #> # ℹ 2 more variables: h_bot , a_level t_level <- kwb.hydrus1d::read_tlevel(paths$t_level) t_level #> # A tibble: 17,649 × 22 #> time r_top r_root v_top v_root v_bot sum_r_top sum_r_root sum_v_top #> * #> 1 0.111 0.25 0 0.25 0 -0.00173 0.0278 0 0.0278 #> 2 0.148 0.25 0 0.25 0 -0.00173 0.0370 0 0.0370 #> 3 0.164 0.25 0 0.25 0 -0.00173 0.0410 0 0.0410 #> 4 0.171 0.25 0 0.25 0 -0.00173 0.0428 0 0.0428 #> 5 0.180 0.25 0 0.0977 0 -0.00173 0.0450 0 0.0437 #> 6 0.184 0.25 0 0.0786 0 -0.00173 0.0460 0 0.0440 #> 7 0.189 0.25 0 0.0819 0 -0.00173 0.0473 0 0.0444 #> 8 0.196 0.25 0 0.0840 0 -0.00173 0.0490 0 0.0450 #> 9 0.204 0.25 0 0.0816 0 -0.00173 0.0511 0 0.0457 #> 10 0.216 0.25 0 0.0774 0 -0.00173 0.0539 0 0.0465 #> # ℹ 17,639 more rows #> # ℹ 13 more variables: sum_v_root , sum_v_bot , h_top , #> # h_root , h_bot , run_off , sum_run_off , volume , #> # sum_infil , sum_evap , t_level , cum_w_trans , #> # snow_layer runinf <- kwb.hydrus1d::read_runinf(paths$runinf) runinf #> # A tibble: 17,649 × 11 #> t_level time dt itr_w itr_c it_cum kod_t kod_b converg peclet courant #> * #> 1 1 0.111 0.111 5 1 25 -4 -5 TRUE 0.1 0.18 #> 2 2 0.148 0.0370 3 1 38 -4 -5 TRUE 0.1 0.075 #> 3 3 0.164 0.0160 2 1 50 -4 -5 TRUE 0.1 0.034 #> 4 4 0.171 0.00695 2 1 62 -4 -5 TRUE 0.1 0.015 #> 5 5 0.180 0.00904 3 1 65 -4 -5 TRUE 0.1 0.009 #> 6 6 0.184 0.00392 2 1 77 4 -5 TRUE 0.1 0.003 #> 7 7 0.189 0.00509 2 1 79 4 -5 TRUE 0.1 0.004 #> 8 8 0.196 0.00662 2 1 81 4 -5 TRUE 0.1 0.006 #> 9 9 0.204 0.00861 2 1 83 4 -5 TRUE 0.1 0.007 #> 10 10 0.216 0.0112 2 1 85 4 -5 TRUE 0.1 0.009 #> # ℹ 17,639 more rows solute <- kwb.hydrus1d::read_solute(paths$solute) solute #> # A tibble: 17,649 × 19 #> time cv_top cv_bot sum_cv_top sum_cv_bot cv_ch0 cv_ch1 c_top c_root c_bot #> * #> 1 0.111 0 0 0 0 0 0 0 0 0 #> 2 0.148 0 0 0 0 0 0 0 0 0 #> 3 0.164 0 0 0 0 0 0 0 0 0 #> 4 0.171 0 0 0 0 0 0 0 0 0 #> 5 0.180 0 0 0 0 0 0 0 0 0 #> 6 0.184 0 0 0 0 0 0 0 0 0 #> 7 0.189 0 0 0 0 0 0 0 0 0 #> 8 0.196 0 0 0 0 0 0 0 0 0 #> 9 0.204 0 0 0 0 0 0 0 0 0 #> 10 0.216 0 0 0 0 0 0 0 0 0 #> # ℹ 17,639 more rows #> # ℹ 9 more variables: cv_root , sum_cv_root , sum_cv_n_eql , #> # t_level , c_gwl , c_run_off , sum_c_run_off , #> # cv_i , sum_cv_i "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Michael Rustler. Author, maintainer. Hauke Sonnenberg. Contributor. . Funder. . Copyright holder.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Rustler M (2024). kwb.hydrus1d: R Interface Last Official Release Hydrus1D (V4.17.0140) Windows. R package version 0.0.0.9000, https://github.com/KWB-R/kwb.hydrus1d.","code":"@Manual{, title = {kwb.hydrus1d: R Interface for the Last Official Release of Hydrus1D (V4.17.0140) for Windows}, author = {Michael Rustler}, year = {2024}, note = {R package version 0.0.0.9000}, url = {https://github.com/KWB-R/kwb.hydrus1d}, }"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"R Interface for the Last Official Release of Hydrus1D (V4.17.0140) for Windows","text":"installing latest release R package run following code :","code":"# Enable repository from kwb-r options(repos = c( kwbr = 'https://kwb-r.r-universe.dev', CRAN = 'https://cloud.r-project.org')) # Download and install kwb.hydrus1d in R install.packages('kwb.hydrus1d') # Browse the kwb.swmm manual pages help(package = 'kwb.hydrus1d')"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"R Interface for the Last Official Release of Hydrus1D (V4.17.0140) for Windows","text":"Checkout Workflow article use R package.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2022 Kompetenzzentrum Wasser Berlin gGmbH (KWB) Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/check_hydrus_exe.html","id":null,"dir":"Reference","previous_headings":"","what":"Check HYDRUS Executable and download if needed — check_hydrus_exe","title":"Check HYDRUS Executable and download if needed — check_hydrus_exe","text":"Check HYDRUS Executable download needed","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/check_hydrus_exe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check HYDRUS Executable and download if needed — check_hydrus_exe","text":"","code":"check_hydrus_exe( dir = file.path(system.file(package = \"kwb.hydrus1d\"), \"extdata/hydrus1d\"), skip_preinstalled = FALSE )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/check_hydrus_exe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check HYDRUS Executable and download if needed — check_hydrus_exe","text":"dir target directory (default: file.path(system.file(package = \"kwb.hydrus1d\"), \"extdata/hydrus1d\"), case compliant HYDRUS1D version available, executable downloaded https://github.com/mrustl/hydrus1d/archive/refs/tags/v4.17.0140.zip skip_preinstalled TRUE checking preinstalled HYDRUS-1D skipped executable downloaded, otherwise (default)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/check_hydrus_exe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check HYDRUS Executable and download if needed — check_hydrus_exe","text":"path preinstalled HYDRUS-1D executable (compliant parameter skip_preinstalled == FALSE), otherwise path downloaded HYDRUS-1D","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/check_hydrus_exe.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check HYDRUS Executable and download if needed — check_hydrus_exe","text":"","code":"check_hydrus_exe(skip_preinstalled = FALSE) #> Checking if download of HYDRUS1D executable v4.17.0140 from 'https://github.com/mrustl/hydrus1d/archive/refs/tags/v4.17.0140.zip' was successful ... ok. (0.00 secs) check_hydrus_exe(skip_preinstalled = TRUE) #> Checking if download of HYDRUS1D executable v4.17.0140 from 'https://github.com/mrustl/hydrus1d/archive/refs/tags/v4.17.0140.zip' was successful ... ok. (0.00 secs)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/defaults_atmosphere.html","id":null,"dir":"Reference","previous_headings":"","what":"Defaults for Atmosphere — defaults_atmosphere","title":"Defaults for Atmosphere — defaults_atmosphere","text":"Defaults Atmosphere","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/defaults_atmosphere.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Defaults for Atmosphere — defaults_atmosphere","text":"","code":"defaults_atmosphere( Prec = 0L, rSoil = 0L, rRoot = 0L, hCritA = 100000L, rB = 0L, hB = 0L, ht = 0L, tTop = 0L, tBot = 0L, Ampl = 0L, cTop = 0L, cBot = 0L, RootDepth = 0L )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/defaults_atmosphere.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Defaults for Atmosphere — defaults_atmosphere","text":"Prec Precipitation (default: 0) rSoil Evaporation (default: 0) rRoot Transpiration (default: 0) hCritA (default: 100000) rB rB (default: 0) hB hB (default: 0) ht ht (default: 0) tTop tTop (default: 0) tBot tBot (default: 0) Ampl Ampl (default: 0) cTop concentration solute 1 top (default: 0) cBot concentration solute 1 bottom (default: 0) RootDepth root depth (default: 0)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/defaults_atmosphere.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Defaults for Atmosphere — defaults_atmosphere","text":"tibble defaults atmospheric parameters","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/defaults_atmosphere.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Defaults for Atmosphere — defaults_atmosphere","text":"","code":"defaults_atmosphere() #> # A tibble: 1 × 13 #> Prec rSoil rRoot hCritA rB hB ht tTop tBot Ampl cTop cBot #> #> 1 0 0 0 100000 0 0 0 0 0 0 0 0 #> # ℹ 1 more variable: RootDepth "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_atmosphere_headers.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Atmosphere Headers — get_atmosphere_headers","title":"Get Atmosphere Headers — get_atmosphere_headers","text":"Get Atmosphere Headers","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_atmosphere_headers.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Atmosphere Headers — get_atmosphere_headers","text":"","code":"get_atmosphere_headers()"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_atmosphere_headers.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Atmosphere Headers — get_atmosphere_headers","text":"vector atmosphere headers \"ATMOSPH.\"","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_atmosphere_headers.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Atmosphere Headers — get_atmosphere_headers","text":"","code":"get_atmosphere_headers() #> [1] \"tAtm\" \"Prec\" \"rSoil\" \"rRoot\" \"hCritA\" \"rB\" #> [7] \"hB\" \"ht\" \"tTop\" \"tBot\" \"Ampl\" \"cTop\" #> [13] \"cBot\" \"RootDepth\""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_output_meta.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","title":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","text":"Helper Function: Get Metadata Outputs ('A_LEVEL.', 'T_LEVEL.')","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_output_meta.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","text":"","code":"get_output_meta(output)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_output_meta.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","text":"output imported output retrieved read_alevel read_tlevel","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_output_meta.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","text":"returns metainformation list sublists \"general\" \"units\" imported 'A_LEVEL.' 'T_LEVEL.' file","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_output_meta.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Helper Function: Get Metadata of Outputs ('A_LEVEL.out', 'T_LEVEL.out') — get_output_meta","text":"","code":"test_file <- function(x) system.file(\"extdata/model/test\", x, package = \"kwb.hydrus1d\") alevel <- read_alevel(path = test_file(\"A_LEVEL.out\")) get_output_meta(alevel) #> $general #> NULL #> #> $units #> # A tibble: 10 × 3 #> name col_width unit_general #> #> 1 time 12 \"T\" #> 2 sum_r_top 14 \"L\" #> 3 sum_r_root 14 \"L\" #> 4 sum_v_top 14 \"L\" #> 5 sum_v_root 14 \"L\" #> 6 sum_v_bot 14 \"L\" #> 7 h_top 11 \"L\" #> 8 h_root 11 \"L\" #> 9 h_bot 11 \"L\" #> 10 a_level 8 \"\" #> tlevel <- read_tlevel(path = test_file(\"T_LEVEL.out\")) get_output_meta(tlevel) #> $general #> # A tibble: 1 × 5 #> description modelstart_datetime unit_L unit_T unit_M #> #> 1 Flextreat Hydraulic Model 30.6.2022 12:49:10 cm days mmol #> #> $units #> # A tibble: 22 × 4 #> name col_width unit_general unit #> #> 1 time 13 T days #> 2 r_top 13 L/T cm/days #> 3 r_root 13 L/T cm/days #> 4 v_top 13 L/T cm/days #> 5 v_root 13 L/T cm/days #> 6 v_bot 13 L/T cm/days #> 7 sum_r_top 13 L cm #> 8 sum_r_root 13 L cm #> 9 sum_v_top 13 L cm #> 10 sum_v_root 13 L cm #> # ℹ 12 more rows #>"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_units_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper function: get units list from meta general — get_units_list","title":"Helper function: get units list from meta general — get_units_list","text":"Helper function: get units list meta general","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_units_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper function: get units list from meta general — get_units_list","text":"","code":"get_units_list(meta_general)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_units_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper function: get units list from meta general — get_units_list","text":"meta_general retrieved read_meta_general","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_units_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper function: get units list from meta general — get_units_list","text":"list elements unit_L, unit_T unit_M","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/get_units_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Helper function: get units list from meta general — get_units_list","text":"","code":"path_tlevel <- system.file(\"extdata/model/test/T_LEVEL.out\", package = \"kwb.hydrus1d\") content <- readLines(path_tlevel) content_general <- content[3:5] cat(content_general) #> Flextreat Hydraulic Model Date: 30. 6.2022 Time: 12:49:10 Units: L = cm , T = days , M = mmol meta_general <- read_meta_general(content_general) get_units_list(meta_general) #> $L #> [1] \"cm\" #> #> $T #> [1] \"days\" #> #> $M #> [1] \"mmol\" #>"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/pipe.html","id":null,"dir":"Reference","previous_headings":"","what":"Pipe operator — %>%","title":"Pipe operator — %>%","text":"See magrittr::%>% details.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/pipe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pipe operator — %>%","text":"","code":"lhs %>% rhs"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/pipe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pipe operator — %>%","text":"lhs value magrittr placeholder. rhs function call using magrittr semantics.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/pipe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pipe operator — %>%","text":"result calling rhs(lhs).","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/prepare_atmosphere_input.html","id":null,"dir":"Reference","previous_headings":"","what":"Prepare Atmosphere Input — prepare_atmosphere_input","title":"Prepare Atmosphere Input — prepare_atmosphere_input","text":"Prepare Atmosphere Input","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/prepare_atmosphere_input.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Prepare Atmosphere Input — prepare_atmosphere_input","text":"","code":"prepare_atmosphere_input(inputs, defaults = defaults_atmosphere())"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/prepare_atmosphere_input.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Prepare Atmosphere Input — prepare_atmosphere_input","text":"inputs tibble data.frame user defined inputs parameters defined get_atmosphere_headers defaults defaults undefined parameters. Default: defaults_atmosphere","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/prepare_atmosphere_input.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Prepare Atmosphere Input — prepare_atmosphere_input","text":"tibble atmosphere values","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/prepare_atmosphere_input.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Prepare Atmosphere Input — prepare_atmosphere_input","text":"","code":"inputs <- tibble::tibble(tAtm = 1:10, Prec = 10, rSoil = 0.4) prepare_atmosphere_input(inputs) #> # A tibble: 10 × 14 #> tAtm Prec rSoil rRoot hCritA rB hB ht tTop tBot Ampl cTop #> #> 1 1 10 0.4 0 100000 0 0 0 0 0 0 0 #> 2 2 10 0.4 0 100000 0 0 0 0 0 0 0 #> 3 3 10 0.4 0 100000 0 0 0 0 0 0 0 #> 4 4 10 0.4 0 100000 0 0 0 0 0 0 0 #> 5 5 10 0.4 0 100000 0 0 0 0 0 0 0 #> 6 6 10 0.4 0 100000 0 0 0 0 0 0 0 #> 7 7 10 0.4 0 100000 0 0 0 0 0 0 0 #> 8 8 10 0.4 0 100000 0 0 0 0 0 0 0 #> 9 9 10 0.4 0 100000 0 0 0 0 0 0 0 #> 10 10 10 0.4 0 100000 0 0 0 0 0 0 0 #> # ℹ 2 more variables: cBot , RootDepth "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":null,"dir":"Reference","previous_headings":"","what":"Read A_LEVEL.out — read_alevel","title":"Read A_LEVEL.out — read_alevel","text":"-level information printed time time-dependent boundary condition specified. information directed output file A_LEVEL..","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read A_LEVEL.out — read_alevel","text":"","code":"read_alevel(path, dbg = FALSE)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read A_LEVEL.out — read_alevel","text":"path full path A_LEVEL.file dbg show debug messages (default: FALSE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read A_LEVEL.out — read_alevel","text":"imports A_LEVEL tidy column names saves metainformation attributes 'meta_general' 'meta_units' time Time, t, current time-level [T] sum_r_top Cumulative potential surface flux [L] (infiltration/evaporation: -/+) sum_r_root Cumulative potential transpiration [L] sum_v_top Cumulative value actual surface flux [L] (infiltration/evaporation: -/+) [-] sum_v_root Cumulative value actual transpiration [L] sum_v_bot Cumulative value bottom boundary flux [L] (inflow/outflow: +/-) h_top Pressure head soil surface [L] h_root Mean value pressure head soil root zone Beta(n)>0 [L] h_bot Pressure head bottom soil profile [L] a_level -level number (current variable boundary condition number) [-]","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Read A_LEVEL.out — read_alevel","text":"https://www.pc-progress.com/Downloads/Pgm_Hydrus1D/HYDRUS1D-4.17.pdf#page=277","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_alevel.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read A_LEVEL.out — read_alevel","text":"","code":"path_alevel <- system.file(\"extdata/model/test/A_LEVEL.out\", package = \"kwb.hydrus1d\") alevel <- read_alevel(path = path_alevel) alevel #> # A tibble: 81 × 10 #> time sum_r_top sum_r_root sum_v_top sum_v_root sum_v_bot h_top h_root #> * #> 1 1 0.25 0 0.0698 0 -0.00173 -1 e5 0 #> 2 2 -0.2 0 -0.380 0 -0.00346 -8.35e1 0 #> 3 3 -0.02 0 -0.200 0 -0.00520 -2.00e3 0 #> 4 4 -0.14 0 -0.320 0 -0.00693 -1.05e2 0 #> 5 5 -0.13 0 -0.310 0 -0.00866 -1.25e2 0 #> 6 6 -0.0000000270 0 -0.209 0 -0.0104 -1 e5 0 #> 7 7 0.22 0 -0.177 0 -0.0121 -1 e5 0 #> 8 8 0.27 0 -0.161 0 -0.0139 -1 e5 0 #> 9 9 0.45 0 -0.146 0 -0.0156 -1 e5 0 #> 10 10 0.63 0 -0.135 0 -0.0173 -1 e5 0 #> # ℹ 71 more rows #> # ℹ 2 more variables: h_bot , a_level "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_atmosph.html","id":null,"dir":"Reference","previous_headings":"","what":"Read ATMOSPH.in — read_atmosph","title":"Read ATMOSPH.in — read_atmosph","text":"Read ATMOSPH.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_atmosph.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read ATMOSPH.in — read_atmosph","text":"","code":"read_atmosph( path = system.file(\"extdata/model/test/ATMOSPH.in\", package = \"kwb.hydrus1d\") )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_atmosph.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read ATMOSPH.in — read_atmosph","text":"path path ATMOSPH.(default: system.file(\"extdata/model/test/ATMOSPH.\", package = \"kwb.hydrus1d\"))","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_atmosph.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read ATMOSPH.in — read_atmosph","text":"list atmospheric config parameter sublist time series sublist","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_meta_general.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper Function: Read Meta General — read_meta_general","title":"Helper Function: Read Meta General — read_meta_general","text":"Helper Function: Read Meta General","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_meta_general.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper Function: Read Meta General — read_meta_general","text":"","code":"read_meta_general(content_general)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_meta_general.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper Function: Read Meta General — read_meta_general","text":"content_general lines content general (see example)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_meta_general.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper Function: Read Meta General — read_meta_general","text":"tibble columns description, modelstart_datetime unit L,T,M","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_meta_general.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Helper Function: Read Meta General — read_meta_general","text":"","code":"path_tlevel <- system.file(\"extdata/model/test/T_LEVEL.out\", package = \"kwb.hydrus1d\") content <- readLines(path_tlevel) content_general <- content[3:5] cat(content_general) #> Flextreat Hydraulic Model Date: 30. 6.2022 Time: 12:49:10 Units: L = cm , T = days , M = mmol read_meta_general(content_general) #> # A tibble: 1 × 5 #> description modelstart_datetime unit_L unit_T unit_M #> #> 1 Flextreat Hydraulic Model 30.6.2022 12:49:10 cm days mmol"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_obsnode.html","id":null,"dir":"Reference","previous_headings":"","what":"Read Obs_Node.out — read_obsnode","title":"Read Obs_Node.out — read_obsnode","text":"Read Obs_Node.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_obsnode.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read Obs_Node.out — read_obsnode","text":"","code":"read_obsnode(path, to_longer = TRUE)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_obsnode.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read Obs_Node.out — read_obsnode","text":"path path Obs_Node.to_longer convert table longer format (default: TRUE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_obsnode.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read Obs_Node.out — read_obsnode","text":"tibble Obs_Node time series data","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_profile.html","id":null,"dir":"Reference","previous_headings":"","what":"Read PROFILE.out — read_profile","title":"Read PROFILE.out — read_profile","text":"Read PROFILE.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_profile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read PROFILE.out — read_profile","text":"","code":"read_profile(path)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_profile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read PROFILE.out — read_profile","text":"path path PROFILE.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_profile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read PROFILE.out — read_profile","text":"tibble PROFILE.data","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":null,"dir":"Reference","previous_headings":"","what":"Read Run_Inf.out — read_runinf","title":"Read Run_Inf.out — read_runinf","text":"Contains time iteration information","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read Run_Inf.out — read_runinf","text":"","code":"read_runinf(path, dbg = FALSE)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read Run_Inf.out — read_runinf","text":"path full path Run_Inf.file dbg show debug messages (default: FALSE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read Run_Inf.out — read_runinf","text":"imports Run_Inf.tidy column names saves metainformation attributes 'meta_general' 'meta_units' tlevel Time-level (current time-step number) [-] time Time, t, current time-level [T] dt Time step, delta t [T] itr_w Number iterations necessary solution water flow equation [-] itr_c Number iterations necessary solution solute transport equation [-] it_cum Cumulative number iterations [-] kod_t Code boundary condition soil surface kod_b Code boundary condition bottom soil profile converg Information whether numerical convergence achieved current time-level peclet Maximum local Peclet number [-] courant Maximum local Courant number [-]","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Read Run_Inf.out — read_runinf","text":"https://www.pc-progress.com/Downloads/Pgm_Hydrus1D/HYDRUS1D-4.17.pdf#page=272","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read Run_Inf.out — read_runinf","text":"","code":"path_runinf <- system.file(\"extdata/model/test/Run_Inf.out\", package = \"kwb.hydrus1d\") runinf <- read_runinf(path = path_runinf) runinf #> # A tibble: 2,272 × 11 #> t_level time dt itr_w itr_c it_cum kod_t kod_b converg peclet courant #> * #> 1 1 0.111 0.111 5 1 25 -4 -5 TRUE 0.1 0.18 #> 2 2 0.148 0.0370 3 1 38 -4 -5 TRUE 0.1 0.075 #> 3 3 0.164 0.0160 2 1 50 -4 -5 TRUE 0.1 0.034 #> 4 4 0.171 0.00695 2 1 62 -4 -5 TRUE 0.1 0.015 #> 5 5 0.180 0.00904 3 1 65 -4 -5 TRUE 0.1 0.009 #> 6 6 0.184 0.00392 2 1 77 4 -5 TRUE 0.1 0.003 #> 7 7 0.189 0.00509 2 1 79 4 -5 TRUE 0.1 0.004 #> 8 8 0.196 0.00662 2 1 81 4 -5 TRUE 0.1 0.006 #> 9 9 0.204 0.00861 2 1 83 4 -5 TRUE 0.1 0.007 #> 10 10 0.216 0.0112 2 1 85 4 -5 TRUE 0.1 0.009 #> # ℹ 2,262 more rows"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":null,"dir":"Reference","previous_headings":"","what":"Read solute1.out — read_solute","title":"Read solute1.out — read_solute","text":"Reads Solute output","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read solute1.out — read_solute","text":"","code":"read_solute( path = system.file(\"extdata/model/test/solute1.out\", package = \"kwb.hydrus1d\"), dbg = FALSE )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read solute1.out — read_solute","text":"path full path solute_id.file (default: system.file(\"extdata/model/test/solute1.\", package = \"kwb.hydrus1d\")) dbg show debug messages (default: FALSE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read solute1.out — read_solute","text":"imports solute_id.tidy column names saves metainformation attributes 'meta_general' 'meta_units' time Time, t, current time-level [T] cv_top Actual solute flux across soil surface [ML-2 T -1] (inflow/outflow: +/-) cv_bot Actual solute flux across bottom soil profile [ML-2 T -1] (inflow/outflow: +/-) sum_cv_top Cumulative solute flux across soil surface [ML-2] (inflow/outflow: +/-) sum_cv_bot Cumulative solute flux across bottom soil profile [ML-2] (inflow/outflow: +/-) sum_cv_ch0 Cumulative amount solute added flow region zero-order reactions [ML-2] (negative removed system) sum_cv_ch1 Cumulative amount solute removed flow region first-order reactions [ML-2] (negative removed system). c_top Solute concentration soil surface [ML-3] c_root Mean solute concentration root zone [ML-3] c_bot Solute concentration bottom soil profile [ML-3] cv_root Actual root solute uptake root zone [ML-2 T -1] (positive removed system) sum_cv_root Cumulative amount solute removed flow region root water uptake S [ML-2] (positive removed system) sum_cv_n_eql Cumulative mass transfer either kinetic adsorption sites (type-2 adsorption sites), immobile liquid region [ML-2] (inflow/outflow: +/-). t_level Time-level (current time-step number) [-] c_gwl Average concentration saturated zone [ML-3] (groundwater) c_run_off Solute flux runoff ([ML-3] * [LT-1]) [ML-2T-1] sum_c_run_off Cumulative solute flux runoff ([ML-3] * [LT-1]* [T]) [ML-2] cv_i Solute flux first third observation node ([ML-3] * [LT-1]) [ML-2T-1] sum_cv_i cumulative solute flux first third observation node ([ML-3] * [LT-1] * [T]) [ML-2]. Total solute fluxes reported one solute simulated. convective fluxes (first solute) reported 2 solutes simulated","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Read solute1.out — read_solute","text":"https://www.pc-progress.com/Downloads/Pgm_Hydrus1D/HYDRUS1D-4.17.pdf#page=273","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_solute.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read solute1.out — read_solute","text":"","code":"path_solute <- system.file(\"extdata/model/test/solute1.out\", package = \"kwb.hydrus1d\") solute <- read_solute(path = path_solute) solute #> # A tibble: 2,272 × 19 #> time cv_top cv_bot sum_cv_top sum_cv_bot cv_ch0 cv_ch1 c_top c_root c_bot #> * #> 1 0.111 0 0 0 0 0 0 0 0 0 #> 2 0.148 0 0 0 0 0 0 0 0 0 #> 3 0.164 0 0 0 0 0 0 0 0 0 #> 4 0.171 0 0 0 0 0 0 0 0 0 #> 5 0.180 0 0 0 0 0 0 0 0 0 #> 6 0.184 0 0 0 0 0 0 0 0 0 #> 7 0.189 0 0 0 0 0 0 0 0 0 #> 8 0.196 0 0 0 0 0 0 0 0 0 #> 9 0.204 0 0 0 0 0 0 0 0 0 #> 10 0.216 0 0 0 0 0 0 0 0 0 #> # ℹ 2,262 more rows #> # ℹ 9 more variables: cv_root , sum_cv_root , sum_cv_n_eql , #> # t_level , c_gwl , c_run_off , sum_c_run_off , #> # cv_i , sum_cv_i "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":null,"dir":"Reference","previous_headings":"","what":"Read T_LEVEL.out — read_tlevel","title":"Read T_LEVEL.out — read_tlevel","text":"Stores pressure heads fluxes boundaries root zone.","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read T_LEVEL.out — read_tlevel","text":"","code":"read_tlevel(path, dbg = FALSE)"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read T_LEVEL.out — read_tlevel","text":"path full path T_LEVEL.file dbg show debug messages (default: FALSE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read T_LEVEL.out — read_tlevel","text":"imports T_LEVEL tidy column names saves metainformation attributes 'meta_general' 'meta_units' time Time, t, current time-level [T] r_top Potential surface flux [LT-1] (infiltration/evaporation: -/+) r_root Potential transpiration rate [LT-1] v_top Actual surface flux [LT-1] (infiltration/evaporation: -/+) v_root Actual transpiration rate [LT-1] v_bot Actual flux across bottom soil profile [LT-1] (inflow/outflow +/-) sum_r_top Cumulative value potential surface flux [L] (infiltration/evaporation: -/+) sum_r_root Cumulative value potential transpiration rate [L] sum_v_top Cumulative value actual surface flux [L] sum_v_root Cumulative value actual transpiration rate [L] (infiltration/evaporation: -/+) sum_v_bot Cumulative value actual flux across bottom soil profile [LT-1] (inflow/outflow +/-) h_top Pressure head soil surface [L] h_root Mean value pressure head region Beta(n) > 0 (.e. within root zone) [L] h_bot Pressure head bottom soil profile [L] run_off Surface runoff [LT-1] sum_run_off Cumulative surface runoff [L] volume Volume water entire flow domain [L] sum_infil Cumulative infiltration [L] sum_evap Cumulative actual evaporation [L] t_level Time-level (current time-step number) [-] cum_w_trans Cumulative mass transfer mobile immobile regions dual porosity model [L] snow_layer Thickness snow layer, expressed \"snow water equivalent\" (amount water contained within snowpack) [L]","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Read T_LEVEL.out — read_tlevel","text":"https://www.pc-progress.com/Downloads/Pgm_Hydrus1D/HYDRUS1D-4.17.pdf#page=271","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/read_tlevel.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read T_LEVEL.out — read_tlevel","text":"","code":"path_tlevel <- system.file(\"extdata/model/test/T_LEVEL.out\", package = \"kwb.hydrus1d\") tlevel <- read_tlevel(path = path_tlevel) tlevel #> # A tibble: 2,272 × 22 #> time r_top r_root v_top v_root v_bot sum_r_top sum_r_root sum_v_top #> * #> 1 0.111 0.25 0 0.25 0 -0.00173 0.0278 0 0.0278 #> 2 0.148 0.25 0 0.25 0 -0.00173 0.0370 0 0.0370 #> 3 0.164 0.25 0 0.25 0 -0.00173 0.0410 0 0.0410 #> 4 0.171 0.25 0 0.25 0 -0.00173 0.0428 0 0.0428 #> 5 0.180 0.25 0 0.0977 0 -0.00173 0.0450 0 0.0437 #> 6 0.184 0.25 0 0.0786 0 -0.00173 0.0460 0 0.0440 #> 7 0.189 0.25 0 0.0819 0 -0.00173 0.0473 0 0.0444 #> 8 0.196 0.25 0 0.0840 0 -0.00173 0.0490 0 0.0450 #> 9 0.204 0.25 0 0.0816 0 -0.00173 0.0511 0 0.0457 #> 10 0.216 0.25 0 0.0774 0 -0.00173 0.0539 0 0.0465 #> # ℹ 2,262 more rows #> # ℹ 13 more variables: sum_v_root , sum_v_bot , h_top , #> # h_root , h_bot , run_off , sum_run_off , volume , #> # sum_infil , sum_evap , t_level , cum_w_trans , #> # snow_layer "},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/run_model.html","id":null,"dir":"Reference","previous_headings":"","what":"Run Model — run_model","title":"Run Model — run_model","text":"Run Model","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/run_model.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run Model — run_model","text":"","code":"run_model( exe_path = check_hydrus_exe(), model_path = system.file(\"extdata/model/test\", package = \"kwb.hydrus1d\"), ... )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/run_model.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run Model — run_model","text":"exe_path path Hydrus1D executable v4.17.040 (default: retrieved check_hydrus_exe) model_path path model directory (default: system.file(\"extdata/model/test\", package = \"kwb.hydrus1d\")) ... additional arguments passed shell","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/run_model.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run Model — run_model","text":"runs HYDRUS 1D model","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/run_model.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Run Model — run_model","text":"","code":"run_model() #> Checking if download of HYDRUS1D executable v4.17.0140 from 'https://github.com/mrustl/hydrus1d/archive/refs/tags/v4.17.0140.zip' was successful ... ok. (0.00 secs) #> Warning: 'cd D:/a/_temp/Library/kwb.hydrus1d/extdata/model && H1D_CALC.exe' execution failed with error code 1"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/write_atmosphere.html","id":null,"dir":"Reference","previous_headings":"","what":"Write ","title":"Write ","text":"Write \"ATMOSPH.\" input file","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/write_atmosphere.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Write ","text":"","code":"write_atmosphere( atm, MaxAL = 365, DailyVar = FALSE, SinusVar = FALSE, lLai = FALSE, lBCCycles = FALSE, lInterc = FALSE, hCritS = 0, round_digits = 2, remove_scientific = TRUE )"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/write_atmosphere.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Write ","text":"atm tibble input data defined prepare_atmospherice_input MaxAL Number meteorological records DailyVar TRUE HYDRUS-1D generate daily variations evaporation transpiration (see section 2.7.2.)., otherwise: FALSE (default: FALSE) SinusVar TRUE HYDRUS-1D generate sinusoidal variations precipitation (see section 2.7.2.), otherwise: FALSE(default: FALSE) lLai Logical variable indicating potential evapotranspiration divided potential evaporation potential transpiration using eq. (2.75). (default: FALSE) lBCCycles TRUE set boundary conditions repeated multiple times, otherwise FALSE(default: FALSE) lInterc TRUE interception considered using eq. (2.78), otherwise FALSE (default: FALSE) hCritS Maximum allowed pressure head soil surface (L). (default: 0) round_digits digits used rounding values (default: 2) columns besides \"tAtm\" remove_scientific TRUE scientific notation numbers removed, otherwise (default: TRUE)","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/write_atmosphere.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Write ","text":"Creates ATMOSPH.input textfile","code":""},{"path":"https://kwb-r.github.io/kwb.hydrus1d/reference/write_atmosphere.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Write ","text":"","code":"inputs <- tibble::tibble(tAtm = 1:10, Prec = 10, rSoil = 0.4) atm <- prepare_atmosphere_input(inputs) atm #> # A tibble: 10 × 14 #> tAtm Prec rSoil rRoot hCritA rB hB ht tTop tBot Ampl cTop #> #> 1 1 10 0.4 0 100000 0 0 0 0 0 0 0 #> 2 2 10 0.4 0 100000 0 0 0 0 0 0 0 #> 3 3 10 0.4 0 100000 0 0 0 0 0 0 0 #> 4 4 10 0.4 0 100000 0 0 0 0 0 0 0 #> 5 5 10 0.4 0 100000 0 0 0 0 0 0 0 #> 6 6 10 0.4 0 100000 0 0 0 0 0 0 0 #> 7 7 10 0.4 0 100000 0 0 0 0 0 0 0 #> 8 8 10 0.4 0 100000 0 0 0 0 0 0 0 #> 9 9 10 0.4 0 100000 0 0 0 0 0 0 0 #> 10 10 10 0.4 0 100000 0 0 0 0 0 0 0 #> # ℹ 2 more variables: cBot , RootDepth atm_string <- write_atmosphere(atm = atm, MaxAL = nrow(atm)) cat(atm_string) #> Pcp_File_Version=4 #> *** BLOCK I: ATMOSPHERIC INFORMATION ********************************** #> MaxAL (MaxAL = number of atmospheric data-records) #> 10 #> DailyVar SinusVar lLay lBCCycles lInterc lDummy lDummy lDummy lDummy lDummy #> f f f f f f f f f f #> hCritS (max. allowed pressure head at the soil surface) #> 0 #> tAtm Prec rSoil rRoot hCritA rB hB ht tTop tBot Ampl cTop cBot RootDepth #> 1 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 2 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 3 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 4 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 5 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 6 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 7 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 8 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 9 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> 10 10 0.4 0 100000 0 0 0 0 0 0 0 0 0 #> end*** END OF INPUT FILE 'ATMOSPH.IN' **********************************"},{"path":"https://kwb-r.github.io/kwb.hydrus1d/news/index.html","id":"kwbhydrus1d-0009000","dir":"Changelog","previous_headings":"","what":"kwb.hydrus1d 0.0.0.9000","title":"kwb.hydrus1d 0.0.0.9000","text":"Added NEWS.md file track changes package. see https://style.tidyverse.org/news.html writing good NEWS.md","code":""}] diff --git a/sitemap.xml b/sitemap.xml index 0d52e61..f75f917 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -60,6 +60,9 @@ https://kwb-r.github.io/kwb.hydrus1d/reference/read_obsnode.html + + https://kwb-r.github.io/kwb.hydrus1d/reference/read_profile.html + https://kwb-r.github.io/kwb.hydrus1d/reference/read_runinf.html