Skip to content

Ruminant Farm Simulation (RuFaS) documentation

⌘ K

Ruminant Farm Simulation (RuFaS) documentation

Documentation:

RuFaS

Getting Started:

Welcome to RuFaS

Infrastructure for Simulation:

Task Manager
Input Manager
RuFaS Command Line Arguments
Output Manager
- Output Manager
- Chunkification
Data Origins
Report Generator
Graph Generator
End to End Testing

Github Actions
Using Mypy
Using Python’s Black Formatter
Using Sphinx
Using Flake8

RuFaS Versioning Policy
RuFaS Team SCRUM Process

Contributing to RuFaS:

Creating a GitHub Issue
How To Write a Design Doc
Branching Strategy in RuFaS
Code Review
Best Practices

Data Collection App

Ruminant Farm Simulation (RuFaS) documentation

/

Best Practices

Best Practices#

What - Why- How framework
Unit testing
Sphinx Documentation (docstrings)
Test-Driven Development (TDD)
Code Coverage
Type checking

© 2025, RuFaS team Built with Sphinx 8.2.3