Shades

Installation

Basic Installation

pip install -e .

Development Installation

Install with all development dependencies:

pip install -e ".[dev]"

Optional Dependencies

Install with machine learning tools:

pip install -e ".[ml]"

Install with advanced visualization tools:

pip install -e ".[viz]"

Install everything:

pip install -e ".[all]"

Development

Running Tests

pytest

Code Formatting

Format code with black:

black src/ tests/

Lint code with ruff:

ruff check src/ tests/

Type Checking

mypy src/

Project Structure

shades/
├── src/
│   └── shades/          # Main package code
│       └── __init__.py
├── tests/                   # Test files
│   └── __init__.py
├── pyproject.toml          # Project configuration and dependencies
├── README.md               # This file
└── .gitignore             # Git ignore patterns

Usage

import shades

# Your scientific code here

Contributing

1. Install development dependencies: pip install -e ".[dev]"
2. Create a new branch for your feature
3. Make your changes
4. Run tests: pytest
5. Format code: black src/ tests/
6. Check linting: ruff check src/ tests/
7. Submit a pull request

License

MIT License