Skip to main content

CATnip Workflow

install with bioconda 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

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)

Implementation Details

  • Divergence values are rounded to the NEAREST WHOLE VALUE. However, output is presented with one decimal case.
  • Taxa absent from the output file were excluded from the alignment step, as they can be reliably distinguished from all other taxa in the dataset based on the input divergence thresholds.

Metadata

Release files for catnip-seq 0.1.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for catnip-seq 0.1.11
File Size Uploaded
catnip_seq-0.1.11.tar.gz 27.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for catnip-seq 0.1.11
File Interpreter ABI Platform
catnip_seq-0.1.11-py3-none-any.whl Python 3 none any Details

Total release size: 56.2 kB

Release files / catnip_seq-0.1.11.tar.gz

Download URL catnip_seq-0.1.11.tar.gz
Size 27.0 kB
Tags Source
SHA-256 checksum
How to use checksums
1721b9f5ed7a077a07fed69ade99af65586d79182766d15d22395c55db89a678
BLAKE2b-256 checksum
How to use checksums
9776fd641a68f44027af8eadb2a67f6866a2bf5a81ad565551c00e644ad29943
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / catnip_seq-0.1.11-py3-none-any.whl

Download URL catnip_seq-0.1.11-py3-none-any.whl
Size 29.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a850205b74c887991b9ab5f47700f8ff9b6d5efefeac95d19c22b4de952f657f
BLAKE2b-256 checksum
How to use checksums
1ea055aa09ecec81f178dcdcc1f76609898aeff309ffcc2d3c632db9651d935a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release history Release notifications | RSS feed

This release

0.1.11 This release

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page