diff --git a/docs/index.md b/docs/index.md index 2537cc08d..6879972fd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 @@ -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) diff --git a/docs/jupyter.md b/docs/jupyter.md index 21018594d..cad99cbaf 100644 --- a/docs/jupyter.md +++ b/docs/jupyter.md @@ -19,7 +19,7 @@ over many images. - +--- ### Example of PlantCV running in Jupyter