From 598fb4b7048fff339f1092434032e5b4fed9ece7 Mon Sep 17 00:00:00 2001 From: Paul Waddell Date: Fri, 21 Aug 2026 12:01:17 +0200 Subject: [PATCH] Document project scope and status --- README.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.rst b/README.rst index 6790cf1..e7b0ada 100644 --- a/README.rst +++ b/README.rst @@ -10,6 +10,35 @@ The building blocks of a workflow are "steps", Python functions that can be asse Orca is used in `UrbanSim `__ and other projects. +Project scope +------------- + +**Status:** Active + +**Mission:** Orca provides lightweight Python orchestration for data-intensive +analytical and simulation workflows. + +**Architecture:** Orca's reference architecture targets dependency-managed +analytical computation within a Python process. + +The project maintains and develops: + +* registration and execution of workflow steps; +* managed tables, columns, and other injectable resources; +* dependency tracking and lazy evaluation; +* iterative and cyclical simulation pipelines; +* caching and lifecycle management within a Python process; and +* reusable APIs for composing model workflows. + +Development that improves reliability, composability, performance, and +developer usability is welcome within this mission and architecture. Material +changes to the project's mission or execution architecture are considered +through UDST's organization-level governance process. + +See the `UDST Project Directory +`__ for +organization-wide project status and policy. + Documentation -------------