Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jrobinso committed Apr 9, 2019
1 parent 1c01c88 commit b7fce82
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@

# igv Jupyter Extension

[![Binder](https://beta.mybinder.org/badge.svg)](https://mybinder.org/v2/gh/igvteam/igv-jupyter/master?filepath=examples/BamFiles.ipynb)
=======


IGV is an extension for [Jupyter Notebook](http://jupyter.org/) which
wraps [igv.js](https://github.com/igvteam/igv.js). With this
Expand Down Expand Up @@ -29,7 +32,7 @@ jupyter nbextension enable --py igv
# If using a virtual environment or conda (don't forget to activate
jupyter serverextension enable --py igv --sys-prefix
jupyter nbextension install --py igv --sys-prefix
jupyter nbextension enable --py igv --sys-prefixe
jupyter nbextension enable --py igv --sys-prefix

```

Expand Down Expand Up @@ -207,3 +210,12 @@ jupyter nbextension install --py igv
jupyter nbextension enable --py igv

```

Creating a conda environment
```bash
conda create -n test python=3.7.1
conda activate test
conda install pip
conda install jupyter

```
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import setuptools

with open("README.md", "r") as fh:
long_description = fh.read()
prefix = '# NOTE - THIS PACKAGE IS DEPRECATED AND WILL NOT BE UPDATED. The package is now distributed as igv-jupyter.'
long_description = prefix + fh.read()

setuptools.setup(name='igv',
packages=['igv'],
version='0.9.5',
version='0.9.6',
description='Jupyter extension for embedding the genome visualation igv.js in a notebook',
long_description=long_description,
long_description_content_type="text/markdown",
Expand Down

0 comments on commit b7fce82

Please sign in to comment.