Development Guide#

Welcome to the PyCAT-Napari development documentation. This section provides information for developers who want to contribute to PyCAT-Napari, whether through code contributions, bug fixes, documentation improvements, or other enhancements.

Getting Started with Development#

To begin contributing to PyCAT-Napari:

Set up your development environment
Understand our development practices and guidelines
Learn about our support resources
Review our project roadmap

Development Resources#

Setting Up Development Environment#

Quick start for developers:

# Clone the repository
git clone https://github.com/BanerjeeLab-repertoire/pycat-napari.git
cd pycat-napari

# Create development environment
conda env create -f pycat-devbio-napari-env-x86-windows.yml  # For Windows
# OR
conda env create -f pycat-devbio-napari-env-arm-mac.yml      # For Mac M1/ARM

# Install development dependencies
pip install -e ".[dev]"

Key Development Tools#

PyCAT-Napari uses several key tools for development:

pytest: For testing
black: Code formatting
ruff: Code linting
sphinx: Documentation generation
pre-commit: Git hooks for code quality

Development Guidelines Overview#

We maintain high standards for code quality and documentation. Key principles include:

Following PEP 8 style guidelines
Writing comprehensive tests
Maintaining thorough documentation
Using type hints where appropriate
Following our git workflow

Next Steps#

Review our Contributing to PyCAT-Napari guide for detailed contribution guidelines
Check our Getting Support page for help resources
See our PyCAT-Napari Roadmap for planned features and improvements

Need help getting started? Check our Getting Support page or reach out to the development team.