Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

globi-toolkit

The main entry point for the Global Building Inventory (GloBI). It pulls the GloBI components together so you can author inputs, run simulations, fetch results, test use cases and visualize outputs from one place. The toolkit itself holds glue, not domain logic: modeling lives in the engine, data lives in globi-data.

How the repos fit together

flowchart LR
  subgraph pypi["PyPI"]
    epi["epinterface<br/>EnergyPlus models,<br/>component library"]
    scy["scythe-engine<br/>simulation fan-out"]
  end

  engine["<b>globi</b> (engine)<br/>GIS, simulation,<br/>surrogates, worker"]
  data["<b>globi-data</b><br/>versioned inputs,<br/>result and surrogate URIs"]
  usecases["globi-use-cases<br/>WTP, adoption,<br/>emissions"]

  subgraph toolkit["globi-toolkit (this repo)"]
    cli["globi-toolkit CLI<br/>engine, data, visualize"]
    ui["apps/sbem-ui<br/>authoring app"]
    stack["Docker run stack<br/>Hatchet, workers, localstack"]
    viz["visualize/<br/>results dashboard"]
    docs["docs/<br/>documentation site"]
  end

  s3[("results on S3<br/>or localstack")]

  epi --> engine
  scy --> engine
  engine -- "Python package,<br/>commit pinned in uv.lock" --> cli
  engine -- "worker image built<br/>from that commit" --> stack
  data -- "Python package, plus its<br/>registry cloned to ~/.cache" --> cli
  ui -- "model files<br/>(fields, components, GIS)" --> cli
  cli -- "globi submit" --> stack
  stack --> s3
  s3 --> viz
  usecases -. "planned" .-> cli
Loading

The dashed link is planned. Clone only this repo: the engine and globi-data arrive as packages pinned in uv.lock, the worker image is built from the same engine commit, and globi-data's registry is cloned on first use. epinterface and scythe come in through the engine. Result URIs go back into globi-data with globi-toolkit data outputs record.

Stages and where each comes from

Stage Role (UBEM.IO) Provided by Status
author — semantic fields, component library, priors, retrofits energy modeler sbem-ui, in apps/sbem-ui/ in this repo
ingest GIS — footprints, height, type, age GIS manager globi engine (globi.gis) dependency
run — partner × scenario × weather registry on top of globi submit energy modeler moves here from globi-partners-data experiments/ planned
surrogate — training config, inference on a whole stock, recording in globi-data energy modeler toolkit; training itself stays in the engine scoped, see MIGRATION.md
validate — against metered data, calibration all globi.validation, globi-uk-calibration later
fetch — versioned inputs, result and surrogate URIs all globi-data dependency
analyze — WTP, adoption, emissions sustainability champion globi-use-cases planned (needs a proper package)
visualize sustainability champion results dashboard, in src/globi_toolkit/visualize/ in this repo

The documentation site lives here too (make docs); see MIGRATION.md for what moved from the engine.

Setup

uv sync
uv run epinterface prisma generate   # one-time, for the component library (or: make install)
uv run globi-toolkit info            # prints installed versions of each component
uv run globi-toolkit engine --help   # the engine's CLI (submit, simulate, get, tests)
uv run globi-toolkit data inputs list  # the globi-data CLI; first use clones globi-data into ~/.cache

Run simulations locally

Everything runs from this repo; no engine checkout is needed. make help lists all targets.

make hatchet-token   # start Hatchet and write its token to .env.local*.hatchet
make engine          # build the worker image from the engine commit in uv.lock, start the stack
make ps              # check the containers
make viz-native      # results dashboard on http://localhost:8501
make down            # stop everything

The worker image is about 6 GB and the build downloads EnergyPlus; the dashboard image is about 5 GB. The stack uses the same ports as the engine repo's stack (8888, 7077, 4566, 5672), so stop one before starting the other. Tutorials are in the docs (make docs).

globi-toolkit data reads globi-data's registry from a shallow clone in ~/.cache/globi-toolkit/globi-data (globi-toolkit data pull updates it). To publish or record versions, point it at your own checkout with GLOBI_DATA_ROOT or --root.

globi and globi-data install from their main branches; uv.lock records the exact commits, so the lockfile is the one place where component versions are known to work together.

Authoring inputs with sbem-ui

sbem-ui is a Svelte + FastAPI app in apps/sbem-ui/, a uv workspace member: uv sync installs its Python side with everything else. The frontend needs Node 18+. It writes the files GloBI runs (semantic-fields.yaml, component-map.yaml, components-lib.db, priors, retrofits) and runs GloBI through this repo's make cli-native / make cli.

make ui-setup   # once: frontend packages
make ui         # backend on :8000, app on http://localhost:5173
make test-ui    # sbem-ui's tests

Create projects under inputs/ so Docker runs can see them. Single Building runs need the engine's simulate-flat command, which is not on globi main yet.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages