Metadata-Version: 2.1
Name: dnastorage
Version: 0.9.4
Summary: dnastorage provides basic support for encoding and decoding files into and out of DNA with several convenient interfaces.
Home-page: https://github.com/dna-storage/dnastorage
Author: James M. Tuck
Author-email: james.m.tuck@gmail.com
License: UNKNOWN
Description: # dnastorage
        [![License: LGPL v3](https://img.shields.io/badge/License-LGPLv3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
        [![Build Status](https://travis-ci.com/dna-storage/dnastorage.svg?token=rCvdBqMzwWyNvxxUUbSh&branch=master)](https://travis-ci.com/dna-storage/dnastorage)
        
        - [Overview](#overview)
        - [Documentation](#documentation)
        - [System Requirements](#system-requirements)
        - [Installation Guide](#installation-guide)
        - [License](#license)
        - [Issues](https://github.com/dna-storage/dnastorage/issues)
        
        # Overview
        
        Core encoding, decoding, and file manipulation support for modeling DNA-based information storage systems.
        
        # Documentation
        
        As documentation for the software becomes available, it will be placed under the docs folder.
        
        # System Requirements
        
        ## Hardware Requirements
        The dnastorage module requires only a standard computer with enough RAM and compute power to support the needed operations. However, encoding or decoding large files may perform poorly, necessitating a more capable system.
        
        ## Software Requirements
        ### OS Requirements
        This package is supported for macOS and Linux. The package has been tested on the following systems:
        
        + macOS: Catalina 10.15.3
        + Linux: Ubuntu 18.04.3
        
        Note that most OSes will support our software by using Docker.
        
        ### Python Dependences
        
        Our code has been tested on python versions 3.6 to 3.8. It has the following dependences:
        
        ```
        nose
        sphinx
        editdistance
        statistics
        biopython
        matplotlib
        numpy
        ```
        
        # Installation Guide
        
        If you already have python 3 installed on your system, the simplest thing to do is download or checkout the code from GitHub.  Then, run the following commands:
        
            git clone https://github.com/dna-storage/dnastorage
            cd dnastorage
            
        I recommend making a virtual environment first, but this is optional:
        
            python -m venv venv
            source venv/bin/activate
            
        Then, use pip to install the requirements and packages:
        
            pip install -r requirements.txt
            pip install .
        
           
        # License
        
        This software is released under the LGPLv3 license.
        
        # Acknowledgment
        
        This work was supported in part by the National Science Foundation (Award CNS-1650148).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.6
Description-Content-Type: text/markdown
