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.6.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.6-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: catnip_seq-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 8e059b4c1d3bb92d7bb99405dda8d50beee23554f911c7b68a71dc1131b26540
MD5 343204340822d438bf0d0636e4708443
BLAKE2b-256 07e9b4dd0e3e4491f13b6f01f1fb5380436d9eb1a77979adbfbe663af09f9beb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: catnip_seq-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 28.9 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 54e48c79c7de1dd487786e1a362a4ca8a182a1ff1854539ddba2e44ccd7f0a3e
MD5 94e824e6269d81d3dfe1480f77c4e2b5
BLAKE2b-256 a26128e86290c39f94db37bd5cbc7ada82437b301d09aebfb83c3433e39446e3

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