-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #256 from neutrinoceros/api/mv_types.py
API: clearly define public/private APIs
- Loading branch information
Showing
7 changed files
with
179 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,16 @@ | ||
| """gpgi: Fast particle deposition at post-processing time.""" | ||
|
|
||
| from importlib.util import find_spec | ||
| from typing import Any, Literal, cast | ||
|
|
||
| from ._typing import FieldMap, GridDict, ParticleSetDict | ||
| from .types import Dataset, Geometry, Grid, ParticleSet | ||
| from ._data_types import Dataset, Geometry, Grid, ParticleSet | ||
| from ._load import load | ||
|
|
||
| _IS_PY_LIB = find_spec("gpgi._lib").origin.endswith(".py") # type: ignore [union-attr] | ||
|
|
||
|
|
||
| def load( | ||
| *, | ||
| geometry: Literal["cartesian", "polar", "cylindrical", "spherical", "equatorial"], | ||
| grid: GridDict, | ||
| particles: ParticleSetDict | None = None, | ||
| metadata: dict[str, Any] | None = None, | ||
| ) -> Dataset: | ||
| r""" | ||
| Load a Dataset. | ||
| Parameters | ||
| ---------- | ||
| geometry: Literal["cartesian", "polar", "cylindrical", "spherical", "equatorial"] | ||
| This flag is used for validation of axis names, order and domain limits. | ||
| grid: dict[str, FieldMap] | ||
| A dictionary representing the grid coordinates as 1D arrays of cell left edges, | ||
| and on-grid fields as ND arrays (fields are assumed to be defined on cell | ||
| centers) | ||
| __all__ = [ | ||
| "load", | ||
| "Dataset", | ||
| "Geometry", | ||
| "Grid", | ||
| "ParticleSet", | ||
| ] | ||
|
|
||
| particles: dict[str, FieldMap] (optional) | ||
| A dictionary representing particle coordinates and associated fields as 1D | ||
| arrays | ||
| metadata: dict[str, Any] (optional) | ||
| A dictionary representing arbitrary additional data, that will be attached to | ||
| the returned Dataset as an attribute (namely, ds.metadata). This special | ||
| attribute is accessible from boundary condition methods as the argument of the | ||
| same name. | ||
| """ | ||
| try: | ||
| _geometry = Geometry(geometry) | ||
| except ValueError: | ||
| raise ValueError( | ||
| f"unknown geometry {geometry!r}, expected any of {tuple(_.value for _ in Geometry)}" | ||
| ) from None | ||
|
|
||
| if "cell_edges" not in grid: | ||
| raise ValueError("grid dictionary missing required key 'cell_edges'") | ||
| _grid = Grid( | ||
| _geometry, | ||
| cell_edges=cast(FieldMap, grid["cell_edges"]), | ||
| fields=grid.get("fields"), | ||
| ) | ||
|
|
||
| _particles: ParticleSet | None = None | ||
| if particles is not None: | ||
| if "coordinates" not in particles: | ||
| raise ValueError("particles dictionary missing required key 'coordinates'") | ||
| _particles = ParticleSet( | ||
| _geometry, | ||
| coordinates=cast(FieldMap, particles["coordinates"]), | ||
| fields=particles.get("fields"), | ||
| ) | ||
|
|
||
| return Dataset( | ||
| geometry=_geometry, grid=_grid, particles=_particles, metadata=metadata | ||
| ) | ||
| _IS_PY_LIB = find_spec("gpgi._lib").origin.endswith(".py") # type: ignore [union-attr] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from typing import TYPE_CHECKING, cast | ||
|
|
||
| from gpgi._data_types import Dataset, Geometry, Grid, ParticleSet | ||
| from gpgi._typing import FieldMap | ||
|
|
||
| if TYPE_CHECKING: | ||
| from typing import Any, Literal | ||
|
|
||
| from gpgi._typing import GridDict, ParticleSetDict | ||
|
|
||
|
|
||
| def load( | ||
| *, | ||
| geometry: Literal["cartesian", "polar", "cylindrical", "spherical", "equatorial"], | ||
| grid: GridDict, | ||
| particles: ParticleSetDict | None = None, | ||
| metadata: dict[str, Any] | None = None, | ||
| ) -> Dataset: | ||
| r""" | ||
| Load a Dataset. | ||
| Parameters | ||
| ---------- | ||
| geometry: Literal["cartesian", "polar", "cylindrical", "spherical", "equatorial"] | ||
| This flag is used for validation of axis names, order and domain limits. | ||
| grid: dict[str, FieldMap] | ||
| A dictionary representing the grid coordinates as 1D arrays of cell left edges, | ||
| and on-grid fields as ND arrays (fields are assumed to be defined on cell | ||
| centers) | ||
| particles: dict[str, FieldMap] (optional) | ||
| A dictionary representing particle coordinates and associated fields as 1D | ||
| arrays | ||
| metadata: dict[str, Any] (optional) | ||
| A dictionary representing arbitrary additional data, that will be attached to | ||
| the returned Dataset as an attribute (namely, ds.metadata). This special | ||
| attribute is accessible from boundary condition methods as the argument of the | ||
| same name. | ||
| """ | ||
| try: | ||
| _geometry = Geometry(geometry) | ||
| except ValueError: | ||
| raise ValueError( | ||
| f"unknown geometry {geometry!r}, expected any of {tuple(_.value for _ in Geometry)}" | ||
| ) from None | ||
|
|
||
| if "cell_edges" not in grid: | ||
| raise ValueError("grid dictionary missing required key 'cell_edges'") | ||
| _grid = Grid( | ||
| geometry=_geometry, | ||
| cell_edges=cast(FieldMap, grid["cell_edges"]), | ||
| fields=grid.get("fields"), | ||
| ) | ||
|
|
||
| _particles: ParticleSet | None = None | ||
| if particles is not None: | ||
| if "coordinates" not in particles: | ||
| raise ValueError("particles dictionary missing required key 'coordinates'") | ||
| _particles = ParticleSet( | ||
| geometry=_geometry, | ||
| coordinates=cast(FieldMap, particles["coordinates"]), | ||
| fields=particles.get("fields"), | ||
| ) | ||
|
|
||
| return Dataset( | ||
| geometry=_geometry, grid=_grid, particles=_particles, metadata=metadata | ||
| ) |
Oops, something went wrong.