From 2c5f219a786cfb863dda4ffe50f6db988cf40897 Mon Sep 17 00:00:00 2001 From: iosefa Date: Tue, 3 Dec 2024 02:00:35 -1000 Subject: [PATCH] Add jupyter notebook examples and installation guide 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. --- docs/index.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/index.md b/docs/index.md index e9af548..c5b2c7a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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.