This repository contains style and community guidelines for Starsim projects. The style guide is divided into the following sections:
- 1_philosophy.md — Design philosophy: common tasks should be simple, audience is scientists, and workload/readability matter.
- 2_python.md — Python style: Google style plus house rules, including no type annotations, longer lines, etc.
- 3_tests.md — Testing: focus on scientific correctness, and support triple execution (standalone scripts + pytest + GitHub Actions).
- 4_documentation.md — Documentation: readmes, auto-generated API reference, and tutorials.
- 5_other.md — Other principles: for example, be very careful not include sensitive data in repos.
- 6_zen.md — Zen of Starsim: short principles and credos for research and software (simplicity, docs, tests, change).
Version: 2.0 | Last updated: 2026-02-20