Skip to content

Commit

Permalink
[MRG] update README to include more install options (#423)
Browse files Browse the repository at this point in the history
* Add conda install instructions
* update README, index to include more install foo
  • Loading branch information
ctb authored and luizirber committed Feb 27, 2018
1 parent 102b9ea commit 98e503b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,12 @@ sourmash is a product of the

## Installation

You can do:
We currently recommend installing the 2.0 pre-release series directly
from GitHub.

pip install sourmash
You can use pip to do that like so:

pip install https://github.com/dib-lab/sourmash/archive/master.zip

sourmash runs under both Python 2.7.x and Python 3.5. The base
requirements are screed and ijson, together with a C++ development
Expand All @@ -47,6 +50,18 @@ The comparison code (`sourmash compare`) uses numpy, and the plotting
code uses matplotlib and scipy, but most of the code is usable without
these.

### Installation with conda

You can also use conda:

```bash
$ conda create -n sourmash_env sourmash python=3.6.4
$ source activate sourmash_env
$ sourmash compute -h
```

which will install the latest alpha release.

## Support

Please ask questions and files issues
Expand All @@ -63,8 +78,9 @@ Development happens on github at

Tests require py.test and can be run with `make test`.

Please see [the developer notes](doc/developer.md) for more information.

----

CTB

6.jun.2016
Feb 2018
8 changes: 8 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ and experiment with it yourself `interactively with a binder
<http://mybinder.org/repo/dib-lab/sourmash>`__ at `mybinder.org
<http://mybinder.org>`__.

Installing sourmash
-------------------

We currently suggest installing the latest pre-release in the sourmash
2.0 series; please see [the README file in
github.com/dib-lab/sourmash](https://github.com/dib-lab/sourmash/blob/master/README.md)
for information. You can use pip or conda equally well.

Memory and speed
----------------

Expand Down

0 comments on commit 98e503b

Please sign in to comment.