# 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](https://github.com/neuroinformatics-unit/OSCaR-web-app) for documentation on deploying and using this option.

::::{grid} 1 2 2 3
:gutter: 3

:::{grid-item-card} {fas}`screwdriver-wrench;sd-text-primary` User guide
:link: user_guide/index
:link-type: doc

Guides on installation and use of oscar-colony.
:::

:::{grid-item-card} {fas}`computer;sd-text-primary` Developer guide
:link: developer_setup
:link-type: doc

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

:::{grid-item-card} {fas}`book;sd-text-primary` API reference
:link: api_index
:link-type: doc

Reference documentation for the package's API.
:::

::::

```{toctree}
:maxdepth: 2
:hidden:

user_guide/index
developer_setup
api_index
```