@mat3ra/wode 2026.9.2-0 → 2026.10.22-0
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/README.md +34 -1
- package/dist/js/Subworkflow.d.ts +1 -1
- package/dist/js/Workflow.d.ts +1 -2
- package/package.json +2 -2
- package/src/js/Subworkflow.ts +1 -1
- package/src/js/Workflow.ts +2 -5
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
[](https://badge.fury.io/js/%40mat3ra%2Fwode)
|
|
2
2
|
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
3
3
|
|
|
4
|
-
#
|
|
4
|
+
# WoDe
|
|
5
5
|
|
|
6
6
|
WOrkflow DEfinitions - houses the definitions for:
|
|
7
7
|
|
|
@@ -38,6 +38,39 @@ git clone https://github.com/Exabyte-io/wode.git
|
|
|
38
38
|
```
|
|
39
39
|
|
|
40
40
|
|
|
41
|
+
## Python input rendering
|
|
42
|
+
|
|
43
|
+
`workflow.render({"material": material})` renders execution-unit inputs from their
|
|
44
|
+
STANDATA templates. It does not execute assignment units, loops, or applications.
|
|
45
|
+
Rendered text is stored in each input's `rendered` field; template contents and
|
|
46
|
+
manually edited inputs are preserved. Raw runtime placeholders remain for the job runner.
|
|
47
|
+
|
|
48
|
+
The initial Python provider registry supports QE SCF inputs:
|
|
49
|
+
`QEPWXInputDataManager`, `KGridFormDataManager`, and `PlanewaveCutoffDataManager`.
|
|
50
|
+
Supply `model.method.data.pseudo` entries with `element` and `filename` or `path`,
|
|
51
|
+
and execution-unit context entries named `cutoffs` and `kgrid` for positive cutoffs
|
|
52
|
+
and explicit grid dimensions (grid-metric calculation is not implemented).
|
|
53
|
+
An `input` context entry can override generated input fields. MADE supplies crystal
|
|
54
|
+
coordinates and angstrom cell vectors without modifying the caller's material.
|
|
55
|
+
For multimaterial workflows, supply `materials` in addition to the primary `material`.
|
|
56
|
+
The QE provider builds `input.perMaterial` with the same conversion for each material.
|
|
57
|
+
STANDATA's new `pw_scf_volume_scaled` template converts `MATERIAL_INDEX` to an integer
|
|
58
|
+
and selects the input; ordinary `pw_scf` retains its existing behavior.
|
|
59
|
+
WoDe passes assignment values through unchanged. The renderer does not create or
|
|
60
|
+
execute a loop. Common input overrides apply to each material. Other providers,
|
|
61
|
+
constrained atoms, labeled species, and grid-metric calculation remain unsupported.
|
|
62
|
+
|
|
63
|
+
The template conversion comes from [STANDATA #168](https://github.com/mat3ra/standata/pull/168),
|
|
64
|
+
released in `mat3ra-standata>=2026.10.22.post1`.
|
|
65
|
+
|
|
66
|
+
Rendering uses `mat3ra.utils.extra.jinja.render_jinja_with_error_handling` with a
|
|
67
|
+
call-local `sprintf` filter and number formatter. WoDe opts into exceptions so template
|
|
68
|
+
errors cannot be stored as executable input. Existing utils callers retain their
|
|
69
|
+
default diagnostic-string behavior.
|
|
70
|
+
|
|
71
|
+
The shared renderer requires `mat3ra-utils[extra]>=2026.10.22.post0`, the published
|
|
72
|
+
release containing [utils #56](https://github.com/mat3ra/utils/pull/56).
|
|
73
|
+
|
|
41
74
|
## Contributions
|
|
42
75
|
|
|
43
76
|
This repository is an [open-source](LICENSE.md) work-in-progress and we welcome contributions.
|
package/dist/js/Subworkflow.d.ts
CHANGED
|
@@ -25,7 +25,7 @@ type ConvergenceConfig = {
|
|
|
25
25
|
maxOccurrences: number;
|
|
26
26
|
externalContext: SubworkflowExternalContext;
|
|
27
27
|
};
|
|
28
|
-
interface Subworkflow extends Defaultable, NamedEntity, SubworkflowSchemaMixin, HashedEntity,
|
|
28
|
+
interface Subworkflow extends Defaultable, NamedEntity, SubworkflowSchemaMixin, HashedEntity, ComputedEntityMixin<SubworkflowSchemaMixin["compute"]> {
|
|
29
29
|
}
|
|
30
30
|
type SubworkflowExternalContext = WorkflowRenderContext & WorkflowExternalContext;
|
|
31
31
|
export type SubworkflowEntity = SubworkflowSchema & BaseInMemoryEntitySchema;
|
package/dist/js/Workflow.d.ts
CHANGED
|
@@ -20,8 +20,7 @@ import { type AnyWorkflowUnit } from "./units/factory";
|
|
|
20
20
|
import type { WorkflowSchema } from "./workflows/types";
|
|
21
21
|
export type WorkflowEntity = WorkflowSchema & BaseInMemoryEntitySchema;
|
|
22
22
|
type Schema = WorkflowEntity;
|
|
23
|
-
interface Workflow extends Defaultable, NamedEntity, WorkflowSchemaMixin, Taggable, HashedEntity, ComputedEntityMixin
|
|
24
|
-
compute: WorkflowSchema["compute"];
|
|
23
|
+
interface Workflow extends Defaultable, NamedEntity, WorkflowSchemaMixin, Taggable, HashedEntity, ComputedEntityMixin<WorkflowSchema["compute"]>, HasDescription {
|
|
25
24
|
}
|
|
26
25
|
/** Context passed to Workflow.render(); subworkflows also receive `workflowHasRelaxation`. */
|
|
27
26
|
export type WorkflowRenderContext = MaterialExternalContext & MaterialsExternalContext & MaterialsSetExternalContext & JobExternalContext & {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mat3ra/wode",
|
|
3
|
-
"version": "2026.
|
|
3
|
+
"version": "2026.10.22-0",
|
|
4
4
|
"description": "WOrkflow DEfinitions",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"test": "mocha --recursive --bail --require ts-node/register 'tests/js/**/*.ts'",
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
"@mat3ra/ade": "2026.8.18-0",
|
|
45
45
|
"@mat3ra/code": "2026.8.18-0",
|
|
46
46
|
"@mat3ra/esse": "2026.8.18-2",
|
|
47
|
-
"@mat3ra/ide": "2026.8
|
|
47
|
+
"@mat3ra/ide": "2026.10.8-0",
|
|
48
48
|
"@mat3ra/made": "2026.8.18-0",
|
|
49
49
|
"@mat3ra/mode": "2026.8.18-0",
|
|
50
50
|
"@mat3ra/prode": "2026.8.18-0",
|
package/src/js/Subworkflow.ts
CHANGED
|
@@ -56,7 +56,7 @@ interface Subworkflow
|
|
|
56
56
|
NamedEntity,
|
|
57
57
|
SubworkflowSchemaMixin,
|
|
58
58
|
HashedEntity,
|
|
59
|
-
|
|
59
|
+
ComputedEntityMixin<SubworkflowSchemaMixin["compute"]> {}
|
|
60
60
|
|
|
61
61
|
type SubworkflowExternalContext = WorkflowRenderContext & WorkflowExternalContext;
|
|
62
62
|
|
package/src/js/Workflow.ts
CHANGED
|
@@ -59,11 +59,8 @@ interface Workflow
|
|
|
59
59
|
WorkflowSchemaMixin,
|
|
60
60
|
Taggable,
|
|
61
61
|
HashedEntity,
|
|
62
|
-
ComputedEntityMixin
|
|
63
|
-
HasDescription {
|
|
64
|
-
// TODO: fix ComputedEntityMixin and remove this
|
|
65
|
-
compute: WorkflowSchema["compute"];
|
|
66
|
-
}
|
|
62
|
+
ComputedEntityMixin<WorkflowSchema["compute"]>,
|
|
63
|
+
HasDescription {}
|
|
67
64
|
|
|
68
65
|
/** Context passed to Workflow.render(); subworkflows also receive `workflowHasRelaxation`. */
|
|
69
66
|
export type WorkflowRenderContext = MaterialExternalContext &
|