Welcome to OSCaR’s documentation!#

OSCaR (Open Source Colony-assessment Resource) is a python package for data-driven optimisation of breeding strategies.

These docs cover using OSCaR directly from python e.g. via a python script or jupyter notebook. A web application is also provided, if you’d prefer to use OSCaR via a graphical user interface - see the OSCaR web app repository for documentation on deploying and using this option.

User guide

Guides on installation and use of oscar-colony.

User guide
Developer guide

Setup guide for developers who want to contribute to oscar-colony.

Developer guide
API reference

Reference documentation for the package’s API.

API