EikHub · Guide
Sharing analyses through EikHub
Femra and Varmra keep their analyses beside the model in the building on EikHub, where everyone who reads it sees them and whether they still hold.
What it gives you
EikHub is where buildings branch, get reviewed and merge, the way software does. A building on EikHub is a series of versions of one OpenEik model. Beside the model, a version can hold the work of the applications that analyse it: Femra's structural analysis and Varmra's energy balance, each with its report.
One place
The model, the drawings and the analyses of a building are read in one place, by the same people.
Tied to a version
Every analysis names the version it was computed from, so you always know what it is about.
It says when it is out of date
EikHub compares what the analysis read with the version you look at and marks it current or stale.
The report goes with it
The report PDF is kept in the version beside the analysis, ready to download.
There is nothing to share twice: whoever may read the building reads its analyses too.
The ideas behind it
| Term | What it means |
|---|---|
| Building | A model on EikHub, with its versions, its main line and its alternatives. |
| Version | One saved state of the whole building. A version never changes; a change makes a new one. |
| App folder | Each application keeps its files in a folder of its own in the version, such as femra/frame/ or varmra/energy/. The model's own records stay as they are. |
| Result set | One run of an analysis: its inputs, its results and a manifest. A version can keep several; the newest is shown first. |
| Manifest | The result set's label. It names the version the analysis was computed from and a fingerprint of the records it read, such as the walls, windows, roofs and rooms an energy balance uses. |
| Report | The analysis's report as a PDF, kept in the version as a file the manifest names. |
| Run id | The result set's identity. The same inputs on the same engine give the same id. |
The folders, manifests and the rule for "current" are part of the open OpenEik format, so every application judges them the same way.
Current and stale
An analysis does not go out of date just because the building has a newer version. It goes out of date when something it read has changed.
- Current: nothing it was computed from has changed in this version, neither the records it read nor the application's own files.
- Stale: something it was computed from has changed. EikHub says what: records it read that changed, were added or are gone.
- Not known: the manifest does not say what the analysis was computed from, so EikHub cannot judge it.
A stale analysis is not wrong; it is about an earlier version. To bring it up to date, open it in its application, read the newest version of the building, compute again and save.
Saving from Varmra
Varmra saves an energy balance into the building it was read from.
- Read the building from EikHub. In the Building envelope step, Import from EikHub lists the buildings you can read. Sign in with EikHub: your Stomra account, or Google. Varmra has no separate login.
- Watch the building pin. The project bar shows which version the project was read from and whether it still holds: Building current, or Building changed when inputs Varmra reads have changed. Its menu says which, and Read the newest version brings them in. Your answers to the import's checks are carried over. Varmra checks when the project opens, every ten minutes while the tab is in view, and when you come back to the tab.
- Calculate. Work through the steps as usual.
- Save to EikHub. On the Report step, Save to EikHub writes the energy balance and its report PDF into Varmra's folder in a new version of the building. The first time, EikHub asks you to let Varmra save. When it is done, Open on EikHub takes you to the building.
Varmra does not save while the building has changed in what it reads: read the newest version first, so the saved analysis is pinned to a version it really matches.
A formal report usually belongs to an issued version. Read that version in Varmra as a version of its own: it follows no line of work, so it never goes stale.
Saving from Femra
Femra writes its model, loads and results into its own folder of the building, and the calculation report beside them: as HTML in the run's folder, and as a PDF the run's manifest names, printed as you set it in Project → Calculation report.
- A building that is new to EikHub. In the EikHub panel, Publish to EikHub makes the model a new building in one of your organisations. Tick Include Femra's model, loads and results, and the calculation report if you want it. You commit its first version; later changes go to it as proposals.
- A building that is already on EikHub. Open it from EikHub, analyse, then Propose to EikHub. Tick the results with their manifest, and the calculation report. An admin of the building reviews the proposal and merges it; the analysis is then in the building's version.
- When the building moves on. Femra tells you when EikHub has a newer version of the building, and Pull shows what changed before you take it in.
Reading analyses on EikHub
On eikhub.com, open the building and choose the Analyses tab. It shows the analyses in the latest version on main, or in the version you chose, one card per application's model:
- the application and the model, and the version it was computed on;
- its state, Current, Stale or Not known, and for a stale one what changed since;
- its key figures, such as the energy class and primary energy number from Varmra, or the highest utilisation from Femra;
- the report to download;
- earlier result sets kept in the same version, folded away below the newest.
To see how an analysis stood at another point in the building's history, choose that version; the tab links back to the latest.
Opening an analysis from the building
On a card, Open in Varmra or Open in Femra opens the analysis in its application as a copy of your own, read from the version you are looking at. You can study it, change it, compute again and save your result into the building in turn. The analysis in the building stays as it was.
Who sees and who saves
| You can | What you can do with the analyses |
|---|---|
| Read the building | See every analysis and download its report. |
| Write to the building | Save an analysis into it from Varmra or Femra, where the building's ownership lets you write that application's folder. |
| Propose to the building | Send an analysis as a proposal that an admin of the building merges. |
A building that is private stays private: someone who may not read it is told it does not exist, so its name never shows. When EikHub does not let an application save, the application says so and nothing is saved.