ruumica documentation

Your first closeout package

Load the demo project, judge a pair of OTDR traces, export a closeout package and open its book, in about ten minutes.

This page takes you through the whole office path once, with the demo project ee-demo: a small Estonian fibre network with nodes, spans, two cables, photos and OTDR traces. At the end you have a closeout package with a drawing, data files and a closeout book.

Before you start

  • ruumica is installed on a server and its self-test passed (Install ruumica on a server).

  • You work in the top folder of the ruumica repository, with DATABASE_URL set and asbuilt on your path.

  • Raw files are kept in a blob folder. Tell ruumica where:

    export ASBUILT_BLOB_DIR="$PWD/target/ee-demo/blobs"
    

1. Load the demo project

The loader creates the project, its network and its photos, and ingests its OTDR traces. Running it again replaces the demo project with a fresh copy.

$ scripts/load-ee-demo.sh
…

2. Check a fibre in both directions

Fibre 2 of cable FO-48-001 was measured from both ends. Judge the two traces as a pair:

$ asbuilt sor pair fixtures/projects/ee-demo/traces/c1_f02_1550_ab.sor fixtures/projects/ee-demo/traces/c1_f02_1550_ba.sor
…
      "message": "SPLICE at 271.2 m: bidirectional loss 0.400 dB (0.420 / 0.380) exceeds its limit",
…
  "status": "FAIL",
…

The splice at 271.2 m loses 0.420 dB measured from one end and 0.380 dB from the other. The average, 0.400 dB, is over the project’s 0.30 dB limit, so the fibre fails. From one end only, the verdict would have stayed PROVISIONAL (OTDR verdicts).

3. Export the closeout package

Freeze the project at an instant and export it with the Estonian profile:

$ asbuilt export --project ee-demo --profile ee.default.v1 --frozen-at 2026-01-01T00:00:00Z --out closeout --allow-grid-absent 'ee.*' --allow-unverified-profile
…
Warning TRACE_FAIL: trace ae42c57173763dad828cd14c6ac9594f9e7ab7bcff6104c0b41a402feb11283d (fibre 2, 1550 nm, A_TO_B) fails the optical rules; reported in the book
…
manifest_sha256 d0b2a38e6d15840031a1bf30c8defc48c72994c218b2bd569fc0da82c178e3df

The two permissions at the end are needed for Estonian projects today:

Estonian heights are not available yet. The licensed EST-GEOID2017 geoid model is not installed. Until it is, Estonian exports need --allow-grid-absent 'ee.*' and record that in the package, and field heights for Estonian projects wait with GRID_ABSENT. Norwegian projects are not affected.

Estonian drawings are provisional. The only Estonian export profile, ee.default.v1, has not been checked against an authority’s specification. Exports with it need --allow-unverified-profile, and every file is marked PROFILE NOT AUTHORITY-VERIFIED.

The failing fibre does not stop the export. It is a warning, reported in the book, so the decision stays with you and your client.

4. Look at what you got

$ ls closeout
closeout-ee-demo-20260101T000000Z.zip
ee-demo.dxf
ee-demo.geojson
ee-demo.gpkg
ee-demo.pdf
evidence
manifest.json
package.json
traces

Open closeout/ee-demo.pdf, the closeout book, in any PDF viewer. It lists every OTDR trace with its verdict, the failing splice of fibre 2, and every photo and trace file with its SHA-256 fingerprint. Open closeout/ee-demo.dxf in a CAD program to see the drawing.

Check

Export again into a second folder (an export never writes into a folder that has files in it). The manifest_sha256 is the same, and so is the ZIP, byte for byte (Exports never change):

$ asbuilt export --project ee-demo --profile ee.default.v1 --frozen-at 2026-01-01T00:00:00Z --out again --allow-grid-absent 'ee.*' --allow-unverified-profile
…
manifest_sha256 d0b2a38e6d15840031a1bf30c8defc48c72994c218b2bd569fc0da82c178e3df
$ cmp closeout/closeout-ee-demo-20260101T000000Z.zip again/closeout-ee-demo-20260101T000000Z.zip

Next

Last changed 2026-11-14