Skip to content

Commit

Permalink
Add jupyter notebook examples and installation guide
Browse files Browse the repository at this point in the history
Updated the documentation to include guidance on using jupyter notebooks with examples to help users get started. Added instructions for installing jupyter using either conda or pip for easy setup.
  • Loading branch information
iosefa committed Dec 3, 2024
1 parent 7ebc5a3 commit 2c5f219
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,23 @@ PyForestScan is a Python library designed for analyzing and visualizing forest s

## Examples

The examples below are jupyter notebooks and can help you get started!

- [Getting Started: DTM and CHM](examples/getting-started.ipynb)
- [Calculating Forest Metrics](examples/calculate-forest-metrics.ipynb)
- [Working with Large Point Clouds](examples/working-with-large-point-clouds.ipynb)

To install jupyter, you can use conda or pip, with either:

```python
conda install jupyter
```
or

```python
pip install jupyter
```

## Attribution

This library makes heavy use of PDAL (Butler et al. 2024; Butler et al. 2021) for its IO operations. PDAL and the PDAL Python Bindings provide excellent functional support for conducting standard operations on point clouds. Our work to calculate forest structural metrics would have been a lot harder without PDAL.
Expand Down

0 comments on commit 2c5f219

Please sign in to comment.