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

Uploaded Python 3

File details

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

File metadata

  • Download URL: catnip_seq-0.1.8.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.8.tar.gz
Algorithm Hash digest
SHA256 f07dd9d5726c65ae73922e9a6e30e4f600b3324fe23b7c47ee6fbbffe7521109
MD5 d0f3e98715affec9b3229ec63a8b269d
BLAKE2b-256 92c62f37cbf409f5710b12cf0629540167935f56f47075b48bf8a722e310f8ea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: catnip_seq-0.1.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 62885383c1b9b5e54679e14d6df7e46f2cb1a22a1458758bba567a3008781317
MD5 1f72464e2d1fd3729048f3534daac7f4
BLAKE2b-256 97a661e2a58922b6ca8309a0d875b8e2d9a7f7e3f79a3fbbfadaa5a7902f1210

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