diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0bce26f3a..b7f575a0d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,5 +1,6 @@ # Table of Contents for Contibution 1. [Overview of Contribution](#overview) +2. [Installing PlantCV for Contributors](#installing) 2. [Creating Issues](#creatingissues) 3. [Contributing Text or Code](#textcode) * [Set-Up Development Environment](#devenvironmment) @@ -35,6 +36,32 @@ There are many ways to contribute: If you need any help, please contact us. +## Installing PlantCV for contributors +Before getting started, please read our [contributor guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md). + +You can build PlantCV from the source code if you are a developer or want the absolute latest version available. +As noted in the [installation documentation](installation.md), we recommend installing PlantCV in a virtual environment. We will outline how to do this using `conda`. +You will also need a [GitHub](https://github.com) account. You will need to +[clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the PlantCV +repository from GitHub before getting started. + +To set up your environment, follow these steps in your command-line terminal: + +```bash +# Enter the PlantCV directory +cd plantcv + +# Create a conda environment named "plantcv" (or whatever you like) and automatically install the developer dependencies +conda env create -n plantcv -f environment.yml + +# Activate the plantcv environment (you will have to do this each time you start a new session) +conda activate plantcv + +# Install PlantCV in editable mode so that it updates as you work on new features/updates +pip install -e . + +``` + ## Creating Issues - Make sure you have a GitHub account. diff --git a/docs/installation.md b/docs/installation.md index 975823fcc..074c6e3d6 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,22 +1,36 @@ -## Installation +## Installing PlantCV + +!!!note + This guide describes typical installations of PlantCV. + PlantCV can be installed from source for developers or users who want to test the latest features. + Please see our [Contributing Guide](#CONTRIBUTING.md) for more information. ### Table of contents 1. [Supported platforms and dependencies](#dependencies) -2. [Install via a package manager](#install) +2. [Desktop installation step-by-step guide](#desktop) +3. [Server/command-line step-by-step guide](#cli) +4. [Detailed installation instructions](#detailed) 1. [Conda](#conda) 2. [PyPI](#pypi) -3. [Installing PlantCV for contributors](#contributors) ### Supported platforms and dependencies - Linux 64-bit, x86 processors - macOS x86 (Intel) and M (ARM) processors - Windows 64-bit, x86 processors +### Desktop installation step-by-step guide + + + +### Server/command-line step-by-step guide + + + +### Detailed installation instructions + PlantCV requires Python (tested with versions 3.9, 3.10, and 3.11) and these [Python packages](https://github.com/danforthcenter/plantcv/blob/main/pyproject.toml). Additionally, we recommend installing [JupyterLab](https://jupyter.org/). -### Install via a package manager - !!!note We recommend installing PlantCV in a virtual environment, which is a self-contained Python environment that includes PlantCV and its dependencies. Virtual environments are used to avoid conflicts between packages and can increase the @@ -25,10 +39,23 @@ Additionally, we recommend installing [JupyterLab](https://jupyter.org/). Stable releases of PlantCV are available through both the [Python Package Index (PyPI)](https://pypi.org/) and `conda` through the [conda-forge channel](https://conda-forge.org/). -#### Conda +#### Installing Conda First install `conda` if you do not already have it. We recommend using the [Miniconda](https://conda.io/miniconda.html), but the full [Anaconda](https://www.anaconda.com/download/) distribution will also work. +If you are new to conda environments, check out this [Getting Started with Conda Guide](https://conda.io/projects/conda/en/latest/user-guide/getting-started.html). + +!!! note + Additional instructions for Windows users: + + Windows users will need to install a Linux terminal to install and use PlantCV. We recommend using Anaconda Prompt which comes with Anaconda and Miniconda. + + Alternatively, Windows users can download [Git for Windows](https://gitforwindows.org/). This option requires users to add conda to their `.bashrc` file. See this helpful [guide](https://discuss.codecademy.com/t/setting-up-conda-in-git-bash/534473) for setting up conda in Git Bash. + +#### Installing PlantCV with conda + +Open Terminal (Mac) or Anaconda Prompt (Windows) and run the following: + ```bash conda create -n plantcv -c conda-forge plantcv @@ -42,6 +69,7 @@ conda create -n plantcv -c conda-forge plantcv jupyterlab ipympl nodejs ``` #### PyPI +Optionally, PlantCV can be installed from PyPi. ```bash pip install plantcv @@ -54,29 +82,3 @@ Or with optional (but recommended) dependencies: pip install plantcv jupyterlab ipympl ``` - -### Installing PlantCV for contributors -Before getting started, please read our [contributor guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md). - -You can build PlantCV from the source code if you are a developer or want the absolute latest version available. -As noted above, we recommend installing PlantCV in a virtual environment. We will outline how to do this using `conda`. -You will also need a [GitHub](https://github.com) account. You will need to -[clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the PlantCV -repository from GitHub before getting started. - -To set up your environment, follow these steps in your command-line terminal: - -```bash -# Enter the PlantCV directory -cd plantcv - -# Create a conda environment named "plantcv" (or whatever you like) and automatically install the developer dependencies -conda env create -n plantcv -f environment.yml - -# Activate the plantcv environment (you will have to do this each time you start a new session) -conda activate plantcv - -# Install PlantCV in editable mode so that it updates as you work on new features/updates -pip install -e . - -```