Getting Started¶
This section introduces the structure of Sabu and explains where to begin.
Sabu is organized around independent services and shared libraries. The services provide user-facing functionality, while the shared libraries provide reusable internal functionality.
Who this documentation is for¶
This documentation is intended for:
- users who want to run Sabu services,
- developers who want to inspect or extend the framework,
- researchers who want to reproduce examples using public datasets and outputs,
- contributors who want to understand the service structure before developing new components.
Repository layout¶
Sabu currently uses two main repositories.
| Repository | Role |
|---|---|
sabu |
Main source-code repository |
sabu-test-data-and-examples |
Companion repository for examples, datasets, results, and benchmarks |
The sabu repository is the central project. It contains the framework implementation, services, shared libraries, API-related resources, and deployment files.
The sabu-test-data-and-examples repository is used to keep example data and reproducibility materials separate from the main framework implementation.
Main installation paths¶
Depending on the use case, Sabu components can be used in different ways.
| Method | Use case |
|---|---|
| Clone the repository | Inspect or develop the framework locally |
| Install from PyPI | Use published Python packages |
| Run with Docker | Execute a service in an isolated runtime environment |
| Use companion examples | Test service behavior with prepared datasets and commands |
The most complete starting point is jug_lca_buildings.
Recommended first path¶
For a first test, use the jug_lca_buildings service with the companion examples repository.
The recommended learning order is:
- Understand the Sabu repository structure.
- Review the
jug_lca_buildingsservice. - Run a small example through direct Python execution.
- Run the service through its API.
- Run the service with Docker.
- Review generated outputs and artifacts.
Additional service documentation will be expanded as the other services are aligned with the same Sabu architecture.