Skip to content

Examples and Data

Sabu uses a companion repository for examples, datasets, outputs, and benchmark materials.

The companion repository is available at:

sabu-test-data-and-examples

This repository supports testing and demonstration without overloading the main Sabu source-code repository.

Purpose of the companion repository

The companion repository is used for:

  • example input datasets,
  • service execution examples,
  • generated results,
  • benchmark materials,
  • reproducibility files,
  • command examples for direct Python, API, and Docker execution.

Relationship to the main Sabu repository

The main sabu repository contains the framework implementation.

The sabu-test-data-and-examples repository contains materials that show how the implementation can be used.

Repository Main role
sabu Source code, services, shared libraries, contracts, deployment files
sabu-test-data-and-examples Test data, examples, outputs, benchmark materials

Current example focus

The current companion materials focus mainly on jug_lca_buildings.

The repository includes example materials for:

  • API usage,
  • direct Python usage,
  • Docker usage,
  • datasets,
  • results,
  • benchmarks.

Additional examples can be added as the other Sabu services become more mature.

Main repositories:

Example locations in the companion repository:

Zenodo

A Zenodo link is not currently included in the root companion repository documentation.

If you want, a Zenodo section can be added later, for example:

  • dataset archive,
  • results archive,
  • citation record.

Use the companion repository when you want to:

  • test jug_lca_buildings with prepared inputs,
  • reproduce example runs,
  • inspect expected outputs,
  • compare execution modes,
  • understand the relationship between input GeoJSON files and generated emissions outputs.

For framework source code, use the main sabu repository. For reproducible examples and generated outputs, use the companion repository.