Skip to content

Commit

Permalink
Merge pull request #299 from danforthcenter/add-pypi-conda-instructions
Browse files Browse the repository at this point in the history
Add pypi and conda install instructions
  • Loading branch information
nfahlgren committed Jan 15, 2019
2 parents a098765 + 97220a3 commit 231e515
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 8 deletions.
8 changes: 4 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ python:
# - python: '3.7'
virtualenv:
system_site_packages: false
before_script:
- export DISPLAY=:0
- sh -e /etc/init.d/xvfb start
- sleep 3
#before_script:
#- export DISPLAY=:0
#- sh -e /etc/init.d/xvfb start
#- sleep 3
install:
- |
if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
[![Documentation Status](http://readthedocs.org/projects/plantcv/badge/?version=latest)](http://plantcv.readthedocs.io/en/latest/?badge=latest)
[![Docker Pulls](https://img.shields.io/docker/pulls/danforthcenter/plantcv.svg)](https://hub.docker.com/r/danforthcenter/plantcv/)
[![GitHub release](https://img.shields.io/github/release/danforthcenter/plantcv.svg)](https://github.com/danforthcenter/plantcv/releases)
[![PyPI version](https://badge.fury.io/py/plantcv.svg)](https://badge.fury.io/py/plantcv)
[![Anaconda-Server Badge](https://anaconda.org/bioconda/plantcv/badges/version.svg)](https://anaconda.org/bioconda/plantcv)
[![license](https://img.shields.io/github/license/danforthcenter/plantcv.svg)](https://github.com/danforthcenter/plantcv/blob/master/LICENSE)

# PlantCV: Plant phenotyping using computer vision
Expand Down
43 changes: 40 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,44 @@ PlantCV has been tested on the following systems:
- Jupyter
- SQLite

### Conda-based installation procedure
### Install via a package manager

Stable releases of PlantCV are available through both the Python Package Index (PyPI) and `conda` through the
[Bioconda channel](https://bioconda.github.io/). We plan on releasing new versions of PlantCV into both platforms on
at least a monthly basis.

#### PyPI

To install from PyPI run the following in any type of virtual environment, as an administrator, or add the `--user`
flag if needed.

```bash
pip install plantcv
```

#### Conda

To install using `conda` first install [Anaconda](https://www.anaconda.com/download/) or
[Miniconda](https://conda.io/miniconda.html) if you have not already. If needed, add the following channels to your
`conda` configuration.

```bash
conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge
```

Then create an environment and install PlantCV.

```bash
conda create -n plantcv plantcv
```

### Manual installs

You can build PlantCV from the source on GitHub if you are a developer or want the absolute latest version possible.

#### Conda-based installation procedure

**Platforms**: Linux, macOS, Windows

Expand Down Expand Up @@ -94,7 +131,7 @@ optional `sqlite3` package.
conda install -c blaze sqlite3
```

### Using PlantCV containers
#### Using PlantCV containers

**Platforms**: Linux, macOS, Windows

Expand Down Expand Up @@ -131,7 +168,7 @@ docker run -v /home/user:/data danforthcenter/plantcv \
python /data/test-script.py -i /data/test-image.png -o /data -r /data/plantcv-results.txt
```

### Script-based installation
#### Script-based installation

**Platforms**: Ubuntu, macOS

Expand Down
2 changes: 1 addition & 1 deletion environments/environment27.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: test-environment
dependencies:
- python=2.7
- matplotlib>=1.5
- numpy>=1.11
- numpy>=1.11,<1.16
- pandas
- python-dateutil
- scipy
Expand Down

0 comments on commit 231e515

Please sign in to comment.