Metadata-Version: 2.4
Name: k9_analysis
Version: 0.6.2
Summary: A module to do analyses of k9 data
Home-page: https://github.com/IslasGECI/k9_analysis
Author: Ciencia de Datos • GECI
Author-email: ciencia.datos@islas.org.mx
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: typer[all]

<a href="https://www.islas.org.mx/"><img src="https://www.islas.org.mx/img/logo.svg" align="right" width="256" /></a>
# K9 analysis

[![codecov](https://codecov.io/gh/IslasGECI/k9_analysis/graph/badge.svg?token=RY807ST1T1)](https://codecov.io/gh/IslasGECI/k9_analysis)
![example branch parameter](https://github.com/IslasGECI/k9_analysis/actions/workflows/actions.yml/badge.svg)
![licencia](https://img.shields.io/github/license/IslasGECI/k9_analysis)
![languages](https://img.shields.io/github/languages/top/IslasGECI/k9_analysis)
![commits](https://img.shields.io/github/commit-activity/y/IslasGECI/k9_analysis)
![PyPI - Version](https://img.shields.io/pypi/v/k9_analysis)

## Overview

A Python package for analyzing K9 detection dog data in conservation projects, specifically designed for monitoring and protecting endangered species through canine-assisted surveys. This tool supports ecological modeling and decision-making by processing detection data from trained conservation dogs.

## Features

- **Nest Detection Analysis**: Count and summarize burrow/nest detections by K9 units across different time periods
- **Effort and Distance Tracking**: Analyze survey effort metrics including time and distance covered by detection teams
- **Data Filtering**: Filter detection records by date ranges, K9 unit names, and detection types
- **Summary Reports**: Generate CSV and JSON reports for conservation monitoring
- **CLI Interface**: Command-line tools for automated data processing workflows

## Applications

This package is used for conservation efforts on Guadalupe Island and similar ecological projects where trained detection dogs help locate and monitor species nests, providing reliable data for conservation decision-making and population studies.

## Installation

```bash
pip install k9_analysis
```


