Metadata-Version: 2.4
Name: bohra
Version: 3.4.0
Summary: A bioinformatics pipeline for analysing short read Illumina data microbiological public health.
Project-URL: Homepage, https://github.com/kristyhoran/bohra
Author-email: Kristy Horan <kristyhoran15@gmail.com>
License-Expression: GPL-3.0-or-later
License-File: LICENSE.txt
Keywords: bioinformatics,microbiology,public health
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.11
Requires-Dist: altair
Requires-Dist: biopython
Requires-Dist: click
Requires-Dist: jinja2
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: psutil
Requires-Dist: pytest
Provides-Extra: tests
Requires-Dist: flake8; extra == 'tests'
Requires-Dist: pandas; extra == 'tests'
Requires-Dist: pytest; extra == 'tests'
Description-Content-Type: text/markdown

[![CI](https://github.com/MDU-PHL/bohra/actions/workflows/CI.yml/badge.svg)](https://github.com/MDU-PHL/bohra/actions/workflows/CI.yml)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/MDU-PHL/bohra)](https://github.com/MDU-PHL/bohra/releases/latest)
[![Conda Downloads](https://img.shields.io/conda/dn/bioconda/bohra)](https://anaconda.org/bioconda/bohra)
![Python](https://img.shields.io/badge/python-3.x-blue.svg)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

# Bohra

<IMG SRC="docs/images/logo.svg" ALIGN="right" WIDTH="64" ALT="Bohra Logo">

Bohra is an extensive pipeline 
for taking genome sequences
(short reads or assemblies) 
and running common bioinformatics assays
across the, including
[genotyping, AMR detection, and phylogenetics](https://github.com/MDU-PHL/bohra#workflow).

Bohra is a modern replacement for the 
[Nullarbor](https://github.com/tseemann/nullarbor)
pipeline. It is written in Python and Nextflow
instead of Perl and Make.

# Installation

1. Install the base packaghe
```
% conda create -n bohra -c bioconda bohra
% borha --version
```
2. Install all the analysis modules.
This can take a long time (10-60 min) but it's worth it!
```
% bohra deps install
```
3. Test everthing worked ok
```
% bohra test --cpus 8 
```

# Documentation

Read the [Bohra website](https://mdu-phl.github.io/bohra/)
to learn how to use all the availaile features.

# Workflow

![Bohra workflow](workflow.png)

# Authors

* [Kristy Horna](https://github.com/kristyhoran)
* [Torsten Seemann](https://tseemann.github.io)
