Python core: split simulation.py and schema.py, one route assembly, shared identity, durability and validation helpers

benchmarks/builders.py

@@ -474,7 +474,7 @@ def spatial(
         # at translation, its error measured at 1.7e-6 in field.
         settings = dataclasses.replace(settings, spatial_absorber=SpatialAbsorber())
     if isinstance(space, RadialGrid):
-        return Simulation.from_radial(
+        return Simulation.from_free(
             grid, space, medium, responses, pulse, settings=settings, **_launch(options)
         )
     return Simulation.from_free(

benchmarks/registry.py

@@ -69,7 +69,9 @@ class Case:
     sets : tuple of str
         Selection groups; ``tracking`` puts the case in the default run.
     interface : str
-        The ``prop_*`` interface whose defaults the case runs with.
+        The ``prop_*`` interface whose defaults the case runs with. ``"prop_radial"``
+        is ``prop_free`` on a radial grid: the label the tracked definitions were
+        recorded with, kept so that their digests do not change.
     builder : str
         Builder family in ``benchmarks.builders``.
     length : float

benchmarks/worker.py

@@ -62,7 +62,7 @@
     from solprop.backends.protocol import Backend, HostStepping
     from solprop.driver import Simulation
     from solprop.monitor import BoundaryMonitor
-    from solprop.output.schema import FieldRetention, Output
+    from solprop.output.store import FieldRetention, Output
     from solprop.translate.problem import PropagationProblem
 
 
@@ -622,7 +622,7 @@ def measure(
     from solprop.backends import select  # noqa: PLC0415
     from solprop.driver.executors.pool import peak_rss  # noqa: PLC0415
     from solprop.driver.run import field_retention  # noqa: PLC0415
-    from solprop.output.schema import serialise  # noqa: PLC0415
+    from solprop.output.serialisation import serialise  # noqa: PLC0415
 
     free_before = _device_free(configuration)
     started = time.perf_counter()

changelog.d/driver-session-loop.breaking.md

@@ -0,0 +1,4 @@
+`solprop.driver.service`, the loop that services a run's execution session, is renamed
+`solprop.driver.session_loop`, apart from the front end's `solprop.service`.
+`solprop.driver.run.MARCH_SNAPSHOT_AUTO_BYTES` is gone; the one limit is
+`solprop.translate.run_request.MARCH_SNAPSHOT_AUTO_BYTES`.

changelog.d/driver-simulation-split.breaking.md

@@ -0,0 +1,7 @@
+`solprop.driver.simulation` now holds the `Simulation` class alone; the rest moved
+into modules by concern. Import `SimulationSettings` and `default_collar` from
+`solprop.driver.settings` (or `SimulationSettings` from `solprop.driver`),
+`SimulationRunner` and `check_derived_problem` from `solprop.driver.runner`,
+`metadata_for` from `solprop.driver.metadata`, `default_field_range` from
+`solprop.driver.inputs` and `default_radial_order` from
+`solprop.driver.routes.hollow`; the names `solprop.driver` exports are unchanged.

changelog.d/free-takes-radial.breaking.md

@@ -0,0 +1,5 @@
+`Simulation.from_radial` and `prop_radial` are removed: `Simulation.from_free` and
+`prop_free` take a `RadialGrid` as well as a `FreeGrid` or `LineGrid`, and choose the
+radial or the Cartesian transform from it, with the same keywords and the same
+defaults as before for each grid. Replace `from_radial(...)` with `from_free(...)` and
+`prop_radial(...)` with `prop_free(...)`; recipes keep the `radial` route.

changelog.d/open-run.removed.md

@@ -0,0 +1,2 @@
+`solprop.driver.run.open_run_record` is removed in favour of `solprop.driver.run.open_run`,
+which opens an output with the same record and also returns its checkpoint interface.

changelog.d/output-schema-split.breaking.md

@@ -0,0 +1,11 @@
+`solprop.output.schema` is split into five modules: `solprop.output.serialisation`
+(`serialise`, `ArrayDigest`, `StatedInput`, `recorded_input`), `solprop.output.provenance`
+(`BackendRecord`, `GitProvenance`, `package_versions`), `solprop.output.records`
+(`GridRecord`, `ModeRecord`, `StepperRecord`, `SavedPlane`, `RunOutcome` and the other
+record types), `solprop.output.metadata` (`RunMetadata`, `SCHEMA_VERSION`,
+`resolve_metadata_write`) and `solprop.output.store` (`Output`, `PlaneStore`,
+`FieldRetention` and the other save protocols). Import these names from
+`solprop.output`, which still exports the public ones, or from their new module. A run
+record names its record types by module (`solprop.output.records.GridRecord`), so every
+configuration hash differs from the one an earlier version wrote: a file or a scan
+written before cannot be resumed or continued, and is read as it was.

changelog.d/sep-0047-destination-export.changed.md

@@ -1 +1 @@
-A kept plane's field is exported once, straight into its stored form, with the same stored bits ([#346](https://github.com/LupoLab/solprop/issues/346), SEP 47). `MemoryOutput` hands the run the block row the plane will occupy, so the field is written once, where it is kept, with no host volume of its own; `HDF5Output` is handed one new array, which h5py writes into the plane's chunk without a copy. A plane observer and a failure checkpoint at the same plane share that export. On a 108 MiB Cartesian plane the native session's saved plane no longer allocates a field into memory and one fewer into a file, and the driver session's file output converts its observation where it is instead of allocating a second field. `PlaneStore` gains `takes_exports`, `field_destination` and `save_exported` for this, with `solprop.output.schema.StoredField` beside them; a store subclass that overrides `save` is still given every plane, with its field, through it. Export destinations are refused by what is wrong with them (shape, dtype, layout or a read-only array).
+A kept plane's field is exported once, straight into its stored form, with the same stored bits ([#346](https://github.com/LupoLab/solprop/issues/346), SEP 47). `MemoryOutput` hands the run the block row the plane will occupy, so the field is written once, where it is kept, with no host volume of its own; `HDF5Output` is handed one new array, which h5py writes into the plane's chunk without a copy. A plane observer and a failure checkpoint at the same plane share that export. On a 108 MiB Cartesian plane the native session's saved plane no longer allocates a field into memory and one fewer into a file, and the driver session's file output converts its observation where it is instead of allocating a second field. `PlaneStore` gains `takes_exports`, `field_destination` and `save_exported` for this, with `solprop.output.records.StoredField` beside them; a store subclass that overrides `save` is still given every plane, with its field, through it. Export destinations are refused by what is wrong with them (shape, dtype, layout or a read-only array).

changelog.d/slurm-scan-blas-idle.changed.md

@@ -0,0 +1,4 @@
+The batch script of a Slurm scan (`solprop.driver.executors.Slurm`) now sets
+`OPENBLAS_THREAD_TIMEOUT=20` unless the job's environment sets it, as the front end's
+Slurm runs already did, so the scan controller's BLAS threads sleep instead of spinning
+between calls.

changelog.d/stat-definition-fields.removed.md

@@ -0,0 +1,6 @@
+`StatDefinition.implemented` is removed: every statistic in `solprop.stats.CATALOGUE`
+is implemented, and the reserved-name refusal it served had no entries. Each
+`StatDefinition` now also says how a statistic is formed and treated (`evaluate`,
+`metric`, `weight`, `profile`, `plasma`, `general`, `advice`), and the name sets such as
+`METRIC_WEIGHTED_STATISTICS` and `GENERAL_MODAL_ACCESSORS` are derived from those
+fields, with unchanged members.

changelog.d/uniform-refusal-wording.changed.md

@@ -0,0 +1,5 @@
+The refusals of a non-positive or non-finite number and of an unknown keyword now read
+the same across the design tools, pulses, gas flow, antiresonant tubes, the TDSE
+specifications and the processing and plotting functions: `<name> must be finite and
+positive, got <value>` and `<name> must be 'a', 'b' or 'c', got <value>`. A numeric
+string given where those functions expect a number is now refused rather than parsed.

docs/api/index.md

@@ -20,7 +20,7 @@ In scripts and library code, import from the home modules listed below.
 
 | module | what it holds |
 |---|---|
-| {mod}`solprop.driver` | the entry points `prop_gnlse`, `prop_capillary`, `prop_waveguide`, `prop_radial`, `prop_free` and `prop_planar`, the `Simulation` object behind them, and `run_problem`, the loop over save planes that takes a translated problem, a constructed backend, an output handler and a `Start` (`solprop.backends.session.Start.entrance(problem)` for a fresh run), which the run loads into the backend, for a batch runner of your own |
+| {mod}`solprop.driver` | the entry points `prop_gnlse`, `prop_capillary`, `prop_waveguide`, `prop_free` and `prop_planar`, the `Simulation` object behind them, and `run_problem`, the loop over save planes that takes a translated problem, a constructed backend, an output handler and a `Start` (`solprop.backends.session.Start.entrance(problem)` for a fresh run), which the run loads into the backend, for a batch runner of your own |
 | {mod}`solprop.grid` | time and frequency grids (`FieldGrid`, `EnvelopeGrid`) and the free-space transverse grids (`RadialGrid`, `FreeGrid`, `LineGrid`) |
 | {mod}`solprop.pulses` | initial pulses: `GaussianPulse`, `SechPulse`, `CustomPulse`, `DataPulse`, `TimeDataPulse`, `load_spectrum` (a measured spectrum and phase from a text file), and spatial and planar pulses |
 | {mod}`solprop.profiles` | quantities that vary along z: radius, pressure and temperature profiles such as `PiecewiseLinear` and `PressureGradient` |

docs/auto_tutorials/basics/plot_03_analysing_a_run.codeobj.json

@@ -114,7 +114,7 @@
   {
    "is_class": true,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.records",
    "module_short": "solprop.output",
    "name": "GridRecord.from_grid"
   },
@@ -135,8 +135,8 @@
   {
    "is_class": false,
    "is_explicit": false,
-   "module": "solprop.output.schema.GridRecord",
-   "module_short": "solprop.output.schema.GridRecord",
+   "module": "solprop.output.records.GridRecord",
+   "module_short": "solprop.output.records.GridRecord",
    "name": "from_grid"
   }
  ],
@@ -174,7 +174,7 @@
   {
    "is_class": true,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.store",
    "module_short": "solprop.output",
    "name": "PlaneStore"
   },
@@ -248,7 +248,7 @@
   {
    "is_class": true,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.metadata",
    "module_short": "solprop.output",
    "name": "RunMetadata"
   },
@@ -283,7 +283,7 @@
   {
    "is_class": false,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.metadata",
    "module_short": "solprop.output",
    "name": "RunMetadata"
   }
@@ -292,7 +292,7 @@
   {
    "is_class": true,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.records",
    "module_short": "solprop.output",
    "name": "SavedPlane"
   },
@@ -327,7 +327,7 @@
   {
    "is_class": false,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.records",
    "module_short": "solprop.output",
    "name": "SavedPlane"
   }
@@ -336,7 +336,7 @@
   {
    "is_class": true,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.records",
    "module_short": "solprop.output",
    "name": "StepperRecord"
   },
@@ -357,7 +357,7 @@
   {
    "is_class": false,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.records",
    "module_short": "solprop.output",
    "name": "StepperRecord"
   }
@@ -1130,7 +1130,7 @@
   {
    "is_class": false,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.metadata",
    "module_short": "solprop.output",
    "name": "RunMetadata"
   },
@@ -1290,7 +1290,7 @@
   {
    "is_class": false,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.records",
    "module_short": "solprop.output",
    "name": "SavedPlane"
   },
@@ -1469,7 +1469,7 @@
   {
    "is_class": false,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.store",
    "module_short": "solprop.output",
    "name": "PlaneStore.n_saved"
   },
@@ -1534,7 +1534,7 @@
   {
    "is_class": false,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.store",
    "module_short": "solprop.output",
    "name": "PlaneStore.open"
   },
@@ -1599,7 +1599,7 @@
   {
    "is_class": false,
    "is_explicit": false,
-   "module": "solprop.output.schema",
+   "module": "solprop.output.store",
    "module_short": "solprop.output",
    "name": "PlaneStore.save"
   },
@@ -1664,8 +1664,8 @@
   {
    "is_class": false,
    "is_explicit": false,
-   "module": "solprop.output.schema",
-   "module_short": "solprop.output.schema",
+   "module": "solprop.output.store",
+   "module_short": "solprop.output.store",
    "name": "PlaneStore.to_file"
   },
   {

docs/auto_tutorials/basics/plot_03_analysing_a_run.ipynb

@@ -22,7 +22,7 @@
       },
       "outputs": [],
       "source": [
-        "import matplotlib.pyplot as plt\nimport numpy as np\n\nfrom solprop.grid import EnvelopeGrid\nfrom solprop.output import MemoryOutput, open_file\nfrom solprop.output.schema import GridRecord, RunMetadata, SavedPlane, StepperRecord\nfrom solprop.plotting import plot_energy, plot_stats, prop_2d, spec_1d, time_1d\nfrom solprop.processing import energy as pulse_energy\nfrom solprop.processing import (\n    fwhm_t,\n    get_power,\n    get_spectral_density,\n    grid_of,\n    time_bandwidth,\n)\nfrom solprop.pulses import GaussianPulse\nfrom solprop.stats import collect, default_spec\n\nLENGTH = 0.2\nFWHM = 30e-15\n\ngrid = EnvelopeGrid.from_limits(LENGTH, 800e-9, (400e-9, 2e-6), 1e-12)\nseed = GaussianPulse(wavelength=800e-9, fwhm=FWHM, energy=1e-6).build(grid)\n\n# Chosen so that the pulse ends four times longer than it started: the closed form is\n# tau(z) = tau0 sqrt(1 + (beta2 z / tau0^2)^2) with tau0 the 1/e half-width of the\n# field.\ntau0 = FWHM / (2 * np.sqrt(np.log(2)))\nbeta2 = np.sqrt(15) * tau0**2 / LENGTH\n\nmetadata = RunMetadata(\n    grid=GridRecord.from_grid(grid),\n    modes=(),\n    simulation_kind=\"mode_averaged\",\n    configuration={\"beta2\": beta2},\n    stepper=StepperRecord(tableau=\"DOPRI5\", controller={\"rtol\": 1e-8}),\n)\nspec = default_spec(\"mode_averaged\")\n\nrun = MemoryOutput()\nrun.open(metadata)\nfor z in np.linspace(0.0, LENGTH, 25):\n    # The internal linear operator of a purely dispersive co-moving frame.\n    field = seed * np.exp(-0.5j * beta2 * (grid.omega - grid.omega0) ** 2 * z)\n    plane = SavedPlane(z=float(z), field=field)\n    run.save(SavedPlane(z=float(z), field=field, stats=collect(spec, grid, plane)))\n\nprint(f\"{run.n_saved} planes on a {grid.kind} grid of {grid.n_omega} bins\")"
+        "import matplotlib.pyplot as plt\nimport numpy as np\n\nfrom solprop.grid import EnvelopeGrid\nfrom solprop.output import MemoryOutput, open_file\nfrom solprop.output.metadata import RunMetadata\nfrom solprop.output.records import GridRecord, SavedPlane, StepperRecord\nfrom solprop.plotting import plot_energy, plot_stats, prop_2d, spec_1d, time_1d\nfrom solprop.processing import energy as pulse_energy\nfrom solprop.processing import (\n    fwhm_t,\n    get_power,\n    get_spectral_density,\n    grid_of,\n    time_bandwidth,\n)\nfrom solprop.pulses import GaussianPulse\nfrom solprop.stats import collect, default_spec\n\nLENGTH = 0.2\nFWHM = 30e-15\n\ngrid = EnvelopeGrid.from_limits(LENGTH, 800e-9, (400e-9, 2e-6), 1e-12)\nseed = GaussianPulse(wavelength=800e-9, fwhm=FWHM, energy=1e-6).build(grid)\n\n# Chosen so that the pulse ends four times longer than it started: the closed form is\n# tau(z) = tau0 sqrt(1 + (beta2 z / tau0^2)^2) with tau0 the 1/e half-width of the\n# field.\ntau0 = FWHM / (2 * np.sqrt(np.log(2)))\nbeta2 = np.sqrt(15) * tau0**2 / LENGTH\n\nmetadata = RunMetadata(\n    grid=GridRecord.from_grid(grid),\n    modes=(),\n    simulation_kind=\"mode_averaged\",\n    configuration={\"beta2\": beta2},\n    stepper=StepperRecord(tableau=\"DOPRI5\", controller={\"rtol\": 1e-8}),\n)\nspec = default_spec(\"mode_averaged\")\n\nrun = MemoryOutput()\nrun.open(metadata)\nfor z in np.linspace(0.0, LENGTH, 25):\n    # The internal linear operator of a purely dispersive co-moving frame.\n    field = seed * np.exp(-0.5j * beta2 * (grid.omega - grid.omega0) ** 2 * z)\n    plane = SavedPlane(z=float(z), field=field)\n    run.save(SavedPlane(z=float(z), field=field, stats=collect(spec, grid, plane)))\n\nprint(f\"{run.n_saved} planes on a {grid.kind} grid of {grid.n_omega} bins\")"
       ]
     },
     {
@@ -175,7 +175,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.14.6"
+      "version": "3.14.5"
     }
   },
   "nbformat": 4,

docs/auto_tutorials/basics/plot_03_analysing_a_run.py

@@ -24,7 +24,8 @@
 
 from solprop.grid import EnvelopeGrid
 from solprop.output import MemoryOutput, open_file
-from solprop.output.schema import GridRecord, RunMetadata, SavedPlane, StepperRecord
+from solprop.output.metadata import RunMetadata
+from solprop.output.records import GridRecord, SavedPlane, StepperRecord
 from solprop.plotting import plot_energy, plot_stats, prop_2d, spec_1d, time_1d
 from solprop.processing import energy as pulse_energy
 from solprop.processing import (

docs/auto_tutorials/basics/plot_03_analysing_a_run.py.md5

@@ -1 +1 @@
-60732f8be8b9362299269d446bd6469d
+0ffc306efd8b5ce01792284a72c37578