This project aimed to the development and implementation of markup language usage for hydrological sciences using web components. It enables the usage of the modules already developed within the HydroLang.js framework using simple and semantic markup language that enables the use of complex functions. The developed library contains modular components that enables the following:
- Data: used for data retrieval, manipulation, download and upload.
- Analyze: contains three different components, each aiming towards a similar purpose:
- hydro: functions for precipitation analysis and rainfall-runoff lumped models.
- stats: functions for statistical characterization of data.
- Visualization: used for rendering different types of charts and tables on screen using Google Charts.
- Maps: used for rendering of maps with option of adding/removing/downloading layers of different formats (geoJSON, KML) using two options on map engines Google Maps and Leaflet.
HydroLang-ML is using the last version of the HydroLang.js framework as a main engine.
Please download the library and run any of the provided examples, or create a new HTML file onloading the library on the header of the page as a script:
<link rel="stylesheet" href="../lib/libraries/hydrolang/external/css/hydrolang.css"/>
<script type="module" src="../lib/main.js"></script>The library enables for the use of components as HTML tags that can access most of the functions in the framework following the parameter, argument, data ontology of the framework. They must be wrapped around a div element that encapsulates the whole library.
<body>
<div id="hydrolang">
<hydrolang-ml>
<!--Components go here!-->
</hydrolang-ml>
</div>
</body>Each component can be used using its corresponding tag notation. The components enable the use of Hydrolang's modular architecture to access the functions through passing properties into the components, each varying depending on the type of functions needed to be accessed, wrapped inside the <hydrolang-ml></hydrolang-ml> tags.
Summary of function call for a module (the "-here" separation not required):
<hydrolang-ml>
<analyze-mod method="someFunctionName">
<parameters-here someAtrr="Some Attribute"></parameters-here>
<arguments-here somArgs="someArguments"></arguments-here>
<dataset-here>[1,2,3,4]</dataset-here>
</analyze-mod>
</hydrolang-ml>The usage of <dataset></dataset> tags is only required whenever a user wants to pass data as an input. For example, if a user has already downloaded data from a USGS source and is saved in the local storage and would like to transform the data into a JS array, then the following code would work:
<data-mod method="transform">
<parameters-here input="usgs_data" save="value" output="cleaned_usgs_data1" ></parameters-here>
<arguments-here type="ARR" keep='["datetime", "value"]'></arguments-here>
</data-mod>The input tag is used to call data saved in the local storage. To visualize all the objects currently available in the local storage, the user would use the following components:
<visualize-mod method="draw">
<parameters-here type="json" input="usgs_data"></parameters-here>
</visualize-mod>To use the library, a live server is required. If using VSCode, live server would allow for automatic refresh when putting the HTML tags into screen.
Specific examples on each module usage as well as crosses between functionalities can be found in the following links:
The documentation for the steering functions, arguments, and more examples on usage can be found i nthe documentation page. To see the function requirements needed from HydroLang's modules, please visit the documentation of the framework.
HL-ML is part of the bigger picture created by HydroLang.js. It is a scalable, reusable, and easily adaptable framework that allows for growth through community-based collaboration from research institutions and individuals with expertise. The modules contained in HL-ML were built to create hands-on experience on hydrological research and its ease of implementation allows for new modules to be added as the HydroLang modules grow. We encourage the users to create new modules for HydroLang following the guidelines established in the framework, and of course:
- filing an issue to request certain features, functionality, and data,
- implementing the desired capability on a fork, and submitting a pull request.
Furthermore, for community building, we encourage users of HydroLang to share their models, codes, and case studies on HydroLang-Models repository.
Please feel free to send feedback to us on any issues found by filling an issue.
This project is licensed under the GPL License - see the LICENSE file for details.
This project is developed by the University of Iowa Hydroinformatics Lab (UIHI Lab):
https://hydroinformatics.uiowa.edu/
- Ramirez, C.E., Sermet, Y., Molkenthin, F. and Demir, I., 2021. HydroLang: An Open-Source Web-Based Programming Framework for Hydrological Sciences. https://doi.org/10.31223/X5M31D
- Ramirez, C.E., Sermet, Y., Demir, I., 2022. HydroLang Markup Language: Community-Driven Web Components for Hydrological Analyses. https://doi.org/10.31223/X5NP9M