Skip to content

Commit c748432

Browse files
committed
Adding more tutorial
1 parent 01a7a81 commit c748432

24 files changed

+1453
-163
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ _Intelligent and comprehensive swath analysis_
2626
Read the documentation at: https://pyosp.readthedocs.io/en/latest/index.html
2727

2828
## Installation
29-
We recommend to use the [conda](https://conda.io/en/latest/) package manager to install pyosp. It will provide pre-built binaries for all dependencies of pyosp. if you have the [miniconda](https://docs.conda.io/en/latest/miniconda.html) (recommend; only containing python and the conda package manager), or [anaconda distribution](https://www.anaconda.com/) (a python distribution with many installed libraries for data science) installed, then simply execute the following command:
29+
We recommend to use the [conda](https://conda.io/en/latest/) package manager to install pyosp. It will provide pre-built binaries for all dependencies of pyosp. If you have the [miniconda](https://docs.conda.io/en/latest/miniconda.html) (recommend; only containing python and the conda package manager), or [anaconda distribution](https://www.anaconda.com/) (a python distribution with many installed libraries for data science) installed, then simply execute the following command:
3030

3131
```bash
32-
conda install -c conda-forge -c kgsdev pyosp
32+
conda install -c conda-forge pyosp
3333
```
3434

3535
You can also install from current branch:
@@ -49,7 +49,7 @@ print(pyosp.__version__)
4949
```
5050

5151
## Example
52-
Here is a simple example of using pyosp to perform swath analysis on a synthetic mountain case. the cross-width of mountain is around 90m, and only mountainous area possess non-zero elevations.
52+
Here is a simple example of using pyosp to perform swath analysis on a synthetic mountain case. The cross-width of mountain is around 90m, and only mountainous area possess non-zero elevations.
5353

5454
<p><img alt="homo_case" src="https://i.imgur.com/nSFSqxo.png" height="200"/></p>
5555

@@ -77,7 +77,7 @@ tpi = pyosp.tpi_curv(line, raster, width=100,
7777
line_stepsize=3, cross_stepsize=none)
7878
```
7979

80-
You can plot with matplotlib, or open in gis software.
80+
You can plot with matplotlib, or open in GIS software.
8181

8282
<p><img alt="homo_polygon" src="https://i.imgur.com/nLgQEsJ.jpg" height="200"/></p>
8383

@@ -89,7 +89,7 @@ elev.profile_plot()
8989

9090
<img alt="elev_sp" src="https://i.imgur.com/0taXAhF.jpg.jpg" height="200"/></p>
9191

92-
_For more example and usage, please refer to our publication, example gallery and documentation._
92+
_For more example and usage, please refer to our documentation._
9393

9494
## Citing pyosp
9595

docs/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ PyOSP supports Python 3.6 or higher, and depends on `Numpy <https://numpy.org/>`
2424
:caption: Tutorial
2525

2626
Customized swath analysis and essential data structure <notebooks/customized_swath>
27-
Slice and histogram analysis
28-
Swath profile with scatter plots
29-
Cross-swath analysis
30-
Density(Hot) scatter plot
31-
Data reclassification
27+
Slice and histogram analysis <notebooks/Slice_hist>
28+
Swath profile with scatter plots <notebooks/swath_scatter>
29+
Cross-swath analysis <notebooks/cross_swath>
30+
Density(Heat) scatter plot <notebooks/density_scatter>
31+
Data reclassification <notebooks/reclass>
3232

3333
Indices and tables
3434
==================

docs/notebooks/Slice_hist.ipynb

Lines changed: 447 additions & 0 deletions
Large diffs are not rendered by default.

docs/notebooks/cross_swath.ipynb

Lines changed: 208 additions & 0 deletions
Large diffs are not rendered by default.

docs/notebooks/customized_swath.ipynb

Lines changed: 19 additions & 19 deletions
Large diffs are not rendered by default.

docs/notebooks/density_scatter.ipynb

Lines changed: 163 additions & 0 deletions
Large diffs are not rendered by default.

docs/notebooks/fix_width_curv.ipynb

Lines changed: 7 additions & 7 deletions
Large diffs are not rendered by default.

docs/notebooks/object_homo.ipynb

Lines changed: 10 additions & 10 deletions
Large diffs are not rendered by default.

docs/notebooks/reclass.ipynb

Lines changed: 230 additions & 0 deletions
Large diffs are not rendered by default.

docs/notebooks/swath_scatter.ipynb

Lines changed: 174 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)