Merge pull request #144 from changliao1025/development

Development
changliao1025 · Jun 14, 2023 · 153f45f · 153f45f
2 parents e6b605a + 001964f
commit 153f45f
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ PyFlowline depends on the following packages
 3. `netCDF4`
 4. `shapely`
 
-PyFlowline also have three optional dependency packages
+PyFlowline also has three optional dependency packages
 
 1. `cython` for performance 
 2. `matplotlin` for visualization
@@ -47,6 +47,8 @@ This work was supported by the Earth System Model Development program areas of t
 
 ### License
 
+BSD 3-Clause 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:
@@ -63,7 +65,7 @@ Copyright © 2022, Battelle Memorial Institute
 
 Several publications describe the algorithms used in `PyFlowline` in detail. If you make use of `PyFlowline` in your work, please consider including a reference to the following:
 
-* Liao. C. Cooper, M (2022) Pyflowline: a mesh independent river network generator for hydrologic models. Zenodo.
+* Liao. C. Cooper, M (2022) Pyflowline: a mesh-independent river network generator for hydrologic models. Zenodo.
 https://doi.org/10.5281/zenodo.6407299
 
 * Liao, C., Zhou, T., Xu, D., Cooper, M. G., Engwirda, D., Li, H.-Y., & Leung, L. R. (2023). Topological relationship-based flow direction modeling: Mesh-independent river networks representation. Journal of Advances in Modeling Earth Systems, 15, e2022MS003089. https://doi.org/10.1029/2022MS003089
diff --git a/paper.bib b/paper.bib
@@ -1,6 +1,7 @@
 @article{Engwirda:2021,
   title={‘UNIFIED’LAGUERRE-POWER MESHES FOR COUPLED EARTH SYSTEM MODELLING},
   author={Engwirda, Darren and Liao, Chang},
+  year = {2021},
   doi = {10.5281/zenodo.5558988},
 }
 
@@ -26,6 +27,7 @@ @article{Liao:2022
 author = {Liao, Chang and Zhou, Tian and Xu, Donghui and Cooper, Matthew G and Engwirda, Darren and Li, Hong-Yi and Leung, L. Ruby},
 title = {Topological relationship-based flow direction modeling: Mesh-independent river networks representation},
 journal = {Journal of Advances in Modeling Earth Systems},
+year = {2022},
 volume = {n/a},
 number = {n/a},
 pages = {e2022MS003089},

diff --git a/paper.md b/paper.md
@@ -65,7 +65,7 @@ PyFlowline provides several key features, including
 
 Existing river network representation methods often fall into these three categories:
 
-1. Vector-based, hydrologic models use this method cannot couple river and land because there is no one-to-one mapping [@Schwenk:2021];
+1. Vector-based, hydrologic models that use this method cannot couple river and land because there is no one-to-one mapping [@Schwenk:2021];
 2. High-resolution DEM-based, only supports structured rectangle grids (e.g., 30m x 30m ) at high spatial resolutions [@Esri:2011];
 3. Upscaling-based, only supports structured geographic grids (e.g., 0.5 degree x 0.5 degree) at coarse resolutions [@Wu:2012]. This method often cannot provide global coverage including Greenland and Antarctic.
 

diff --git a/tests/test_installation.py b/tests/test_installation.py
@@ -0,0 +1,12 @@
+
+def test_installation():
+    try:
+        import pyflowline
+        from pyflowline.classes.pycase import flowlinecase
+        print('pyflowline is installed properly')
+    except:
+        print('pyflowline is not installed properly')
+
+test_installation()
+
+