Update README
This commit is contained in:
parent
c9de0c8320
commit
f30fc31c29
|
@ -0,0 +1,41 @@
|
||||||
|
# locimend
|
||||||
|
|
||||||
|
locimend is a tool that corrects DNA sequencing errors using Deep Learning.
|
||||||
|
|
||||||
|
## Technologies
|
||||||
|
|
||||||
|
- Tensorflow
|
||||||
|
- Biopython
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
This project uses [Nix](https://nixos.org/) to ensure reproducible
|
||||||
|
builds.
|
||||||
|
|
||||||
|
1. Install Nix (compatible with MacOS, Linux and
|
||||||
|
[WSL](https://docs.microsoft.com/en-us/windows/wsl/about)):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -L https://nixos.org/nix/install | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Clone the repository:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.coolneng.duckdns.org/coolneng/locimend
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Change the working directory to the project:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd locimend
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Enter the nix-shell:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
nix-shell
|
||||||
|
```
|
||||||
|
|
||||||
|
After running these commands, you will find yourself in a shell that
|
||||||
|
contains all the needed dependencies.
|
|
@ -1,3 +0,0 @@
|
||||||
* locimend
|
|
||||||
|
|
||||||
locimend is a tool that corrects DNA sequencing errors.
|
|
Loading…
Reference in New Issue