up rd

Author: changliao1025

README.md

@@ -1,22 +1,53 @@
-# HexWatershed
+## `HexWatershed`
 
-HexWatershed is a hydrologic routing model based on the hexagon mesh framework.
+HexWatershed: a mesh independent flow direction model for hydrologic models.
 
-The HexWatershed Version 1.0.0 has been moved under the PNNL offical Github account at:
+This is the C++ back-end of the HexWatershed Python package (https://github.com/changliao1025/pyhexwatershed). 
+
+The HexWatershed Version v1.0 has been moved under the PNNL Github account at:
 https://github.com/pnnl/hexwatershed
 
-Newer version which includes NetCDF and VTK support will be released upon request.
+Currently, only HexWatershed v3.0 is maintained and supported.
+
+### `Acknowledgement`
+
+This work was supported by the Earth System Model Development program areas of the U.S. Department of Energy, Office of Science, Office of Biological and Environmental Research as part of the multi-program, collaborative Integrated Coastal Modeling (ICoM) project. 
+
+### `License`
+
+Copyright © 2022, Battelle Memorial Institute
+
+1. Battelle Memorial Institute (hereinafter Battelle) hereby grants permission to any person or entity lawfully obtaining a copy of this software and associated documentation files (hereinafter “the Software”) to redistribute and use the Software in source and binary forms, with or without modification. Such person or entity may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and may permit others to do so, subject to the following conditions:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Other than as used herein, neither the name Battelle Memorial Institute or Battelle may be used in any form whatsoever without the express written consent of Battelle.
+
+2. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BATTELLE OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+### `References`
+
+There are a number of publications that describe the algorithms used in `HexWatershed` in detail. If you make use of `HexWatershed` in your work, please consider including a reference to the following:
+
+
+* Liao, Chang, Tian Zhou, Donghui Xu, Richard Barnes, Gautam Bisht, Hong-Yi Li, Zeli Tan, et al. (02/2022AD) 2022. “Advances In Hexagon Mesh-Based Flow Direction Modeling”. Advances In Water Resources 160. Elsevier BV: 104099. 
+https://doi.org/10.1016/j.advwatres.2021.104099.
+
+* Liao, C., Tesfa, T., Duan, Z., & Leung, L. R. (2020). Watershed delineation on a hexagonal mesh grid. Environmental Modelling & Software, 128, 104702. https://doi.org/10.1016/j.envsoft.2020.104702
+
+* Liao. C. (2022) Pyflowline: a mesh independent river network generator for hydrologic models. Zenodo.
+https://doi.org/10.5281/zenodo.6407299
 
-Global Routing Map:
-https://youtu.be/t86fTpJX9Es
+* Liao. C. (2022). HexWatershed: a mesh independent flow direction model for hydrologic models (0.1.1). Zenodo. https://doi.org/10.5281/zenodo.6425881
 
-VTK support:
-https://youtu.be/Vuqz3hdRK0s
 
 
+## Contact
 
-# Contact
-We are now using the issue for Q&A. Please navigate to https://github.com/pnnl/hexwatershed/issues if you have technical issues.
+Please using the Github issue for Q&A. Please navigate to https://github.com/changliao1025/pyhexwatershed/issues if you have technical issues.
 
 For other types of questions, you can ask in the Slack hexwatershed channel. Send an email to changliao.climate@gmail.com with your preferred email address.