Skip to content

Commit

Permalink
requested updates
Browse files Browse the repository at this point in the history
remove repetitive chunks and reference installation docs from main package
  • Loading branch information
HaleySchuhl committed Mar 7, 2024
1 parent 91293e6 commit bc31a5a
Showing 1 changed file with 3 additions and 31 deletions.
34 changes: 3 additions & 31 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,44 +14,16 @@
PlantCV requires Python and these [Python packages](https://github.com/danforthcenter/plantcv/blob/main/requirements.txt).
Additionally, we recommend installing [JupyterLab](https://jupyter.org/).

#### PyPI <a name="pypi"></a>

```bash
pip install plantcv

```

Or with optional (but recommended) dependencies:

```bash
pip install plantcv jupyterlab ipympl

```

### Installing PlantCV for contributors <a name="contributors"></a>
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:
You can follow the [PlantCV Installation for Contributor Guide](https://plantcv.readthedocs.io/en/latest/installation/#contributors) and then continue with the instructions below to add PlantCV-Annotate to
your development environment.

```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 .

# Install plantcv-annotate in editable mode so that it updates as you work on new features/updates
pip install plantcv-annotate
pip install -e .
```

0 comments on commit bc31a5a

Please sign in to comment.