@vulcan-energy/mcp-helper 0.2.4 → 0.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +9 -0
- package/README.md +19 -14
- package/THIRD_PARTY_NOTICES.md +10 -1
- package/dist/bin/vulcan-mcp-helper.js +25 -37
- package/dist/hem-target-runtime/browser-adapter.mjs +36 -6
- package/dist/hem-target-runtime/csv-target.mjs +126 -0
- package/dist/hem-target-runtime/host.mjs +1215 -493
- package/dist/hem-target-runtime/python-worker.mjs +5 -3
- package/dist/hem-target-runtime/rust-worker.mjs +5 -3
- package/dist/server.js +23 -35
- package/package.json +1 -1
- package/wasm/THIRD_PARTY_RUST_CRATES.md +5693 -0
- package/wasm/wasm_version.json +9 -9
- package/wasm/wasm_wrapper.js +6 -6
- package/wasm/wasm_wrapper_bg.wasm +0 -0
package/LICENSE
CHANGED
|
@@ -15,6 +15,15 @@ This Software is provided "AS IS" without warranty of any kind, either express
|
|
|
15
15
|
or implied, including but not limited to the implied warranties of
|
|
16
16
|
merchantability and fitness for a particular purpose.
|
|
17
17
|
|
|
18
|
+
This package includes code from the Vulcan community repository
|
|
19
|
+
(https://github.com/vulcan-energy/vulcan-community), which is also published
|
|
20
|
+
under the open-source licences recorded in that repository. Home Energy Foundry
|
|
21
|
+
Limited distributes that code in this package under this package's licence, as
|
|
22
|
+
its copyright holder or under the Vulcan contributor licence agreements.
|
|
23
|
+
|
|
24
|
+
Third-party material in this package is licensed under the terms in
|
|
25
|
+
THIRD_PARTY_NOTICES.md.
|
|
26
|
+
|
|
18
27
|
For licensing inquiries, contact: info@usevulcan.app
|
|
19
28
|
|
|
20
29
|
|
package/README.md
CHANGED
|
@@ -263,13 +263,13 @@ Calculate metrics (sum, average, peak, min, cost) from results.
|
|
|
263
263
|
|
|
264
264
|
### 10. `vulcan_merge_csv_to_json`
|
|
265
265
|
|
|
266
|
-
Convert geometry CSV
|
|
266
|
+
Convert a geometry CSV file to HEM input JSON for its HEM target (see
|
|
267
|
+
[HEM targets](#hem-targets)). The target sets the schema and the defaults.
|
|
267
268
|
|
|
268
269
|
**Parameters:**
|
|
269
270
|
- `csv_path` (required, string): Path to CSV file (relative to workspace or absolute)
|
|
270
271
|
- `output_path` (optional, string): Output JSON path (defaults to input/batch_parameters/base_json/{csv_filename}.json)
|
|
271
|
-
- `
|
|
272
|
-
- `defaults_path` (optional, string): Custom defaults path (defaults to `input/batch_parameters/base_json/defaults_template.json`)
|
|
272
|
+
- `target_manifest`, `target_manifest_sha256` (optional, strings): offline override for a trusted local bundle
|
|
273
273
|
|
|
274
274
|
**Example:**
|
|
275
275
|
```json
|
|
@@ -317,12 +317,13 @@ Should return:
|
|
|
317
317
|
- **WASM errors**: Reinstall package: `npm install -g @vulcan-energy/mcp-helper`
|
|
318
318
|
|
|
319
319
|
|
|
320
|
-
##
|
|
320
|
+
## HEM targets
|
|
321
321
|
|
|
322
322
|
A CSV saved by the current app pins its HEM target in Metadata
|
|
323
|
-
(`TargetBundleId`).
|
|
324
|
-
|
|
325
|
-
|
|
323
|
+
(`TargetBundleId`). A CSV with no `TargetBundleId` row, or an empty one, uses
|
|
324
|
+
Rust HEM:FHS 1.0.0a7, as in the app. `vulcan_merge_csv_to_json`,
|
|
325
|
+
`vulcan_create_batch_config` and `vulcan_run_batch` run every CSV through its
|
|
326
|
+
target with no extra arguments. Install Google Chrome separately: this helper packages the browser
|
|
326
327
|
adapter and application workers, not a browser.
|
|
327
328
|
|
|
328
329
|
The first use of a target downloads it from `usevulcan.app` into
|
|
@@ -335,11 +336,13 @@ path relative to the workspace) plus `target_manifest_sha256` remain an optional
|
|
|
335
336
|
offline override for a trusted local bundle; supplying only one fails. Missing
|
|
336
337
|
inputs never substitute the helper's installed legacy Rust engine.
|
|
337
338
|
|
|
338
|
-
Merge uses the target's own schema and defaults. `
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
339
|
+
Merge uses the target's own schema and defaults. A `DefaultsPath` in the CSV
|
|
340
|
+
must hold the same defaults as the target, or the merge stops with an error.
|
|
341
|
+
`vulcan_create_batch_config` captures the application's exact `__hem` snapshot
|
|
342
|
+
from the source CSVs and selected JSON snippets, and refuses a batch that mixes
|
|
343
|
+
targets. `weather_file` is required only for a base model with no source CSV and
|
|
344
|
+
no target marker; omit it to use the target's reference weather, or name an EPW
|
|
345
|
+
to capture it as the app does. Run uses the saved
|
|
343
346
|
snapshot. Target runs return `started` and continue in a background process;
|
|
344
347
|
`vulcan_get_batch_status` reports download and calculation progress, completion
|
|
345
348
|
and runtime errors, including browser startup failures after the initial
|
|
@@ -349,5 +352,7 @@ before removing a stale lock.
|
|
|
349
352
|
|
|
350
353
|
The adapter uses the same preparation and workers as the app. Synthetic automated
|
|
351
354
|
checks and an a9 preparation-only Chrome probe cover this transport; full MCP
|
|
352
|
-
calculation qualification is separate from those checks.
|
|
353
|
-
|
|
355
|
+
calculation qualification is separate from those checks. A saved batch with no
|
|
356
|
+
`__hem` snapshot still runs on the installed WASM only when no base model has a
|
|
357
|
+
source CSV or target marker; otherwise `vulcan_run_batch` refuses it and asks
|
|
358
|
+
you to create the batch again with `vulcan_create_batch_config`.
|
package/THIRD_PARTY_NOTICES.md
CHANGED
|
@@ -9,7 +9,10 @@ It also includes and/or depends on third-party software. This file is the starti
|
|
|
9
9
|
- Generate a full dependency license report at release time (CI or local) and update this file.
|
|
10
10
|
- Suggested tooling:
|
|
11
11
|
- Node: `license-checker` (or equivalent) against the exact production dependency tree
|
|
12
|
-
|
|
12
|
+
|
|
13
|
+
## Rust crates in `wasm/`
|
|
14
|
+
|
|
15
|
+
`wasm/THIRD_PARTY_RUST_CRATES.md` lists each third-party Rust crate compiled into `wasm/wasm_wrapper_bg.wasm`, with its licence text. The WASM build generates it with `cargo-about`.
|
|
13
16
|
|
|
14
17
|
## Direct npm dependencies (from `package.json`)
|
|
15
18
|
|
|
@@ -341,3 +344,9 @@ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR I
|
|
|
341
344
|
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
342
345
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
343
346
|
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
347
|
+
|
|
348
|
+
### Home Energy Model guidance Table 3.7 default psi values
|
|
349
|
+
|
|
350
|
+
`dist/hem-target-runtime/host.mjs` includes the default linear thermal-transmittance values from Home Energy Model guidance, Building Fabric, section 3.7.2, Table 3.7 (psi values for different types of junctions), published by the Department for Energy Security and Net Zero. Crown copyright.
|
|
351
|
+
|
|
352
|
+
Contains public sector information licensed under the Open Government Licence v3.0 (https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).
|