levseq 1.0.0__py3-none-any.whl

levseq-1.0.0.dist-info/METADATA

@@ -0,0 +1,180 @@
+Metadata-Version: 2.1
+Name: levseq
+Version: 1.0.0
+Home-page: https://github.com/fhalab/levseq/
+Author: Yueming Long, Emreay Gursoy, Ariane Mora
+Author-email: ylong@caltech.edu
+License: GPL3
+Project-URL: Bug Tracker, https://github.com/fhalab/levseq/
+Project-URL: Documentation, https://github.com/fhalab/levseq/
+Project-URL: Source Code, https://github.com/fhalab/levseq/
+Keywords: Nanopore,ONT,evSeq
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Bio
+Requires-Dist: biopython
+Requires-Dist: fsspec
+Requires-Dist: h5py
+Requires-Dist: holoviews
+Requires-Dist: jupyterlab
+Requires-Dist: mappy
+Requires-Dist: matplotlib
+Requires-Dist: ninetysix
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pybedtools
+Requires-Dist: pycoQC
+Requires-Dist: pyfaidx
+Requires-Dist: pyparsing
+Requires-Dist: pysam
+Requires-Dist: scipy
+Requires-Dist: sciutil
+Requires-Dist: seaborn
+Requires-Dist: scikit-learn
+Requires-Dist: statsmodels
+Requires-Dist: tqdm
+
+# Variant Sequencing with Nanopore
+
+In directed evolution, sequencing every variant enhances data insight and creates datasets suitable for AI/ML methods. This method is presented as an extension of the original Every Variant Sequencer using Illumina technology. With this approach, sequence variants can be generated within a day at an extremely low cost.
+
+![Figure 1: LevSeq Workflow](manuscript/Figures/LevSeq_Figure-1.png)
+Figure 1: Overview of the LevSeq variant sequencing workflow using Nanopore technology. This diagram illustrates the key steps in the process, from sample preparation to data analysis and visualization.
+
+
+- Data to reproduce the results and to test are available on zenodo [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13694463.svg)](https://doi.org/10.5281/zenodo.13694463)
+
+- A dockerized website and database for labs to locally host and visualize their data: https://github.com/fhalab/LevSeq_VDB/
+
+## Setup
+
+For setting up the experimental side of LevSeq we suggest the following preparations:
+
+- Order forward and reverse primers compatible with the desired plasmid, see methods section of [our paper](http://biorxiv.org/cgi/content/short/2024.09.04.611255v1?rss=1).
+- Successfully install Oxford Nanopore's software (this is only for if you are doing basecalling/minION processing). [Link to installation guide](https://nanoporetech.com/).
+
+## How to Use LevSeq
+
+The wet lab part is detailed in the method section of the paper. 
+
+Once samples are prepared, the multiplexed sample is used for sequencing, and the sequencing data is stored in the `../data` folder as per the typical Nanopore flow (refer to Nanopore documentation for this).
+
+After sequencing, you can identify variants, demultiplex, and combine with your variant function here! For simple applications, we recommend using the notebook `example/Example.ipynb`.
+
+### Steps of LevSeq:
+
+1. **Basecalling**: This step converts Nanopore's FAST5 files to sequences. For basecalling, we use Nanopore's basecaller, Medaka, which can run in parallel with sequencing (recommended) or afterward.
+
+2. **Demultiplexing**: After sequencing, the reads, stored as bulk FASTQ files, are sorted. During demultiplexing, each read is assigned to its correct plate/well combination and stored as a FASTQ file.
+
+3. **Variant Calling**: For each sample, the consensus sequence is compared to the reference sequence. A variant is called if it differs from the reference sequence. The success of variant calling depends on the number of reads sequenced and their quality.
+
+
+### Installation:
+
+We aimed to make LevSeq as simple to use as possible, this means you should be able to run it all using pip. However, if you have issues we recomend using the Docker instance!
+
+We recommend using command line interface(Terminal) and a conda environment for installation:
+```
+git clone https://github.com/fhalab/LevSeq.git
+```
+
+```
+conda create --name levseq python=3.8
+```
+
+```
+conda activate levseq
+```
+
+From the LevSeq folder, install the package using pip:
+
+```
+pip install releases/levseq-0.1.0.tar.gz
+```
+#### Dependencies 
+
+1. Samtools: https://www.htslib.org/download/ 
+```
+conda install -c bioconda -c conda-forge samtools
+```
+or for mac users you can use: `brew install samtools`
+
+2. Minimap2: https://github.com/lh3/minimap2
+```
+conda install -c bioconda -c conda-forge minimap2
+```
+or for mac users you can use: `brew install minimap2`
+Once dependencies are all installed, you can run LevSeq using command line.
+3. GCC
+For Mac M1 users: installation via homebrew
+```
+brew install gcc
+```
+For Linux users: installation via conda 
+```
+conda install conda-forge::gcc
+```
+### Usage
+#### Command Line Interface
+LevSeq can be run using the command line interface. Here's the basic structure of the command:
+
+```
+levseq <name> <location to data folder> <location of reference csv file>
+```
+#### Required Arguments
+1. Name of the experiment, this will be the name of the output folder
+2. Location of basecalled fastq files, this is the direct output from using the MinKnow software for sequencing
+3. Location of reference csv file, this file includes information of barcodes used for each plate and the DNA sequence used for reference for each plate
+
+#### Optional Arguments
+--skip\_demultiplexing If enabled, demultiplexing step will be skipped 
+
+--skip\_variantcalling If enabled, variant valling step will be skipped 
+
+--output Save location for output, if not provided default to where the program is executed
+
+--show\_msa Showing multiple sequence alignment for each well
+
+### Docker Installation (Recommended for full pipeline)  
+For installing the whole pipeline, you'll need to use the docker image. For this, install docker as required for your 
+operating system (https://docs.docker.com/engine/install/).
+
+
+To build the docker image run (within the main folder that contains the `Dockerfile`):
+
+```
+docker build -t levseq .
+```
+
+This gives us the access to the lebSeq command line interface via:
+
+```
+docker run levseq
+```
+Note! The docker image should work with linux, and mac, however, different mac architectures may have issues (owing to the different M1/M3 processers.)
+
+Basically the -v connects a folder on your computer with the output from the minION sequencer with the docker image that will take these results and then perform 
+demultiplexing and variant calling.
+
+```
+ docker run -v /Users/XXXX/Documents/LevSeq/data:/levseq_results/ levseq 20240502 levseq_results/20240502/ levseq_results/20240502-YL-ParLQ-ep2.csv
+```
+
+In this command: `/Users/XXXX/Documents/LevSeq/data` is a folder on your computer, which contains a subfolder `20240502` 
+
+### Issues and Troubleshooting
+
+If you have any issues, please check the LevSeq\_error.log find in the output direectory and report the issue. If the problem persists, please open an issue on the GitHub repository with the error details.
+
+If you solve something code wise, submit a pull request! We would love community input.

levseq-1.0.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+levseq/IO_processor.py,sha256=5wlN2osYDARrlre0V74n142tAfBYEr4z7AFPEklO6yQ,20397
+levseq/__init__.py,sha256=eIsx4_96Omo0TTt6wMRKzr8gnyt_0ECnGsP7RWFYpa0,1775
+levseq/basecaller.py,sha256=OCcBoWAoke4h0ALE-Jl-XKPgWIjilcXVIyP228rFwfQ,3054
+levseq/cmd.py,sha256=MXji4L6w5PchFGRSxz25mc3B767l71d-A3wHBxGASbw,1413
+levseq/globals.py,sha256=2blnORDlq8iFIpWCTlA_0aAaP6eW3NqTHBMlNrrA-tM,3130
+levseq/interface.py,sha256=OT3RxkxfrC1W8--ybrkFcGSaT6aEaU2xJNDAwEKlqqQ,3863
+levseq/parser.py,sha256=BWu_4U4m_s4-_tyRNkPZEbp8wqLIkMZ_XKGx0PxxtLI,3574
+levseq/run_levseq.py,sha256=PWEG615Y2ji1dP403xAYPl8Imb442yjXJa1dh_2L1dE,21031
+levseq/screen.py,sha256=YAG-C6K7CwXaVnvyS4Y8gaPV_DLewRXtTH5SlmrQceQ,1496
+levseq/simulation.py,sha256=Fo3tBgu1_iZJHkaj922aS5SIK5KTi8BYmGh1qnKsbuY,14432
+levseq/user.py,sha256=G9MwG88wHWOysN437JK_hZJFnFD5129rnKbTdu6Qxm8,6748
+levseq/utils.py,sha256=4sQ0nH7AErf_zKkXCQl7eOlJd3RMhVb2S_36wP0vqv0,21406
+levseq/variantcaller.py,sha256=COpxAuMWaltjRmX8uhJ9dJrZm0zVc6OhCcGK4Yezf6s,12235
+levseq/visualization.py,sha256=4OFX2n763HdpjDn4Ra2BYNf9KyfBG4X3QmbBtbfeTdQ,33966
+levseq/barcoding/__init__.py,sha256=eK46E0pOoyct-TVkjeBkeA69ImvY27lX_eWTXof_dNo,35
+levseq/barcoding/demultiplex,sha256=TXqQTJ50mmUVUJw2Zw_lSJXxsIpkGy1e_t1OyNz2km8,434104
+levseq/barcoding/demultiplex-arm64,sha256=wIz0ojOHJlMoLcbhA-McuN4o2swiojP3h5sWxs9pVWI,351096
+levseq/barcoding/demultiplex-x86,sha256=38vk7i-RFBnOSW6HGOCVYI1QcOyjOyVg7ziIObwt3IM,336272
+levseq/barcoding/minion_barcodes.fasta,sha256=a3XV-_WJ0E1--cOWgPFqYoC7FwZ8CIWgzGPrwW2czgs,5954
+levseq-1.0.0.data/data/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+levseq-1.0.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+levseq-1.0.0.dist-info/METADATA,sha256=AGffeZqDavzd4yTTfJIot1ZTtw9vkF2c4O-AXiQFO1Q,7448
+levseq-1.0.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+levseq-1.0.0.dist-info/entry_points.txt,sha256=TrV6VrNW1nWdlKhbtWMh9J_VLPBlYqPIJWNEQSLQGoo,43
+levseq-1.0.0.dist-info/top_level.txt,sha256=8r2n0hF_yJ5VbAyh6EB405w2rjjGLH6CFhfQa7EVTOE,7
+levseq-1.0.0.dist-info/RECORD,,

levseq-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

levseq-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+levseq = levseq.cmd:main

levseq-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+levseq