Skip to content

Commit

Permalink
Merge pull request #162 from changliao1025/development
Browse files Browse the repository at this point in the history
add more details for readme
  • Loading branch information
changliao1025 committed Jul 20, 2023
2 parents 505cc4e + 5b5f601 commit 24e72f8
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/source/readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ Overview

PyFlowline is a mesh-independent river network generator for hydrologic models.

Traditionally, the river network is represented by the vector-based river network. These vector-based river networks usually cannot be directly used by hydrologic models, which use the mesh as the spatial discretization.

In most cases, the vector-based river network datasets are used in a so-called stream-burning process to convert the vector-based river network to the mesh-based river network. However, all the existing stream-burning methods only support the structured meshes and there are also some other limitations.

To close this gap, PyFlowline was developed using a mesh-independent approach. At its core, PyFlowline uses the intersection between the vector river network and mesh to reconstruct the conceptual river network. It also addresses several limitations of the existing stream-burning methods.

***********
Development
***********
Expand All @@ -31,4 +37,4 @@ Important notice

1. PyFlowline is designed to run at regional to global scale, so all the datasets use the geographic coordinate system (GCS) with the WGS84 datum. See more details at https://pyflowline.readthedocs.io/en/latest/data/data.html

2. Visualization of the PyFlowline outputs is only experimental. This feature is not fully developed yet. There is ongoing effort to use the `PyEarth` pythong package to provide this feature.
2. Visualization of the PyFlowline outputs is only experimental. This feature is not fully developed yet. There is ongoing effort to use the `PyEarth` python package to provide this feature.

0 comments on commit 24e72f8

Please sign in to comment.