Contributing

Contributions are welcome! Please read these guidelines before opening a pull request.

Getting started

Fork the repository on GitHub.
Create a feature branch:
```
git checkout -b feature/my-new-feature
```
Make your changes, add tests, and ensure the test suite passes:
```
pytest tests/
```
Open a pull request against the main branch.

Code style

Follow PEP 8.
Write docstrings in NumPy or Google style so that Sphinx autodoc can render them correctly.
Keep functions small and focused.

Reporting issues

Use the GitHub issue tracker at github.com/eshasadia/CORE/issues. Please include:

A minimal reproducible example.
Your Python and OS versions.
The full traceback if applicable.

Citation

If you use CORE in your research please cite:

@misc{nasir2025corecelllevelcoarsetofine,
      title={CORE - A Cell-Level Coarse-to-Fine Image Registration Engine
             for Multi-stain Image Alignment},
      author={Esha Sadia Nasir and Behnaz Elhaminia and Mark Eastwood and
              Catherine King and Owen Cain and Lorraine Harper and
              Paul Moss and Dimitrios Chanouzas and David Snead and
              Nasir Rajpoot and Adam Shephard and Shan E Ahmed Raza},
      year={2025},
      eprint={2511.03826},
      archivePrefix={arXiv},
      primaryClass={q-bio.QM},
      url={https://arxiv.org/abs/2511.03826},
}

License

CORE is released under the MIT License. See LICENSE for the full terms.