Skip to content

Commit

Permalink
Updates to help for upload to pypi. Can now be installed via pip
Browse files Browse the repository at this point in the history
  • Loading branch information
marcus1487 committed Oct 11, 2016
1 parent b11a8a8 commit 24c278c
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,25 @@ This package provides tools for the analysis of raw nanopore sequencing data, in
- changepoint (for using R's changepoint package for re-segmentation)
- Biopython (for robust FASTA parsing, but a simple parser is provided)

## Installation
Install nanoraw via pip
```
pip install nanoraw
```

Install bleeding edge via github
```
pip install git+https://github.com/marcus1487/nanoraw.git
```

## Usage
Currently, not loaded into pip (to be done soon). To use nanoraw install locally and run with:

```
git clone https://github.com/marcus1487/nanoraw.git
cd nanoraw
pip install .
nanoraw -h
nanoraw [command] [options]
```

## Currently supported commands
### Commands:
#### Main comands:
- correct: Correct annotation of raw signal with genomic aignement of existing basecalls
- write_wiggle: Write wiggle file of genome coverage.
Expand All @@ -42,7 +50,7 @@ nanoraw [command] [options]

> Get additional help for subcommands with `nanoraw [command] -h`
#### Legal
## Legal
nanoraw v.1 Copyright (c) 2016, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.

If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Innovation and Partnerships department at [email protected] referring to " nanoraw v.1 (2016-199)."
Expand Down

0 comments on commit 24c278c

Please sign in to comment.