From e38e8ec59e8b274bb39b23dddfb060f01cf04b97 Mon Sep 17 00:00:00 2001 From: Tianshu Date: Thu, 18 Nov 2021 22:17:23 +0800 Subject: [PATCH] v1.7.2 new function: tuv_batch. --- DESCRIPTION | 4 +- NAMESPACE | 7 ++ R/tuv_batch.R | 173 +++++++++++++++++++++++++++++++++++++++++++++++ R/tuv_core.R | 74 ++++++++++++++++++++ R/zzz.R | 10 +++ man/tuv_batch.Rd | 47 +++++++++++++ man/tuv_core.Rd | 95 ++++++++++++++++++++++++++ 7 files changed, 408 insertions(+), 2 deletions(-) create mode 100644 R/tuv_batch.R create mode 100644 R/tuv_core.R create mode 100644 R/zzz.R create mode 100644 man/tuv_batch.Rd create mode 100644 man/tuv_core.Rd diff --git a/DESCRIPTION b/DESCRIPTION index e85710d..575ae68 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: foqat Type: Package Title: Field Observation Quick Analysis Toolkit -Version: 1.7.1 +Version: 1.7.2 Author: Tianshu Chen Maintainer: Tianshu Chen Description: Tools for quickly processing and analyzing @@ -20,7 +20,7 @@ URL: https://github.com/tianshu129/foqat BugReports: https://github.com/tianshu129/foqat/issues Depends: R (>= 3.5.0) Imports: lubridate, magrittr, dplyr, plyr, stats, stringr, utils, - lmodel2, reshape2, ggplot2, ggprism, ggplotify, gridExtra, + lmodel2, reshape2, ggplot2, ggplotify, gridExtra, scales, rvest, xml2 License: GPL-3 | file LICENSE Encoding: UTF-8 diff --git a/NAMESPACE b/NAMESPACE index 2657f82..d0f00d9 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -14,6 +14,7 @@ export(transp) export(trs) export(tsplotp) export(tuv) +export(tuv_batch) export(vocct) import(ggplot2) import(lubridate) @@ -43,8 +44,11 @@ importFrom(graphics,plot) importFrom(gridExtra,grid.arrange) importFrom(lmodel2,lmodel2) importFrom(lubridate,duration) +importFrom(lubridate,hour) importFrom(lubridate,hours) +importFrom(lubridate,minute) importFrom(lubridate,minutes) +importFrom(lubridate,second) importFrom(plyr,.) importFrom(plyr,ddply) importFrom(reshape2,dcast) @@ -59,7 +63,10 @@ importFrom(stats,quantile) importFrom(stats,sd) importFrom(stringr,str_split_fixed) importFrom(utils,download.file) +importFrom(utils,read.delim) importFrom(utils,read.table) +importFrom(utils,setTxtProgressBar) importFrom(utils,stack) +importFrom(utils,txtProgressBar) importFrom(utils,unstack) importFrom(xml2,read_html) diff --git a/R/tuv_batch.R b/R/tuv_batch.R new file mode 100644 index 0000000..aac0b3c --- /dev/null +++ b/R/tuv_batch.R @@ -0,0 +1,173 @@ +#' Calculate TUV in Batch Online +#' +#' This function runs TUV in batch online by reading the time series for the \cr +#' parameters to be entered, and summarizes the results to the new dataframe. \cr +#' +#' @param df Dataframe of time series of parameters. The first column of df should be datetime. The other columns (names) could be set as following: \cr +#' wStart -> Shortest wavelength. The default value is 280. \cr +#' wStop -> Longest wavelength. The default value is 420. \cr +#' wIntervals -> Number of equal-sized subdivisions of the range End-Start. The default value is 140. \cr +#' latitude -> Latitudes: positive North of equator, negative South of equator. The default value is 0. \cr +#' longitude -> Longitudes: positive East of the Greenwich meridian, negative West of the Greenwich meridian. The default value is 0. \cr +#' zenith -> Solar zenith angle (deg). The default value is 0. \cr +#' ozone -> Ozone column, in Dobson Units (du), vertical, from ground (even if above sea level) to space. The US Standard Atmosphere O3 is used to specify the shape of the vertical profile but the total column is re-scaled to the value selected here by the user. The default value is 300. \cr +#' albedo -> Surface albedo: Assumes a Lambertian reflection (isotropic radiance) Values for snow can reach 0.90-0.99, but otherwise values at UV wavelengths are in the range 0.02-0.20 depending on the precise surface. The default value is 0.1. +#' gAltitude -> Ground elevation: The elevation of the ground, in km above mean sea level. The default value is 0. \cr +#' mAltitude -> Measurement altitude: The altitude in the atmosphere for which results are requested. This should not be confused with the ground elevation. For example, if you have measurements made from an airplane, flying at 6 km above the ground, and the surface is at 1.5 km, then you will want to request results for a measurement altitude of 7.5 km asl. The default value is 0. \cr +#' taucld -> Cloud Optical Depth: vertical optical depth of the cloud. The default value is 0.00. \cr +#' zbase -> Cloud base: base of cloud, in km (asl). The default value is 4.00. \cr +#' ztop -> Cloud top: top of cloud, in km (asl). The default value is 5.00. \cr +#' tauaer -> Optical Depth: total extinction (absorption + scattering) at 550 nm, vertical, from ground to space. The default value is 0.235. \cr +#' ssaaer -> Single Scattering Albedo (S-S alb), assumed independent of wavelength. The default value is 0.990. \cr +#' alpha -> Alpha (Angstrom exponent), gives wavelength dependence of optical depth, by multiplying the 550 nm value by (550 nm/wavelength, nm)**alpha. The default value is 1.000. \cr +#' dirsun -> Direct beam, direct solar beam. The default value is 1.0. \cr +#' difdn -> Diffuse down, down-ward propagating scattered radiation (diffuse sky light). The default value is 1.0. \cr +#' difup -> Diffuse up, up-ward propagating scattered radiation (diffuse light from below). The default value is NA. \cr +#' @param inputMode The default value is 0. InputMode 0: User-specified geographic location and time/date. The code computes the appropriate solar zenith angle and Earth-Sun distance. InputMode 1: User specifies the solar zenith angle, and the annual average Earth-Sun distance is used. To avoid inconsistencies (e.g. overhead sun at the poles), options 1 and 2 cannot be invoked at the same time. +#' @param outputMode The default value is 2. OutputMode 2: Molecular photolysis frequencies (109 photoreactions). OutputMode 3: Weighted irradiance (27 weighting functions). OutputMode 4: Spectral actinic flux. OutputMode 5: Spectral irradiance. +#' @param nStreams The default value is -2. NStreams -2: Pseudo-spherical 2 streams (faster, less accurate). NStreams 4: Pseudo-spherical discrete ordinate 4 streams (slower, more accurate). +#' @return a dataframe. The contents of dataframe are diterminated by OutputMode. \cr +#' OutputMode 2: Molecular photolysis frequencies (109 photoreactions). \cr +#' OutputMode 3: Weighted irradiance (27 weighting functions). \cr +#' OutputMode 4: Spectral actinic flux. \cr +#' OutputMode 5: Spectral irradiance. \cr +#' @export +#' @importFrom lubridate hour minute second +#' @importFrom utils read.delim setTxtProgressBar txtProgressBar + +tuv_batch=function(df, inputMode=0, outputMode=2, nStreams=-2){ + #转化为data.frame + df=data.frame(df) + + #检测输入的列名是否在范围内 + + #date和timeStamp从第一列自动拆分生成 + #time根据从第一列的小时数换算成带小数点的小时数据，也自动生成 + df$date=format(as.Date(df[,1]), "%Y%m%d") + df$timeStamp=as.character(format(df[,1], "%H:%M:%S")) + df$time=hour(df[,1])+minute(df[,1])/60+second(df[,1])/3600 + + #补齐df + if(outputMode==2|outputMode==4){ + allpara=c(280, 420, 140, 0, 0, 0, 300, 0.1, 0, 0, 0.00, 4.00, 5.00, 0.235, 0.990, 1.000, 1.0, 1.0, 1.0) + }else{ + allpara=c(280, 420, 140, 0, 0, 0, 300, 0.1, 0, 0, 0.00, 4.00, 5.00, 0.235, 0.990, 1.000, 1.0, 1.0, 0.0) + } + names(allpara)=c("wStart", "wStop", "wIntervals", "latitude", "longitude", "zenith", "ozone", "albedo", "gAltitude", "mAltitude", "taucld", "zbase", "ztop", "tauaer", "ssaaer", "alpha", "dirsun", "difdn", "difup") + + #如果存在allpara有不在names(df) + if(any(!allpara%in%names(df))){ + for(i in names(allpara)[!names(allpara)%in%names(df)]){ + eval(parse(text=paste0("df$'", i, "'=allpara[['", i, "']]"))) + } + } + + #inputMode和outputMode从数据参数硬补 + df$"inputMode"=inputMode + df$"outputMode"=outputMode + + #nStreams从数据参数硬补 + df$"nStreams"=nStreams + + #进度条 + print("Running TUV on the inputs:") + progress_bar = txtProgressBar(min=0, max=nrow(df)+1, style = 3, char="=") + + #对df按行输入tuv_core计算 + #先计算第一行。 + wStart=df$wStart[1] + wStop=df$wStop[1] + wIntervals=df$wIntervals[1] + inputMode=df$inputMode[1] + latitude=df$latitude[1] + longitude=df$longitude[1] + date=df$date[1] + timeStamp=df$timeStamp[1] + zenith=df$zenith[1] + ozone=df$ozone[1] + albedo=df$albedo[1] + gAltitude=df$gAltitude[1] + mAltitude=df$mAltitude[1] + taucld=df$taucld[1] + zbase=df$zbase[1] + ztop=df$ztop[1] + tauaer=df$tauaer[1] + ssaaer=df$ssaaer[1] + alpha=df$alpha[1] + time=df$time[1] + outputMode=df$outputMode[1] + nStreams=df$nStreams[1] + dirsun=df$dirsun[1] + difdn=df$difdn[1] + difup=df$difup[1] + + final_df=tuv_core(wStart=wStart, wStop=wStop, wIntervals=wIntervals, inputMode=inputMode, latitude=latitude, longitude=longitude, date=date, timeStamp=timeStamp, zenith=zenith, ozone=ozone, albedo=albedo, gAltitude=gAltitude, mAltitude=mAltitude, taucld=taucld, zbase=zbase, ztop=ztop, tauaer=tauaer, ssaaer=ssaaer, alpha=alpha, time=time, outputMode=outputMode, nStreams=nStreams, dirsun=dirsun, difdn=difdn, difup=difup) + setTxtProgressBar(progress_bar, value = 1) + + #如果有第二行，再循环计算，并拼接。 + if(nrow(df)>1){ + for(i in 2:nrow(df)){ + + wStart=df$wStart[i] + wStop=df$wStop[i] + wIntervals=df$wIntervals[i] + inputMode=df$inputMode[i] + latitude=df$latitude[i] + longitude=df$longitude[i] + date=df$date[i] + timeStamp=df$timeStamp[i] + zenith=df$zenith[i] + ozone=df$ozone[i] + albedo=df$albedo[i] + gAltitude=df$gAltitude[i] + mAltitude=df$mAltitude[i] + taucld=df$taucld[i] + zbase=df$zbase[i] + ztop=df$ztop[i] + tauaer=df$tauaer[i] + ssaaer=df$ssaaer[i] + alpha=df$alpha[i] + time=df$time[i] + outputMode=df$outputMode[i] + nStreams=df$nStreams[i] + dirsun=df$dirsun[i] + difdn=df$difdn[i] + difup=df$difup[i] + final_df_sub=tuv_core(wStart=wStart, wStop=wStop, wIntervals=wIntervals, inputMode=inputMode, latitude=latitude, longitude=longitude, date=date, timeStamp=timeStamp, zenith=zenith, ozone=ozone, albedo=albedo, gAltitude=gAltitude, mAltitude=mAltitude, taucld=taucld, zbase=zbase, ztop=ztop, tauaer=tauaer, ssaaer=ssaaer, alpha=alpha, time=time, outputMode=outputMode, nStreams=nStreams, dirsun=dirsun, difdn=difdn, difup=difup) + final_df=rbind(final_df, final_df_sub) + setTxtProgressBar(progress_bar, value = i) + } + } + + #补信息列，时间列 + if(outputMode==2){ + #PHOTOLYSIS RATES (1/sec) + info=rep("1/sec",nrow(final_df)) + final_df2=cbind(info,final_df) + final_df3=cbind(df[,1],final_df2) + names(final_df3)[c(1,2)]=c(names(df)[1],"PHOTOLYSIS RATES") + }else if(outputMode==3){ + #WEIGHTED IRRADIANCES (W m-2) + info=rep("W m-2",nrow(final_df)) + final_df2=cbind(info,final_df) + final_df3=cbind(df[,1],final_df2) + names(final_df3)[c(1,2)]=c(names(df)[1],"WEIGHTED IRRADIANCES") + }else if(outputMode==4){ + #ACTINIC FLUX (# photons/sec/nm/cm2) + info=rep("photons/sec/nm/cm2",nrow(final_df)) + final_df2=cbind(info,final_df) + final_df3=cbind(rep(df[,1], each=140),final_df2) + names(final_df3)[c(1,2)]=c(names(df)[1],"ACTINIC FLUX") + }else if(outputMode==5){ + #SPECTRAL IRRADIANCE (W m-2 nm-1) + info=rep("W m-2 nm-1",nrow(final_df)) + final_df2=cbind(info,final_df) + final_df3=cbind(rep(df[,1], each=140),final_df2) + names(final_df3)[c(1,2)]=c(names(df)[1],"SPECTRAL IRRADIANCE") + } + + setTxtProgressBar(progress_bar, value = nrow(df)+1) + close(progress_bar) + + return(final_df3) +} \ No newline at end of file diff --git a/R/tuv_core.R b/R/tuv_core.R new file mode 100644 index 0000000..34df964 --- /dev/null +++ b/R/tuv_core.R @@ -0,0 +1,74 @@ +#' Calculate TUV Online +#' +#' This function runs TUV online by reading the input parameters, and summarizes the results to the new dataframe. \cr +#' +#' @param inputMode The default value is 0. InputMode 0: User-specified geographic location and time/date. The code computes the appropriate solar zenith angle and Earth-Sun distance. InputMode 1: User specifies the solar zenith angle, and the annual average Earth-Sun distance is used. To avoid inconsistencies (e.g. overhead sun at the poles), options 1 and 2 cannot be invoked at the same time. +#' @param outputMode The default value is 2. OutputMode 2: Molecular photolysis frequencies (109 photoreactions). OutputMode 3: Weighted irradiance (27 weighting functions). OutputMode 4: Spectral actinic flux. OutputMode 5: Spectral irradiance. +#' @param nStreams The default value is -2. NStreams -2: Pseudo-spherical 2 streams (faster, less accurate). NStreams 4: Pseudo-spherical discrete ordinate 4 streams (slower, more accurate). +#' @param wStart Shortest wavelength. The default value is 280. \cr +#' @param wStop Longest wavelength. The default value is 420. \cr +#' @param wIntervals Number of equal-sized subdivisions of the range End-Start. The default value is 140. \cr +#' @param latitude Latitudes: positive North of equator, negative South of equator. The default value is 0. \cr +#' @param longitude Longitudes: positive East of the Greenwich meridian, negative West of the Greenwich meridian. The default value is 0. \cr +#' @param zenith Solar zenith angle (deg). The default value is 0. \cr +#' @param ozone Ozone column, in Dobson Units (du), vertical, from ground (even if above sea level) to space. The US Standard Atmosphere O3 is used to specify the shape of the vertical profile but the total column is re-scaled to the value selected here by the user. The default value is 300. \cr +#' @param albedo Surface albedo: Assumes a Lambertian reflection (isotropic radiance) Values for snow can reach 0.90-0.99, but otherwise values at UV wavelengths are in the range 0.02-0.20 depending on the precise surface. The default value is 0.1. +#' @param gAltitude Ground elevation: The elevation of the ground, in km above mean sea level. The default value is 0. \cr +#' @param mAltitude Measurement altitude: The altitude in the atmosphere for which results are requested. This should not be confused with the ground elevation. For example, if you have measurements made from an airplane, flying at 6 km above the ground, and the surface is at 1.5 km, then you will want to request results for a measurement altitude of 7.5 km asl. The default value is 0. \cr +#' @param taucld Cloud Optical Depth: vertical optical depth of the cloud. The default value is 0.00. \cr +#' @param zbase Cloud base: base of cloud, in km (asl). The default value is 4.00. \cr +#' @param ztop Cloud top: top of cloud, in km (asl). The default value is 5.00. \cr +#' @param tauaer Optical Depth: total extinction (absorption + scattering) at 550 nm, vertical, from ground to space. The default value is 0.235. \cr +#' @param ssaaer Single Scattering Albedo (S-S alb), assumed independent of wavelength. The default value is 0.990. \cr +#' @param alpha Alpha (Angstrom exponent), gives wavelength dependence of optical depth, by multiplying the 550 nm value by (550 nm/wavelength, nm)**alpha. The default value is 1.000. \cr +#' @param dirsun Direct beam, direct solar beam. The default value is 1.0. \cr +#' @param difdn Diffuse down, down-ward propagating scattered radiation (diffuse sky light). The default value is 1.0. \cr +#' @param difup Diffuse up, up-ward propagating scattered radiation (diffuse light from below). The default value is NA. \cr +#' @param date Date (format: (YYYYMMDD, GMT). The default value is 20150630. \cr +#' @param timeStamp -> Timestamp (format: hh:mm:ss, GMT). The default value is "12:00:00". \cr +#' @param time Hour. The default value is 12. \cr +#' @return a dataframe. The contents of dataframe are diterminated by OutputMode. \cr +#' OutputMode 2: Molecular photolysis frequencies (109 photoreactions). \cr +#' OutputMode 3: Weighted irradiance (27 weighting functions). \cr +#' OutputMode 4: Spectral actinic flux. \cr +#' OutputMode 5: Spectral irradiance. \cr + +tuv_core=function(wStart=280, wStop=420, wIntervals=140, inputMode=0, latitude=0, longitude=0, date=20150630, timeStamp="12:00:00", zenith=0, ozone=300, albedo=0.1, gAltitude=0, mAltitude=0, taucld=0.00, zbase=4.00, ztop=5.00, tauaer=0.235, ssaaer=0.990, alpha=1.000, time=12, outputMode=2, nStreams=-2, dirsun=1.0, difdn=1.0, difup=NA){ + if(is.na(difup)&(outputMode==2|outputMode==4)){ + difup=1.0 + }else if(is.na(difup)&(outputMode==3|outputMode==5)){ + difup=0.0 + } + url <- paste0(c("https://www.acom.ucar.edu/cgi-bin/acom/TUV/V5.3/tuv?wStart=", wStart, "&wStop=", wStop, "&wIntervals=", wIntervals, "&inputMode=", inputMode, "&latitude=", latitude, "&longitude=", longitude, "&date=", date, "&timeStamp=", timeStamp, "&zenith=", zenith, "&ozone=", ozone, "&albedo=", albedo, "&gAltitude=", gAltitude, "&mAltitude=", mAltitude, "&taucld=", taucld, "&zbase=", zbase, "&ztop=", ztop, "&tauaer=", tauaer, "&ssaaer=", ssaaer, "&alpha=", alpha, "&time=", time, "&outputMode=", outputMode, "&nStreams=", nStreams, "&dirsun=", dirsun, "&difdn=", difdn, "&difup=", difup), collapse='') + download.file(url, "file.txt", quiet=TRUE) + filetext=read.delim("file.txt") + if(outputMode==2){ + #PHOTOLYSIS RATES (1/sec) + photolysis_rates=filetext[23:135,] + phlydf=do.call(rbind.data.frame,strsplit(photolysis_rates, "\\s{4,}")) + phlydf[34,1]=paste0(" ", strsplit(filetext[56,], "\\s{2,}")[[1]][2]) + phlydf[34,2]=strsplit(filetext[56,], "\\s{2,}")[[1]][3] + phlydf_value=data.frame(t(phlydf[,2])) + names(phlydf_value)=phlydf[,1] + return(phlydf_value) + }else if(outputMode==3){ + #WEIGHTED IRRADIANCES (W m-2) + weighted_irradiances=filetext[24:27,] + weirdf=do.call(rbind.data.frame,strsplit(weighted_irradiances, "\\s{2,}")) + weirdf_value=data.frame(t(weirdf[,3])) + names(weirdf_value)=weirdf[,2] + return(weirdf_value) + }else if(outputMode==4){ + #ACTINIC FLUX (# photons/sec/nm/cm2) + actinic_flux=filetext[24:163,] + acfldf_value=do.call(rbind.data.frame,strsplit(actinic_flux, "\\s{2,}")) + names(acfldf_value)=unlist(strsplit(filetext[23,], "\\s{2,}")) + return(acfldf_value) + }else if(outputMode==5){ + #SPECTRAL IRRADIANCE (W m-2 nm-1) + spectral_irradiance=filetext[24:163,] + spirdf_value=do.call(rbind.data.frame,strsplit(spectral_irradiance, "\\s{2,}")) + names(spirdf_value)=unlist(strsplit(filetext[23,], "\\s{2,}")) + return(spirdf_value) + } +} \ No newline at end of file diff --git a/R/zzz.R b/R/zzz.R new file mode 100644 index 0000000..8a081ed --- /dev/null +++ b/R/zzz.R @@ -0,0 +1,10 @@ +.onLoad <- function(libname, pkgname) { + packageStartupMessage( + " +Welcome to FOQAT!\n +Author: Tianshu Chen\n +Email: tianshu129@163.com\n +Wechat: chentianshu\n +Chinese homepage: https://www.yuque.com/foqat \n +English homepage: https://github.com/tianshu129/foqat \n") +} \ No newline at end of file diff --git a/man/tuv_batch.Rd b/man/tuv_batch.Rd new file mode 100644 index 0000000..e7cab0d --- /dev/null +++ b/man/tuv_batch.Rd @@ -0,0 +1,47 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/tuv_batch.R +\name{tuv_batch} +\alias{tuv_batch} +\title{Calculate TUV in Batch Online} +\usage{ +tuv_batch(df, inputMode = 0, outputMode = 2, nStreams = -2) +} +\arguments{ +\item{df}{Dataframe of time series of parameters. The first column of df should be datetime. The other columns (names) could be set as following: \cr +wStart -> Shortest wavelength. The default value is 280. \cr +wStop -> Longest wavelength. The default value is 420. \cr +wIntervals -> Number of equal-sized subdivisions of the range End-Start. The default value is 140. \cr +latitude -> Latitudes: positive North of equator, negative South of equator. The default value is 0. \cr +longitude -> Longitudes: positive East of the Greenwich meridian, negative West of the Greenwich meridian. The default value is 0. \cr +zenith -> Solar zenith angle (deg). The default value is 0. \cr +ozone -> Ozone column, in Dobson Units (du), vertical, from ground (even if above sea level) to space. The US Standard Atmosphere O3 is used to specify the shape of the vertical profile but the total column is re-scaled to the value selected here by the user. The default value is 300. \cr +albedo -> Surface albedo: Assumes a Lambertian reflection (isotropic radiance) Values for snow can reach 0.90-0.99, but otherwise values at UV wavelengths are in the range 0.02-0.20 depending on the precise surface. The default value is 0.1. +gAltitude -> Ground elevation: The elevation of the ground, in km above mean sea level. The default value is 0. \cr +mAltitude -> Measurement altitude: The altitude in the atmosphere for which results are requested. This should not be confused with the ground elevation. For example, if you have measurements made from an airplane, flying at 6 km above the ground, and the surface is at 1.5 km, then you will want to request results for a measurement altitude of 7.5 km asl. The default value is 0. \cr +taucld -> Cloud Optical Depth: vertical optical depth of the cloud. The default value is 0.00. \cr +zbase -> Cloud base: base of cloud, in km (asl). The default value is 4.00. \cr +ztop -> Cloud top: top of cloud, in km (asl). The default value is 5.00. \cr +tauaer -> Optical Depth: total extinction (absorption + scattering) at 550 nm, vertical, from ground to space. The default value is 0.235. \cr +ssaaer -> Single Scattering Albedo (S-S alb), assumed independent of wavelength. The default value is 0.990. \cr +alpha -> Alpha (Angstrom exponent), gives wavelength dependence of optical depth, by multiplying the 550 nm value by (550 nm/wavelength, nm)**alpha. The default value is 1.000. \cr +dirsun -> Direct beam, direct solar beam. The default value is 1.0. \cr +difdn -> Diffuse down, down-ward propagating scattered radiation (diffuse sky light). The default value is 1.0. \cr +difup -> Diffuse up, up-ward propagating scattered radiation (diffuse light from below). The default value is NA. \cr} + +\item{inputMode}{The default value is 0. InputMode 0: User-specified geographic location and time/date. The code computes the appropriate solar zenith angle and Earth-Sun distance. InputMode 1: User specifies the solar zenith angle, and the annual average Earth-Sun distance is used. To avoid inconsistencies (e.g. overhead sun at the poles), options 1 and 2 cannot be invoked at the same time.} + +\item{outputMode}{The default value is 2. OutputMode 2: Molecular photolysis frequencies (109 photoreactions). OutputMode 3: Weighted irradiance (27 weighting functions). OutputMode 4: Spectral actinic flux. OutputMode 5: Spectral irradiance.} + +\item{nStreams}{The default value is -2. NStreams -2: Pseudo-spherical 2 streams (faster, less accurate). NStreams 4: Pseudo-spherical discrete ordinate 4 streams (slower, more accurate).} +} +\value{ +a dataframe. The contents of dataframe are diterminated by OutputMode. \cr +OutputMode 2: Molecular photolysis frequencies (109 photoreactions). \cr +OutputMode 3: Weighted irradiance (27 weighting functions). \cr +OutputMode 4: Spectral actinic flux. \cr +OutputMode 5: Spectral irradiance. \cr +} +\description{ +This function runs TUV in batch online by reading the time series for the \cr +parameters to be entered, and summarizes the results to the new dataframe. \cr +} diff --git a/man/tuv_core.Rd b/man/tuv_core.Rd new file mode 100644 index 0000000..6a7aa79 --- /dev/null +++ b/man/tuv_core.Rd @@ -0,0 +1,95 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/tuv_core.R +\name{tuv_core} +\alias{tuv_core} +\title{Calculate TUV Online} +\usage{ +tuv_core( + wStart = 280, + wStop = 420, + wIntervals = 140, + inputMode = 0, + latitude = 0, + longitude = 0, + date = 20150630, + timeStamp = "12:00:00", + zenith = 0, + ozone = 300, + albedo = 0.1, + gAltitude = 0, + mAltitude = 0, + taucld = 0, + zbase = 4, + ztop = 5, + tauaer = 0.235, + ssaaer = 0.99, + alpha = 1, + time = 12, + outputMode = 2, + nStreams = -2, + dirsun = 1, + difdn = 1, + difup = NA +) +} +\arguments{ +\item{wStart}{Shortest wavelength. The default value is 280. \cr} + +\item{wStop}{Longest wavelength. The default value is 420. \cr} + +\item{wIntervals}{Number of equal-sized subdivisions of the range End-Start. The default value is 140. \cr} + +\item{inputMode}{The default value is 0. InputMode 0: User-specified geographic location and time/date. The code computes the appropriate solar zenith angle and Earth-Sun distance. InputMode 1: User specifies the solar zenith angle, and the annual average Earth-Sun distance is used. To avoid inconsistencies (e.g. overhead sun at the poles), options 1 and 2 cannot be invoked at the same time.} + +\item{latitude}{Latitudes: positive North of equator, negative South of equator. The default value is 0. \cr} + +\item{longitude}{Longitudes: positive East of the Greenwich meridian, negative West of the Greenwich meridian. The default value is 0. \cr} + +\item{date}{Date (format: (YYYYMMDD, GMT). The default value is 20150630. \cr} + +\item{timeStamp}{-> Timestamp (format: hh:mm:ss, GMT). The default value is "12:00:00". \cr} + +\item{zenith}{Solar zenith angle (deg). The default value is 0. \cr} + +\item{ozone}{Ozone column, in Dobson Units (du), vertical, from ground (even if above sea level) to space. The US Standard Atmosphere O3 is used to specify the shape of the vertical profile but the total column is re-scaled to the value selected here by the user. The default value is 300. \cr} + +\item{albedo}{Surface albedo: Assumes a Lambertian reflection (isotropic radiance) Values for snow can reach 0.90-0.99, but otherwise values at UV wavelengths are in the range 0.02-0.20 depending on the precise surface. The default value is 0.1.} + +\item{gAltitude}{Ground elevation: The elevation of the ground, in km above mean sea level. The default value is 0. \cr} + +\item{mAltitude}{Measurement altitude: The altitude in the atmosphere for which results are requested. This should not be confused with the ground elevation. For example, if you have measurements made from an airplane, flying at 6 km above the ground, and the surface is at 1.5 km, then you will want to request results for a measurement altitude of 7.5 km asl. The default value is 0. \cr} + +\item{taucld}{Cloud Optical Depth: vertical optical depth of the cloud. The default value is 0.00. \cr} + +\item{zbase}{Cloud base: base of cloud, in km (asl). The default value is 4.00. \cr} + +\item{ztop}{Cloud top: top of cloud, in km (asl). The default value is 5.00. \cr} + +\item{tauaer}{Optical Depth: total extinction (absorption + scattering) at 550 nm, vertical, from ground to space. The default value is 0.235. \cr} + +\item{ssaaer}{Single Scattering Albedo (S-S alb), assumed independent of wavelength. The default value is 0.990. \cr} + +\item{alpha}{Alpha (Angstrom exponent), gives wavelength dependence of optical depth, by multiplying the 550 nm value by (550 nm/wavelength, nm)**alpha. The default value is 1.000. \cr} + +\item{time}{Hour. The default value is 12. \cr} + +\item{outputMode}{The default value is 2. OutputMode 2: Molecular photolysis frequencies (109 photoreactions). OutputMode 3: Weighted irradiance (27 weighting functions). OutputMode 4: Spectral actinic flux. OutputMode 5: Spectral irradiance.} + +\item{nStreams}{The default value is -2. NStreams -2: Pseudo-spherical 2 streams (faster, less accurate). NStreams 4: Pseudo-spherical discrete ordinate 4 streams (slower, more accurate).} + +\item{dirsun}{Direct beam, direct solar beam. The default value is 1.0. \cr} + +\item{difdn}{Diffuse down, down-ward propagating scattered radiation (diffuse sky light). The default value is 1.0. \cr} + +\item{difup}{Diffuse up, up-ward propagating scattered radiation (diffuse light from below). The default value is NA. \cr} +} +\value{ +a dataframe. The contents of dataframe are diterminated by OutputMode. \cr +OutputMode 2: Molecular photolysis frequencies (109 photoreactions). \cr +OutputMode 3: Weighted irradiance (27 weighting functions). \cr +OutputMode 4: Spectral actinic flux. \cr +OutputMode 5: Spectral irradiance. \cr +} +\description{ +This function runs TUV online by reading the input parameters, and summarizes the results to the new dataframe. \cr +}