Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating the getting started page #1659

Merged
merged 3 commits into from
Mar 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Overview

[PlantCV](http://plantcv.danforthcenter.org) is composed of modular functions in order to be applicable to a
variety of plant types and imaging systems. In the following documentation we will describe use of each function and
variety of plant types and imaging systems. In the following documentation we describe use of each function and
provide tutorials on how each function is used in the context of an overall image-processing workflow. PlantCV
currently supports the analysis of standard RGB color images (aka "VIS"), standard grayscale images (e.g.
near-infrared, "NIR"), thermal infrared images, grayscale images from chlorophyll fluorescence imaging systems
Expand All @@ -13,25 +13,26 @@ on the [GitHub issues page](https://github.com/danforthcenter/plantcv/issues).

## Getting started

The documentation can be navigated using the sidebar table of contents. Documentation for individual PlantCV functions
are listed under the headings "PlantCV Namespace". For general information on installation,
updating, and other questions, see:
If this is your first time using PlantCV, we recommend following this list of documentation pages to get started:

* [Install PlantCV](installation.md)
* [Use PlantCV with Jupyter Notebooks](jupyter.md)
* [Get started buildling an image analysis workflow](analysis_approach.md)
* [Run your workflow in parallel](pipeline_parallel.md)
* [Use the json2csv tool to convert results files to csv](tools.md)
* [Summary of output measurements generated by PlantCV](output_measurements.md)

!!! tip
Documentation for individual PlantCV functions are listed under the headings "PlantCV Namespace" in the sidebar.

Other useful reference pages:

* [Installing PlantCV](installation.md)
* [Updating PlantCV](updating.md)
* [Frequently Asked Questions](faq.md)
* [General Approaches to Image Analysis with PlantCV](analysis_approach.md)
* [Using Jupyter Notebooks with PlantCV](jupyter.md)
* [Summary of Output Measurements and Database Structure](output_measurements.md)

## Tutorials

We have added interactive documentation (the link takes up to a few minutes to load so be patient please),
so you can test out workflows and even upload your own images to test on.

* [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/danforthcenter/plantcv-binder.git/master?filepath=index.ipynb) Check out our interactive tutorials!

Also see our tutorials documentation pages for more detailed overviews of using PlantCV for specific tasks:
Check out our tutorials below or in our [Tutorial Gallery](tutorials.md) to learn how to analyze different types of images:

* [VIS/RGB Image Processing](tutorials/vis_tutorial.md)
* [Grayscale Image Processing](tutorials/grayscale_tutorial.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyter.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ over many images.

<iframe src="https://scribehow.com/embed/Using_PlantCV_with_Jupyter_Notebooks__Jnhb53WlTtqohKYR8_UUfA" width="640" height="640" allowfullscreen frameborder="0"></iframe>


---

### Example of PlantCV running in Jupyter

Expand Down