Skip to content

Commit

Permalink
Fixup documentation regarding installs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jmchilton committed Aug 27, 2016
1 parent e1f2284 commit ce44e87
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 22 deletions.
2 changes: 0 additions & 2 deletions .travis.yml
Expand Up @@ -9,7 +9,6 @@ env:
- TOX_ENV=py27-quick - TOX_ENV=py27-quick
- TOX_ENV=py27 - TOX_ENV=py27
- TOX_ENV=py34 - TOX_ENV=py34
- TOX_ENV=py27-lint-imports
- TOX_ENV=py27-lint-docstrings - TOX_ENV=py27-lint-docstrings


install: install:
Expand All @@ -21,7 +20,6 @@ install:
matrix: matrix:
allow_failures: allow_failures:
- env: TOX_ENV=py34 - env: TOX_ENV=py34
- env: TOX_ENV=py27-lint-imports
- env: TOX_ENV=py27-lint-docstrings - env: TOX_ENV=py27-lint-docstrings


script: PLANEMO_ENABLE_POSTGRES_TESTS=1 PLANEMO_SKIP_CWLTOOL_TESTS=1 tox -e $TOX_ENV script: PLANEMO_ENABLE_POSTGRES_TESTS=1 PLANEMO_SKIP_CWLTOOL_TESTS=1 tox -e $TOX_ENV
Expand Down
35 changes: 16 additions & 19 deletions README.rst
Expand Up @@ -33,35 +33,32 @@ develop Galaxy tools.
Obtaining Planemo Obtaining Planemo
----------------- -----------------


The recommended approach for installing Planemo is to use Homebrew_ or For a traditional Python installation of Planemo, first set up a virtualenv
linuxbrew_. To install Planemo this way use the ``brew`` command as for ``planemo`` (this example creates a new one in ``.venv``) and then
follows. install with ``pip``. Planemo requires pip 7.0 or newer.


:: ::


$ brew tap galaxyproject/tap $ virtualenv .venv; . .venv/bin/activate
$ brew install planemo $ pip install "pip>=7" # Upgrade pip if needed.
$ pip install planemo



Another approach for installing Planemo is to use Homebrew_ or
Planemo can alternatively be installed via Conda_: linuxbrew_. To install Planemo this way use the ``brew`` command as
follows.


:: ::


$ conda config --add channels r $ brew tap galaxyproject/tap
$ conda config --add channels bioconda $ brew install planemo
$ conda install planemo

For third option and a more traditional Python installation set up a virtualenv
for Planemo (this example creates a new one in ``.venv/``) and then
install it with ``pip``.

::


$ virtualenv .venv; . .venv/bin/activate For information on updating Planemo, installing the latest development release,
$ pip install planemo or installing planemo via bioconda - checkout the `installation
<http://planemo.readthedocs.io/en/latest/installation.html>`__
documentation.


Planemo is also available as a `virtual appliance Planemo is also available as a `virtual appliance
<https://planemo.readthedocs.org/en/latest/appliance.html>`_ bundled <https://planemo.readthedocs.io/en/latest/appliance.html>`_ bundled
with a preconfigured Galaxy server and set up for Galaxy tool development. with a preconfigured Galaxy server and set up for Galaxy tool development.
You can choose from open virtualization format (OVA_, .ova), Docker_, You can choose from open virtualization format (OVA_, .ova), Docker_,
or Vagrant_ appliances. or Vagrant_ appliances.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
Expand Up @@ -5,7 +5,7 @@ Installation
pip_ pip_
============ ============


For a more traditional Python installation of Planemo set up a virtualenv For a traditional Python installation of Planemo, first set up a virtualenv
for ``planemo`` (this example creates a new one in ``.venv``) and then for ``planemo`` (this example creates a new one in ``.venv``) and then
install with ``pip``. Planemo requires pip 7.0 or newer. install with ``pip``. Planemo requires pip 7.0 or newer.


Expand Down

0 comments on commit ce44e87

Please sign in to comment.