Metadata-Version: 2.4
Name: allegro-bio
Version: 1.0.0
Summary: ALLEGRO: CRISPR guide design tool with ILP/CP-SAT core
Author-email: Amirsadra Mohseni <amohs002@ucr.edu>
License: MIT License
        
        Copyright (c) 2024 Amir Mohseni
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pyyaml
Requires-Dist: setproctitle
Requires-Dist: scipy
Requires-Dist: biopython
Dynamic: license-file
Dynamic: requires-python

<img width="150" alt="ALLEGRO Logo" src="https://github.com/AmirUCR/allegro/assets/46543443/d173addd-24ef-4532-a8b8-a902e9a8ec36">

# Introduction
ALLEGRO is a synthetic biology tool leveraging linear programming to design the smallest possible gRNA library to fulfill user-specified constraints.

- Design a Cas gRNA library for thousands of species simultaneously
- Flexible library design using an ensemble of options such as tracks, multiplicity, pre- and post-clustering, guide cutting efficacy prediction, and more
- Extremely fast and computationally efficient
- Written in Python, Cython, and C++

**Overview of the ALLEGRO workflow.** **Step (1)** Given the gene sequence or the genome of hundreds to thousands of input species, ALLEGRO extracts Cas target sequences. **Step (2)** ALLEGRO formulates and solves an (integer) linear program including millions of variables. **Step (3)** The optimal solution of the linear program determines the guide library with minimal size that covers all targets.

# Documentation
You may find the documentation for ALLEGRO at its [GitHub Wiki](https://github.com/ucrbioinfo/allegro/wiki).

# Support
If you run into any issues or have suggestions for ALLEGRO, please report them on our GitHub Issues tracker. It's the fastest way to get support and helps us improve ALLEGRO for everyone.

# About
ALLEGRO has been developed and is maintained by <ins>Amir</ins>sadra Mohseni, and Stefano Lonardi at the University of California, Riverside.
