Metadata-Version: 2.1
Name: fillet
Version: 0.0.2
Summary: Assistance scripts for ONT MinKNOW
Home-page: https://github.com/alexomics/fillet
Author: Alexander Payne
Author-email: alexander.payne@nottingham.ac.uk
License: UNKNOWN
Description: # fillet
        ---
        ## Table of Contents
        
        <details>
        <summary>Click to expand</summary>
        <p>
        
        - [Introduction](#introduction)
        - [Installation](#installation)
          - [PyPI](#installing-fillet-with-pypi)
          - [GitHub](#installing-fillet-from-github)
        - [Usage](#usage)
        </p>
        </details>
        
        ## Introduction
        
        fillet is a simulation manager for Oxford Nanopore Technologies MinKNOW software, making adding simulation devices and
        playback runs easier
        
        ## Installation
        
        ### Installing fillet with PyPI
        
        ```bash
        pip install fillet
        ```
        
        ### Install fillet from GitHub
        
        ```bash
        git clone https://github.com/alexomics/fillet
        cd fillet
        python setup.py install
        ```
        
        ## Usage
        
        fillet installs with a terminal entry point as `fillet`
        
        Add a bulk FAST5 file for simulation:
        ```bash
        fillet sim -t <MinKNOW_config_filename> -b <bulk_file_to simulate>
        ```
        Remove a bulk FAST5 file for simulation:
        ```bash
        fillet sim -t <MinKNOW_config_filename>
        ```
        
        Add a simulation device:
        ```bash
        fillet add
        ```
        Remove a simulation device:
        ```bash
        fillet add -r
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
