Skip to content

Commit cdfa423

Browse files
authored
Merge pull request #1659 from danforthcenter/updates-to-getting-started-page
updating the getting started page
2 parents c71c8d5 + 86aa946 commit cdfa423

2 files changed

Lines changed: 16 additions & 15 deletions

File tree

docs/index.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Overview
44

55
[PlantCV](http://plantcv.danforthcenter.org) is composed of modular functions in order to be applicable to a
6-
variety of plant types and imaging systems. In the following documentation we will describe use of each function and
6+
variety of plant types and imaging systems. In the following documentation we describe use of each function and
77
provide tutorials on how each function is used in the context of an overall image-processing workflow. PlantCV
88
currently supports the analysis of standard RGB color images (aka "VIS"), standard grayscale images (e.g.
99
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).
1313

1414
## Getting started
1515

16-
The documentation can be navigated using the sidebar table of contents. Documentation for individual PlantCV functions
17-
are listed under the headings "PlantCV Namespace". For general information on installation,
18-
updating, and other questions, see:
16+
If this is your first time using PlantCV, we recommend following this list of documentation pages to get started:
17+
18+
* [Install PlantCV](installation.md)
19+
* [Use PlantCV with Jupyter Notebooks](jupyter.md)
20+
* [Get started buildling an image analysis workflow](analysis_approach.md)
21+
* [Run your workflow in parallel](pipeline_parallel.md)
22+
* [Use the json2csv tool to convert results files to csv](tools.md)
23+
* [Summary of output measurements generated by PlantCV](output_measurements.md)
24+
25+
!!! tip
26+
Documentation for individual PlantCV functions are listed under the headings "PlantCV Namespace" in the sidebar.
27+
28+
Other useful reference pages:
1929

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

2733
## Tutorials
2834

29-
We have added interactive documentation (the link takes up to a few minutes to load so be patient please),
30-
so you can test out workflows and even upload your own images to test on.
31-
32-
* [![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!
33-
34-
Also see our tutorials documentation pages for more detailed overviews of using PlantCV for specific tasks:
35+
Check out our tutorials below or in our [Tutorial Gallery](tutorials.md) to learn how to analyze different types of images:
3536

3637
* [VIS/RGB Image Processing](tutorials/vis_tutorial.md)
3738
* [Grayscale Image Processing](tutorials/grayscale_tutorial.md)

docs/jupyter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ over many images.
1919

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

22-
22+
---
2323

2424
### Example of PlantCV running in Jupyter
2525

0 commit comments

Comments
 (0)