Vulcan Logo
Join

Licensing

Vulcan software licensing and open source components

Vulcan Proprietary License

Vulcan is proprietary software developed by Home Energy Foundry Limited. The software and associated documentation files are the proprietary and confidential information of Home Energy Foundry Limited. The Software is licensed, not sold.

License text: The full proprietary license text is available at LICENSE.txt. This page provides information about open-source components that Vulcan uses or redistributes.

For licensing inquiries, contact: info@usevulcan.app

Redistributed Components

Vulcan redistributes certain open-source and third-party components. This section provides details about each component, its license, and how to access corresponding source code.

Overview

ComponentPurposeLicenseDetails
IfcOpenShellIFC file import parsingLGPLv3 / GPLv3View details
HEM EngineHome Energy Model calculation engineMITView details
Pyodide RuntimePython runtime for browserApache 2.0View details
Bundled DependenciesRust crates and JavaScript packagesVarious (mostly MIT/Apache-2.0)View details

IfcOpenShell (LGPLv3)

Vulcan uses IfcOpenShell for IFC (Industry Foundation Classes) file import functionality. IfcOpenShell is licensed under the GNU Lesser General Public License v3.0 (LGPLv3) and GNU General Public License v3.0 (GPLv3).

User Replacement

In compliance with LGPLv3 requirements, users can replace the IfcOpenShell library used by Vulcan. This can be done through the Advanced Settings in the IFC import modal, where you can specify a custom wheel URL.

Shipped Versions

VersionCommitFilenameDefaultLicense
0.8.4283ad7difcopenshell-0.8.4+283ad7d-cp313-cp313-pyodide_202...LGPLv3, GPLv3
0.8.334a1bc6ifcopenshell-0.8.3+34a1bc6-cp313-cp313-emscripten_...✓LGPLv3, GPLv3

Corresponding Source

For each shipped version, corresponding source code is available:

  • 0.8.4 (commit 283ad7d): GitHub
  • 0.8.3 (commit 34a1bc6): GitHub

Upstream repository: IfcOpenShell on GitHub

License texts: Each wheel file contains embedded license texts:

  • COPYING.LESSER (GNU LGPL v3)
  • COPYING (GNU GPL v3)

HEM Engine (MIT)

Vulcan includes the Home Energy Model (HEM) engine, which performs energy performance calculations for buildings. The HEM engine is licensed under the MIT License.

Source Code

Redistributed Schemas

Vulcan redistributes JSON schema files derived from the HEM engine:

  • input_core_allowing_fhs.schema.json - Available at /hem_engine/schemas/input_core_allowing_fhs.schema.json
  • input_fhs.schema.json - Available at /hem_engine/schemas/input_fhs.schema.json

These schemas are derived from the MIT-licensed HEM engine source code.

Pyodide Runtime (Apache 2.0)

Vulcan uses Pyodide to run Python code in the browser, enabling IFC file parsing functionality. Pyodide is licensed under the Apache License 2.0.

Version

Redistributed Files

Pyodide runtime files are available at /pyodide/:

  • pyodide.asm.js
  • pyodide.asm.wasm
  • python_stdlib.zip (Python standard library, PSF License)
  • pyodide-lock.json
  • packaging-22.1-py3-none-any.whl

Bundled Dependencies

Vulcan bundles additional dependencies that are compiled or packaged with the application:

Rust Crates (Compiled into WASM)

The Vulcan WASM binary (wasm_wrapper_bg.wasm) includes Rust crates compiled from source. Major dependencies include:

  • HEM Engine - MIT (see HEM Engine section above)
  • hem-batch-core - MIT (proprietary code developed by Home Energy Foundry Limited)
  • wasm-bindgen, js-sys, web-sys - Apache-2.0 / MIT
  • serde, serde_json - MIT / Apache-2.0
  • chrono - MIT / Apache-2.0
  • rayon - Apache-2.0 / MIT
  • jsonschema - Apache-2.0
  • Additional transitive dependencies (mostly MIT/Apache-2.0)

Note: These crates are compiled into the WASM binary and are not separately redistributed. Most dependencies are licensed under MIT or Apache-2.0.

JavaScript Packages (Bundled in Web App)

The Vulcan web application bundles JavaScript dependencies. Major packages include:

  • React, React DOM - MIT
  • Material-UI (@mui/material) - MIT
  • Konva, react-konva - BSD-2-Clause
  • CodeMirror (@codemirror/*) - MIT
  • JSON Forms (@jsonforms/*) - MIT
  • TanStack (@tanstack/react-query, @tanstack/react-table) - MIT
  • Supabase Client (@supabase/supabase-js) - MIT
  • Additional dependencies

Note: These packages are bundled into JavaScript chunks. Most dependencies are licensed under MIT or Apache-2.0.

Third-Party Notices

IfcOpenShell 0.8.4 - LGPLv3 / GPLv3
IfcOpenShell 0.8.3 (default) - LGPLv3 / GPLv3

Questions?

For licensing inquiries or to request source code for any redistributed component, please contact: info@usevulcan.app