@mat3ra/esse 2025.11.26-0 → 2025.12.10-3

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.
Files changed (31) hide show
  1. package/dist/js/schema/context_providers_directory/boundary_conditions_data_provider.json +1 -1
  2. package/dist/js/schema/context_providers_directory/collinear_magnetization_context_provider.json +1 -1
  3. package/dist/js/schema/context_providers_directory/hubbard_j_context_provider.json +1 -1
  4. package/dist/js/schema/context_providers_directory/hubbard_legacy_context_provider.json +1 -1
  5. package/dist/js/schema/context_providers_directory/hubbard_u_context_provider.json +1 -1
  6. package/dist/js/schema/context_providers_directory/hubbard_v_context_provider.json +1 -1
  7. package/dist/js/schema/context_providers_directory/ion_dynamics_context_provider.json +1 -1
  8. package/dist/js/schema/context_providers_directory/ml_settings_context_provider.json +1 -1
  9. package/dist/js/schema/context_providers_directory/ml_train_test_split_context_provider.json +1 -1
  10. package/dist/js/schema/context_providers_directory/neb_data_provider.json +1 -1
  11. package/dist/js/schema/context_providers_directory/non_collinear_magnetization_context_provider.json +1 -1
  12. package/dist/js/schema/context_providers_directory/planewave_cutoffs_context_provider.json +1 -1
  13. package/dist/js/schema/context_providers_directory/points_grid_data_provider.json +1 -1
  14. package/dist/js/schema/context_providers_directory/points_path_data_provider.json +1 -1
  15. package/dist/js/schemas.json +1 -1
  16. package/dist/js/types.d.ts +14 -14
  17. package/package.json +2 -2
  18. package/schema/context_providers_directory/{boundary_conditions_provider.json → boundary_conditions_data_provider.json} +1 -1
  19. package/schema/context_providers_directory/{collinear_magnetization_provider.json → collinear_magnetization_context_provider.json} +1 -1
  20. package/schema/context_providers_directory/{hubbard_j_provider.json → hubbard_j_context_provider.json} +8 -2
  21. package/schema/context_providers_directory/{hubbard_legacy_provider.json → hubbard_legacy_context_provider.json} +1 -1
  22. package/schema/context_providers_directory/{hubbard_u_provider.json → hubbard_u_context_provider.json} +1 -1
  23. package/schema/context_providers_directory/{hubbard_v_provider.json → hubbard_v_context_provider.json} +1 -1
  24. package/schema/context_providers_directory/{ion_dynamics_provider.json → ion_dynamics_context_provider.json} +1 -1
  25. package/schema/context_providers_directory/{ml_settings_provider.json → ml_settings_context_provider.json} +6 -2
  26. package/schema/context_providers_directory/{ml_train_test_split_provider.json → ml_train_test_split_context_provider.json} +1 -1
  27. package/schema/context_providers_directory/{neb_provider.json → neb_data_provider.json} +1 -1
  28. package/schema/context_providers_directory/{non_collinear_magnetization_provider.json → non_collinear_magnetization_context_provider.json} +1 -1
  29. package/schema/context_providers_directory/{planewave_cutoffs_provider.json → planewave_cutoffs_context_provider.json} +1 -1
  30. package/schema/context_providers_directory/{points_grid_provider.json → points_grid_data_provider.json} +5 -2
  31. package/schema/context_providers_directory/{points_path_provider.json → points_path_data_provider.json} +1 -1
@@ -2890,7 +2890,7 @@ export declare enum Name {
2890
2890
  NWChemInputDataManager = "NWChemInputDataManager"
2891
2891
  }
2892
2892
  /** Schema dist/js/schema/context_providers_directory/boundary_conditions_data_provider.json */
2893
- export interface BoundaryConditionsProviderSchema {
2893
+ export interface BoundaryConditionsDataProviderSchema {
2894
2894
  /**
2895
2895
  * If assume_isolated = 'esm', determines the boundary conditions used for either side of the slab.
2896
2896
  */
@@ -3263,7 +3263,7 @@ export interface VASPNEBContextProviderSchema {
3263
3263
  /**
3264
3264
  * Set starting magnetization, can have values in the range [-1, +1].
3265
3265
  */
3266
- export interface CollinearMagnetizationProviderSchema {
3266
+ export interface CollinearMagnetizationContextProviderSchema {
3267
3267
  startingMagnetization?: {
3268
3268
  atomicSpecies?: string;
3269
3269
  value?: number;
@@ -3312,7 +3312,7 @@ export declare enum ContextProviderNameEnum {
3312
3312
  *
3313
3313
  * @minItems 1
3314
3314
  */
3315
- export type HubbardJProviderSchema = [
3315
+ export type HubbardJContextProviderSchema = [
3316
3316
  {
3317
3317
  paramType?: "U" | "J" | "B" | "E2" | "E3";
3318
3318
  atomicSpecies?: string;
@@ -3332,7 +3332,7 @@ export type HubbardJProviderSchema = [
3332
3332
  *
3333
3333
  * @minItems 1
3334
3334
  */
3335
- export type HubbardLegacyProviderSchema = [
3335
+ export type HubbardLegacyContextProviderSchema = [
3336
3336
  {
3337
3337
  atomicSpecies?: string;
3338
3338
  atomicSpeciesIndex?: number;
@@ -3348,7 +3348,7 @@ export type HubbardLegacyProviderSchema = [
3348
3348
  /**
3349
3349
  * Hubbard U parameters for DFT+U or DFT+U+V calculation.
3350
3350
  */
3351
- export type HubbardUProviderSchema = {
3351
+ export type HubbardUContextProviderSchema = {
3352
3352
  atomicSpecies?: string;
3353
3353
  atomicOrbital?: string;
3354
3354
  hubbardUValue?: number;
@@ -3359,7 +3359,7 @@ export type HubbardUProviderSchema = {
3359
3359
  *
3360
3360
  * @minItems 1
3361
3361
  */
3362
- export type HubbardVProviderSchema = [
3362
+ export type HubbardVContextProviderSchema = [
3363
3363
  {
3364
3364
  atomicSpecies?: string;
3365
3365
  siteIndex?: number;
@@ -3383,7 +3383,7 @@ export type HubbardVProviderSchema = [
3383
3383
  /**
3384
3384
  * Important parameters for molecular dynamics calculation
3385
3385
  */
3386
- export interface IonDynamicsProviderSchema {
3386
+ export interface IonDynamicsContextProviderSchema {
3387
3387
  numberOfSteps?: number;
3388
3388
  timeStep?: number;
3389
3389
  electronMass?: number;
@@ -3393,7 +3393,7 @@ export interface IonDynamicsProviderSchema {
3393
3393
  /**
3394
3394
  * Settings important to machine learning runs.
3395
3395
  */
3396
- export interface MLSettingsProviderSchema {
3396
+ export interface MLSettingsContextProviderSchema {
3397
3397
  target_column_name?: string;
3398
3398
  problem_category?: "regression" | "classification" | "clustering";
3399
3399
  }
@@ -3401,21 +3401,21 @@ export interface MLSettingsProviderSchema {
3401
3401
  /**
3402
3402
  * Fraction held as the test set. For example, a value of 0.2 corresponds to an 80/20 train/test split.
3403
3403
  */
3404
- export interface MLTrainTestSplitProviderSchema {
3404
+ export interface MLTrainTestSplitContextProviderSchema {
3405
3405
  fraction_held_as_test_set?: number;
3406
3406
  }
3407
3407
  /** Schema dist/js/schema/context_providers_directory/neb_data_provider.json */
3408
3408
  /**
3409
3409
  * Number of intermediate NEB images.
3410
3410
  */
3411
- export interface NEBProviderSchema {
3411
+ export interface NEBDataProviderSchema {
3412
3412
  nImages?: number;
3413
3413
  }
3414
3414
  /** Schema dist/js/schema/context_providers_directory/non_collinear_magnetization_context_provider.json */
3415
3415
  /**
3416
3416
  * Non-collinear magnetization parameters including starting magnetization, spin angles, and constraints.
3417
3417
  */
3418
- export interface NonCollinearMagnetizationProviderSchema {
3418
+ export interface NonCollinearMagnetizationContextProviderSchema {
3419
3419
  isExistingChargeDensity?: boolean;
3420
3420
  isStartingMagnetization?: boolean;
3421
3421
  startingMagnetization?: {
@@ -3446,7 +3446,7 @@ export interface NonCollinearMagnetizationProviderSchema {
3446
3446
  /**
3447
3447
  * Planewave cutoff parameters for electronic wavefunctions and density. Units are specific to simulation engine.
3448
3448
  */
3449
- export interface PlanewaveCutoffsProviderSchema {
3449
+ export interface PlanewaveCutoffsContextProviderSchema {
3450
3450
  wavefunction?: number;
3451
3451
  density?: number;
3452
3452
  }
@@ -3454,7 +3454,7 @@ export interface PlanewaveCutoffsProviderSchema {
3454
3454
  /**
3455
3455
  * 3D grid with shifts for k-point or q-point sampling.
3456
3456
  */
3457
- export interface PointsGridProviderSchema {
3457
+ export interface PointsGridDataProviderSchema {
3458
3458
  /**
3459
3459
  * @minItems 3
3460
3460
  * @maxItems 3
@@ -3480,7 +3480,7 @@ export interface PointsGridProviderSchema {
3480
3480
  *
3481
3481
  * @minItems 1
3482
3482
  */
3483
- export type PointsPathProviderSchema = [
3483
+ export type PointsPathDataProviderSchema = [
3484
3484
  {
3485
3485
  point?: string;
3486
3486
  steps?: number;
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@mat3ra/esse",
3
- "version": "2025.11.26-0",
3
+ "version": "2025.12.10-3",
4
4
  "description": "Mat3ra's Excellent Source of Schemas and Examples (ESSE) for Digital Materials R&D",
5
5
  "scripts": {
6
6
  "transpile": "tsc -p tsconfig-transpile.json",
7
7
  "build-schemas": "BUILD_ASSETS=true BUILD_PYTHON_MODULES=true BUILD_PATH='./dist/js' ts-node build_schemas.ts",
8
8
  "compile-types": "ts-node compile_ts.ts",
9
- "transpile-and-build-assets": "npm run build-schemas && npm run compile-types && npm run transpile",
9
+ "transpile-and-build-assets": "npm run set-schema-ids && npm run build-schemas && npm run compile-types && npm run transpile",
10
10
  "test": "npm run build-schemas && nyc --reporter=text mocha --recursive --timeout 15000 --bail tests/js",
11
11
  "test-only": "nyc --reporter=text mocha --recursive --bail tests/js",
12
12
  "lint": "eslint src/js && prettier --write src/js",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/boundary-conditions-data-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Boundary Conditions Provider Schema",
4
+ "title": "Boundary Conditions Data Provider Schema",
5
5
  "type": "object",
6
6
  "properties": {
7
7
  "type": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/collinear-magnetization-context-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Collinear Magnetization Provider Schema",
4
+ "title": "Collinear Magnetization Context Provider Schema",
5
5
  "description": "Set starting magnetization, can have values in the range [-1, +1].",
6
6
  "type": "object",
7
7
  "properties": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/hubbard-j-context-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Hubbard J Provider Schema",
4
+ "title": "Hubbard J Context Provider Schema",
5
5
  "description": "Hubbard parameters for DFT+U+J calculation.",
6
6
  "type": "array",
7
7
  "minItems": 1,
@@ -11,7 +11,13 @@
11
11
  "paramType": {
12
12
  "type": "string",
13
13
  "title": "Species",
14
- "enum": ["U", "J", "B", "E2", "E3"]
14
+ "enum": [
15
+ "U",
16
+ "J",
17
+ "B",
18
+ "E2",
19
+ "E3"
20
+ ]
15
21
  },
16
22
  "atomicSpecies": {
17
23
  "type": "string",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/hubbard-legacy-context-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Hubbard Legacy Provider Schema",
4
+ "title": "Hubbard Legacy Context Provider Schema",
5
5
  "description": "Hubbard parameters for DFT+U calculation.",
6
6
  "type": "array",
7
7
  "uniqueItems": true,
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/hubbard-u-context-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Hubbard U Provider Schema",
4
+ "title": "Hubbard U Context Provider Schema",
5
5
  "description": "Hubbard U parameters for DFT+U or DFT+U+V calculation.",
6
6
  "type": "array",
7
7
  "items": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/hubbard-v-context-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Hubbard V Provider Schema",
4
+ "title": "Hubbard V Context Provider Schema",
5
5
  "description": "Hubbard V parameters for DFT+U+V calculation.",
6
6
  "type": "array",
7
7
  "minItems": 1,
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/ion-dynamics-context-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Ion Dynamics Provider Schema",
4
+ "title": "Ion Dynamics Context Provider Schema",
5
5
  "description": "Important parameters for molecular dynamics calculation",
6
6
  "type": "object",
7
7
  "properties": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/ml-settings-context-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "ML Settings Provider Schema",
4
+ "title": "ML Settings Context Provider Schema",
5
5
  "description": "Settings important to machine learning runs.",
6
6
  "type": "object",
7
7
  "properties": {
@@ -10,7 +10,11 @@
10
10
  },
11
11
  "problem_category": {
12
12
  "type": "string",
13
- "enum": ["regression", "classification", "clustering"]
13
+ "enum": [
14
+ "regression",
15
+ "classification",
16
+ "clustering"
17
+ ]
14
18
  }
15
19
  }
16
20
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/ml-train-test-split-context-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "ML Train Test Split Provider Schema",
4
+ "title": "ML Train Test Split Context Provider Schema",
5
5
  "description": "Fraction held as the test set. For example, a value of 0.2 corresponds to an 80/20 train/test split.",
6
6
  "type": "object",
7
7
  "properties": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/neb-data-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "NEB Provider Schema",
4
+ "title": "NEB Data Provider Schema",
5
5
  "description": "Number of intermediate NEB images.",
6
6
  "type": "object",
7
7
  "properties": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/non-collinear-magnetization-context-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Non Collinear Magnetization Provider Schema",
4
+ "title": "Non Collinear Magnetization Context Provider Schema",
5
5
  "description": "Non-collinear magnetization parameters including starting magnetization, spin angles, and constraints.",
6
6
  "type": "object",
7
7
  "properties": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/planewave-cutoffs-context-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Planewave Cutoffs Provider Schema",
4
+ "title": "Planewave Cutoffs Context Provider Schema",
5
5
  "description": "Planewave cutoff parameters for electronic wavefunctions and density. Units are specific to simulation engine.",
6
6
  "type": "object",
7
7
  "properties": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/points-grid-data-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Points Grid Provider Schema",
4
+ "title": "Points Grid Data Provider Schema",
5
5
  "description": "3D grid with shifts for k-point or q-point sampling.",
6
6
  "type": "object",
7
7
  "properties": {
@@ -31,7 +31,10 @@
31
31
  },
32
32
  "gridMetricType": {
33
33
  "type": "string",
34
- "enum": ["KPPRA", "spacing"]
34
+ "enum": [
35
+ "KPPRA",
36
+ "spacing"
37
+ ]
35
38
  },
36
39
  "gridMetricValue": {
37
40
  "type": "number"
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$id": "context-providers-directory/points-path-data-provider",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "Points Path Provider Schema",
4
+ "title": "Points Path Data Provider Schema",
5
5
  "description": "Path in reciprocal space for band structure calculations.",
6
6
  "type": "array",
7
7
  "minItems": 1,