Skip to content

Commit

Permalink
Edit readme and manual introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
whyjz committed Oct 5, 2023
1 parent 97a7714 commit 7bce450
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
# GLAcier Feature Tracking testkit: `glaft`

Python module for assessing glacier velocity maps using statistics- and physics-based metrics. Includes demo Notebook examples using data from Kaskawulsh glacier, Canada.
A Python package for assessing and benchmarking feature-tracked glacier velocity maps derived from satellite imagery. Includes demo Notebook examples using data from Kaskawulsh glacier, Canada. See our [user manual](https://whyjz.github.io/GLAFT/doc/introduction.html) for more information.

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/whyjz/GLAFT/master?labpath=doc%2Fquickstart.ipynb)

## Installation

GLAFT is available through `pip` installation:
**Try GLAFT without installing**: We recommend running our [Quick Start notebook on MyBinder.org](https://mybinder.org/v2/gh/whyjz/glacier-ft-test/master?urlpath=tree/jupyter-book/doc/quickstart.ipynb).

**For cloud access**: We recommend using the [Ghub portal to launch GLAFT](https://theghub.org/tools/glaft/status) (registration required).

**For local installation**: GLAFT is available on PyPI and can be installed via `pip`.

```
pip install glaft
```

## Using GLAFT
## License

GLAFT uses the [MIT License](https://github.com/whyjz/GLAFT/blob/master/LICENSE).

Try it on [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/whyjz/GLAFT/master?labpath=doc%2Fquickstart.ipynb), or see our [user manual](https://whyjz.github.io/GLAFT/doc/introduction.html) for more information.
Contribution is always welcome!
5 changes: 4 additions & 1 deletion doc/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction

GLAcier Feature Tracking testkit (GLAFT) is a Python package for assessing and benchmarking feature-tracked glacier velocity maps derived from satellite imagery. To be compatible with as many feature-tracking tools as possible, GLAFT analyzes velocity maps (and optional reliability files used as weight) and calculates two metrics based on statistics and ice flow dynamics. Along with GLAFT’s visualization tools, users can intercompare the quality of velocity maps processed by different methods and parameter sets. In the [GLAFT publication](https://doi.org/10.5194/tc-2023-38), we further provide a guideline for optimizing glacier velocity maps by comparing the calculated metrics to an ideal threshold value.
GLAcier Feature Tracking testkit (GLAFT) is a Python package for assessing and benchmarking feature-tracked glacier velocity maps derived from satellite imagery. To be compatible with as many feature-tracking tools as possible, GLAFT analyzes velocity maps (and optional reliability files used as weight) and calculates two metrics based on statistics and ice flow dynamics. Along with GLAFT’s visualization tools, users can intercompare the quality of velocity maps processed by different methods and parameter sets. In the [GLAFT publication](https://doi.org/10.5194/tc-17-4063-2023), we further provide a guideline for optimizing glacier velocity maps by comparing the calculated metrics to an ideal threshold value.

GLAFT is an open sourced project and is hosted on Github (https://github.com/whyjz/GLAFT). All documentation and cloud-executable demos are deployed as Jupyter Book pages (https://whyjz.github.io/GLAFT/).

Expand All @@ -20,3 +20,6 @@ pip install glaft

GLAFT uses the MIT License. More information is available [here](https://github.com/whyjz/GLAFT/blob/master/LICENSE).

## Citing GLAFT

Zheng, W., Bhushan, S., Van Wyk De Vries, M., Kochtitzky, W., Shean, D., Copland, L., Dow, C., Jones-Ivey, R., and Pérez, F.: GLAcier Feature Tracking testkit (GLAFT): a statistically and physically based framework for evaluating glacier velocity products derived from optical satellite image feature tracking, The Cryosphere, 17, 4063–4078, https://doi.org/10.5194/tc-17-4063-2023, 2023.

0 comments on commit 7bce450

Please sign in to comment.