Evapotranspiration Comparison Added

Author: erazocar

README.md

@@ -35,7 +35,7 @@ Models can be developed in HydroLang through two ways:
 Please refer to the [models page](https://github.com/uihilab/HydroLang-Models/tree/main/models) for more information.
 
 ### Data
-HydroLang allows users to retrieve, filter, process, and combine hydrological data from a variety of resources. Under this folder, the users can share their data retrieval scripts for future utilization and reference.
+HydroLang allows users to retrieve, filter, process, and combine hydrological data from a variety of resources. Under this folder, the users can share their data retrieval scripts for future utilization and reference. Being data driven and with several options for retrieval, HydroLang data sources contain most variables that can be used for specific analyses. You can find more info in the [following link](https://github.com/uihilab/HydroLang/tree/master/hydrolang/modules/data).
 
 ### Case Studies
 One of the main goals of HydroLang is to simplify hydrological data retrieval, analysis, visualization, modeling, and mapping with readable, concise, and contained code, thanks to its comprehensive and modular design. HydroLang users can share their case study scripts for reproduction, modification, and feedback collection.

case-studies/README.md

@@ -6,7 +6,7 @@ Users can tailor their case studies in whichever format they see fit. We do reco
 ## What to Include
 Each case study should have a .txt, .md, or any rich text format with minimum the following items:
 * Few lines describing the scope of the research.
-* Published works if available/applicable.
+* Referenced or published papers and manuscripts if available/applicable.
 * Functions used from the framework.
 * Results
 

models/README.md

@@ -45,7 +45,7 @@ Since some of the functions run asynchronously, running the script through the H
 
 ## Using the BMI compliant version
 
-The [BMI](https://csdms.colorado.edu/wiki/BMI) compliant version of HydroLang allows users to declare models through steering files rather than using the API directly, for HydroLang releases 1.1.x onwards. A thorough explanation on how to declare the functions for a specific use case can be seen in [this example](https://github.com/uihilab/HydroLang/tree/master/hydrolang/bmi-implementation). Running a simulation requires the use of the HydroLang-Compliant class for BMI, declared as:
+The [BMI](https://csdms.colorado.edu/wiki/BMI) compliant version of HydroLang allows users to declare models through steering files rather than using the API directly, for HydroLang releases 1.1.x onwards. A thorough explanation on how to declare the functions for a specific use case can be seen in [this LINK](https://github.com/uihilab/HydroLang/tree/master/hydrolang/bmi-implementation). Running a simulation requires the use of the HydroLang-Compliant class for BMI, declared as:
 
 ```html
 <script

models/evapotranspiration/README.md

@@ -1,2 +1,2 @@
 # Evapotranspiration Models
-Add your models here with proper labelling and metadata (i.e. purpose, training details, misc. information)
+Add your models here with proper labelling and metadata (i.e. purpose, training details, misc. information)

models/evapotranspiration/comparing_values/README.md

@@ -0,0 +1,27 @@
+# Data Retrieval and Comparison
+
+## Introduction
+
+This model retrieves potential evapotranspiration data from CUAHSI source [MOPEX](https://pubs.er.usgs.gov/publication/70030278) (Model Parameter Esimation Experiment) for a station in [Tallapoosa River](https://selfie.cuahsi.org/MOPEX/02414500), and near [Locust Fork](https://selfie.cuahsi.org/MOPEX/02456500) to compare the two datasets statistically and evaluate if they might come from the same sample.
+
+## Workflow
+The data is retrieved from the datasource with the data type "GetValuesObject" for both locations. Since we only require the values for each location, the values are stripped and afterwards the Kolmogorov-Smirnov two sided test is used to determine P and D-statistics. The results were afterwards retrieved rendered on screen to see the trends on the data as column bars.
+
+The results from the P-Value show that the two groups were smapled from populations on different distributinons with low variability.
+
+## Running
+Please run your code onloading the HydroLang library in an HTML file using either a local live server or using any other way to serve HTML pages. In your web console, you can replicate the results by copy-pasting the lines delimited by comments inside JS file attached to this folder.
+
+## Notes
+A proxy server is required to run to retrieve data from CUAHSI data sources. For this model, we are using a local proxy server deployed using Node.js. If you do not have Node, please change the following in the configuration object and visit the proxy server requirements prior to running.
+
+```javascript
+//Some code
+  general_config = {
+    source: "waterOneFlow",
+    datatype: "GetValuesObject",
+    proxyServer: "local-proxy", // use cors-anywhere instead
+  },
+```
+
+

models/evapotranspiration/comparing_values/comparing_datasets.js

@@ -0,0 +1,60 @@
+//Declaring the HydroLang library instance and using the retrieval functions. The retrieved data contains daily values for both datasets.
+var hydro = new Hydrolang(),
+  general_config = {
+    source: "waterOneFlow",
+    datatype: "GetValuesObject",
+    proxyServer: "local-proxy",
+  },
+  args_1 = {
+    sourceType: "MOPEX",
+    location: "02414500",
+    variable: "Clim_PE",
+    startDate: "2003-01-01",
+    endDate: "2003-11-30",
+  },
+  response_1 = hydro.data.retrieve({ params: general_config, args: args_1 }),
+  args_2 = {
+    sourceType: "MOPEX",
+    location: "02456500",
+    variable: "Clim_PE",
+    startDate: "2003-01-01",
+    endDate: "2003-11-30",
+  },
+  response_2 = hydro.data.retrieve({ params: general_config, args: args_2 });
+
+//Stripping the values from the dataset
+var clean_1 =
+    response_1[0].TimeSeriesResponse.timeSeriesResponse.timeSeries.values.value.map(
+      (x) => JSON.parse(x)
+    ),
+  clean_2 =
+    response_2[0].TimeSeriesResponse.timeSeriesResponse.timeSeries.values.value.map(
+      (x) => JSON.parse(x)
+    );
+
+//Visualizing the raw datasets. Notice that the data does not contain information about the dates
+var chart_1 = [Array.from(Array(clean_1.length).keys()), clean_1],
+  chart_2 = [Array.from(Array(clean_2.length).keys()), clean_2];
+hydro.visualize.draw({
+  params: { type: "chart", divID: "data_1_chart" },
+  args: { charttype: "column" },
+  data: chart_1,
+});
+hydro.visualize.draw({
+  params: { type: "chart", divID: "data_2_chart" },
+  args: { charttype: "column" },
+  data: chart_2,
+});
+
+//Visualizing the basic statistics of the datasets
+hydro.visualize.draw({
+  params: { type: "table", divID: "data_1_stats" },
+  data: hydro.analyze.stats.basicstats({ data: clean_1 }),
+});
+hydro.visualize.draw({
+  params: { type: "table", divID: "data_2_stats" },
+  data: hydro.analyze.stats.basicstats({ data: clean_2 }),
+});
+
+//Calculate the KS-two sided test
+var KS_P = hydro.analyze.stats.KS_computePValue({ data: [clean_1, clean_2] });

models/hazards/README.md

@@ -1,2 +1,7 @@
 # Hazards Models
 Add your models here with proper labelling and metadata (i.e. purpose, training details, misc. information)
+
+# Data sources
+The main sources that contain data for hazards are the following:
+
+* [FEMA](https://github.com/uihilab/HydroLang/blob/master/hydrolang/modules/data/datasources/fema.js)