Skip to main content
Ctrl+K

oscar-colony v0.0.9

  • User guide
  • Developer guide
  • API
  • GitHub
  • User guide
  • Developer guide
  • API
  • GitHub

Section Navigation

  • Installation
  • Typical workflow
  • PyRAT
  • Standard table structure
  • User guide

User guide#

Getting started with using oscar-colony:

  • Installation
    • Using conda
    • Using uv
  • Typical workflow
    • Fetch and standardise data from a colony management system
    • Calculate historical stats
    • Define the required animals
    • Optimise schemes
  • PyRAT
    • Client tokens
    • User tokens
    • Providing tokens to OSCaR
    • Pulling data from the PyRAT API
    • Standardising data from the PyRAT API
  • Standard table structure
    • Mutations
    • Parents
    • Un-genotyped animals

previous

Welcome to OSCaR’s documentation!

next

Installation

Show Source

© Copyright 2026, University College London.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.20.0.