-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
16 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters