readme&path

ahomoudi · Mar 12, 2024 · 94c4e2c · 94c4e2c
1 parent 6cb7a14
commit 94c4e2c
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 10 deletions.
diff --git a/QuartoBook/.gitignore b/QuartoBook/.gitignore
@@ -1 +1,4 @@
 /.quarto/
+data/
+microbenchmark/
+*.csv
diff --git a/QuartoBook/AquaFortR_Codes/cape_f.R b/QuartoBook/AquaFortR_Codes/cape_f.R
@@ -1,7 +1,7 @@
 cape_f0 <- function(t_parcel, dwpt_parcel, mr_parcel,
                     p_profile, t_profile, mr_profile,
                     vtc = TRUE) {
-  dyn.load("AquaFortR_Codes/cape_f.so")
+  dyn.load("AquaFortR_Codes/cape.so")
 
   nlevel <- length(p_profile)
   nresult <- 4

diff --git a/QuartoBook/AquaFortR_Codes/xcorr2D_f.R b/QuartoBook/AquaFortR_Codes/xcorr2D_f.R
@@ -1,6 +1,5 @@
 xcorr2D_f0 <- function(a, b) {
-  # Please adjust the path to your setup. In my machine,
-  # I have a folder called "fortran" containing all f90 files
+  # Please adjust the path to your setup.
   dyn.load("AquaFortR_Codes/xcorr2D.so")
 
   # the full CC matrix

diff --git a/README.md b/README.md
@@ -7,7 +7,6 @@
 [![License](https://img.shields.io/badge/License-CCBY-blue)](#license)
 <!-- badges: end -->
 
-
 This is the official repository of the Project AquaFortR: Streamlining Atmospheric Science, Oceanography, Climate, and Water Research with Fortran-accelerated R. 
 
 The repository is structured as follows:
@@ -20,18 +19,34 @@ The documentation of the project is rendered [here](https://ahomoudi.github.io/A
 
 ## Installation 
 
+### Package
 To install the AquaFortR package, please use: 
 
 ```r
 remotes::install_github("AHomoudi/AquaFortR", subdir = "RPackage")
 ```
+
+### Swirl
+To install the AquaFortR Swirl Course, please download the compressed course from 
+<a href="AquaFortR_Swirl.zip">here</a> and use the code below. 
+
+```r
+swirl::install_course_zip("path/to/AquaFortR_Swirl.zip")
+```
+
+### Book 
+
+Materials for the chapter 2 are available <a href="AquaFortR_Codes.zip">here</a>. Please, 
+revise the path to the shared libraries files in the R-Fortran functions.
+
 ## Acknowledgment
 
 This work has been funded by the German Research Foundation (DFG) through the project NFDI4Earth (DFG project no. 460036893, https://www.nfdi4earth.de/) within the German National Research Data Infrastructure (NFDI, https://www.nfdi.de/). 
 
 ## License
 
-Released under [CCBY](/LICENSE) by [@AHomoudi](https://github.com/AHomoudi).
+This work is licensed under the Creative Commons Attribution-NonCommercial 4.0 
+International (CC BY-NC 4.0) License (<https://creativecommons.org/licenses/by-nc/4.0/>).
 
 
 <!---  setwd("C:\\Projects\\AquaFortR") --->
diff --git a/RPackage/R/utilities.R b/RPackage/R/utilities.R
@@ -31,7 +31,7 @@ specific_heat_liquid_water <- function(temperature) {
 #' Estimation of Saturation vapour pressure [hPa] from temperature [k].
 #' @param temperature in [k]
 #' @param ice TRUE or FALSE, if to consider ice state or not.
-#' @author Klemens Barfus
+#' @author Klemens Barfus (Original in Fortran), translated to R by Ahmed Homoudi
 #' @export
 saturation_vapour_pressure <- function(temperature, ice = FALSE) {
   e0 <- 0.611 # kPa

diff --git a/RPackage/README.md b/RPackage/README.md
@@ -1,5 +1,12 @@
 # AquaFortR
 
+<!-- badges: start -->
+[![R-CMD-check](https://github.com/AHomoudi/AquaFortR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/AHomoudi/AquaFortR/actions/workflows/R-CMD-check.yaml)
+[![Quarto Publish](https://github.com/AHomoudi/AquaFortR/workflows/Quarto%20Publish/badge.svg)](https://github.com/AHomoudi/AquaFortR/actions?query=workflow:"Quarto+Publish")
+[![GitHub tag](https://img.shields.io/github/tag/AHomoudi/AquaFortR?include_prereleases=&sort=semver&color=blue)](https://github.com/AHomoudi/AquaFortR/releases/)
+[![License](https://img.shields.io/badge/License-CCBY-blue)](#license)
+<!-- badges: end -->
+
 This is the main webpage of the project AquaFortR: Streamlining Atmospheric Science, Oceanography, Climate, and Water Research with Fortran-accelerated R. 
 
 The project's [repository](https://ahomoudi.github.io/AquaFortR/) is structured as follows:
@@ -11,21 +18,26 @@ The project's [repository](https://ahomoudi.github.io/AquaFortR/) is structured
 ## Installation 
 
 ### Package
+
 To install the AquaFortR package, please use: 
 
 ```r
 remotes::install_github("AHomoudi/AquaFortR", subdir = "RPackage")
 ```
 ### Swirl
-To install the AquaFortR Swirl Course, please download the compressed course and 
-use the code below. 
-
-<a href="AquaFortR_Swirl.zip">Download</a>
+To install the AquaFortR Swirl Course, please download the compressed course from 
+<a href="AquaFortR_Swirl.zip">here</a> and use the code below. 
 
 ```r
 swirl::install_course_zip("path/to/AquaFortR_Swirl.zip")
 ```
 
+### Book 
+
+Materials for the chapter 2 are available <a href="AquaFortR_Codes.zip">here</a>. Please, 
+revise the path to the shared libraries files in the R-Fortran functions.
+
+
 ## Acknowledgment
 
 This work has been funded by the German Research Foundation (DFG) through the project NFDI4Earth (DFG project no. 460036893, https://www.nfdi4earth.de/) within the German National Research Data Infrastructure (NFDI, https://www.nfdi.de/).