Skip to content

Commit

Permalink
[MRG] update documentation & add notebooks to docs (#631)
Browse files Browse the repository at this point in the history
This reorganizes the documentation and adds Jupyter notebooks + binder links. 

* remove out of date notebooks

* remove outdated scripts

* configure nbsphinx and add a test notebook

* add nbsphinx to reqs

* add 2019-upr-kmers notebooks and example files

* add/update notebooks

* add binder configuration

* remove dockerfile

* update notebooks, link into documentation

* fix formatting issue that looks like a typo

* update basic sourmash tutorial commands to work, mostly

* fix sourmash_databases link

* updated tutorials

* fix spacing

* significant documentation reorganization and (hopefully) simplification

* add tutorial master index back in

* add dashing and hulk refs

* add bigsi

* fix branch reference for notebook so that it works

* update notebook with signature recalculation

* fix order of bioconda channels

* fix URLs
  • Loading branch information
ctb authored Mar 7, 2019
1 parent c30b915 commit 8797eb6
Show file tree
Hide file tree
Showing 245 changed files with 3,843 additions and 25,981 deletions.
22 changes: 0 additions & 22 deletions Dockerfile

This file was deleted.

4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ Usage:
sourmash compare *.sig -o distances
sourmash plot distances

We have demo notebooks on binder that you can interact with:

[![Binder](http://mybinder.org/badge.svg)](http://mybinder.org/repo/dib-lab/sourmash)

Sourmash 1.0 is [published on JOSS](https://doi.org/10.21105/joss.00027); please cite that paper if you use sourmash (`doi: 10.21105/joss.00027`):.

----
Expand Down
3 changes: 3 additions & 0 deletions binder/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# binder directory

Configuration files for [mybinder](https://mybinder.org).
12 changes: 12 additions & 0 deletions binder/environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
channels:
- conda-forge
- bioconda
- defaults
dependencies:
- sourmash
- screed
- matplotlib
- pandas
- pip:
- matplotlib_venn
- mmh3
555 changes: 0 additions & 555 deletions demo/00-demo.ipynb

This file was deleted.

13 changes: 0 additions & 13 deletions demo/README.md

This file was deleted.

111 changes: 0 additions & 111 deletions demo/SRR2060939_1.fastq.gz.sig

This file was deleted.

111 changes: 0 additions & 111 deletions demo/SRR2060939_1.fastq.gz.trimnoV.fq.gz.sig

This file was deleted.

Loading

0 comments on commit 8797eb6

Please sign in to comment.