Skip to main content

Explore nucleotide divergence and sequence resolution across user-defined categories.

Project description

CATnip Workflow

Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge

CATnip a tool to assess nucleotide divergence and sequence resolution between user-defined categories.

Prerequisites

  • Conda or Mamba
  • Git

Installation (Recommended)

Install CATnip directly from Bioconda:

conda create -n catnip -c conda-forge -c bioconda catnip-seq
conda activate catnip

Or faster with mamba:

mamba create -n catnip -c conda-forge -c bioconda catnip-seq

Development Installation

  1. Clone the repository:

    git clone https://github.com/CIBIO-BU/catnip
    cd catnip
    
  2. Create the conda environment:

    conda env create -f catnip-env.yml
    
  3. Activate the environment:

    conda activate catnip
    
  4. Install catnip command:

    pip install -e .
    
  5. Check help message:

    catnip -h
    
  6. Run the test workflow:

    cd test-workflow
    catnip -i coi_micointf_mil.fasta -f coi_micointf_mil_mapping.tsv -c 0,1,2,3 -p 10
    

Environment Details

The conda environment includes:

  • Python 3.11
  • CD-HIT 4.8.1 (sequence clustering)
  • Bowtie2 2.5.4 (sequence alignment)
  • SAMtools (BAM/SAM file processing)
  • pysam (Python interface for SAM/BAM files)
  • pandas & numpy (data analysis)

Documentation

Divergence values are rounded to the NEAREST WHOLE VALUE. However, output is presented with one decimal case.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

catnip_seq-0.1.7.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

catnip_seq-0.1.7-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

Details for the file catnip_seq-0.1.7.tar.gz.

File metadata

  • Download URL: catnip_seq-0.1.7.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for catnip_seq-0.1.7.tar.gz
Algorithm Hash digest
SHA256 f14ea79a01810164bdeb215698f874b140536111d2efdc620af77cd8b2e13a27
MD5 317a01a2450d3af32b6ed73b2fda59e8
BLAKE2b-256 d4d3b9101d1885e60f0f2a74536575c6647f469eefcd68c50a39f15bf6753f8f

See more details on using hashes here.

File details

Details for the file catnip_seq-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: catnip_seq-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 29.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for catnip_seq-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e9f297151ca41b8c869e1b00cdc05ead0eab0892f014e619b383fdd6bdedbc06
MD5 86be45d33cfe659c0ac0dad826b6d594
BLAKE2b-256 a6ee87658688037c6c1150d8b60a29d0414d1a50fcc039b5dde65d721657ce2f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page