localgeom 0.1.0__tar.gz

localgeom-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

localgeom-0.1.0/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: localgeom
+Version: 0.1.0
+Summary: A JAX-based framework for differential geometry computations on Riemannian manifolds
+Author-email: EddieCunningham <edmondcunnin@umass.edu>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/EddieCunningham/local_coordinates
+Project-URL: Repository, https://github.com/EddieCunningham/local_coordinates
+Keywords: jax,differential-geometry,riemannian,manifold,curvature,geodesic
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jax>=0.4.20
+Requires-Dist: jaxlib>=0.4.20
+Requires-Dist: equinox>=0.11.0
+Requires-Dist: jaxtyping>=0.2.20
+Requires-Dist: plum-dispatch>=2.0.0
+Requires-Dist: diffrax>=0.5.0
+Requires-Dist: einops>=0.7.0
+Requires-Dist: matplotlib>=3.8.0
+Provides-Extra: test
+Requires-Dist: pytest>=8.3.5; extra == "test"
+Dynamic: license-file
+
+# local_coordinates
+
+A JAX-based framework for differential geometry computations on Riemannian manifolds.
+
+## Overview
+
+The `local_coordinates` library provides a type-safe, coordinate-aware system for performing differential geometry computations. It leverages JAX's automatic differentiation to compute not just gradients, but also Hessians, enabling second-order geometric computations like curvature tensors and geodesics.
+
+**Key use cases:**
+
+- Computing Riemannian metrics and their properties
+- Calculating curvature tensors (Riemann, Ricci, scalar)
+- Working with coordinate transformations and pullback metrics
+- Computing geodesics via exponential and logarithmic maps
+- Transforming to Riemann normal coordinates
+
+## Features
+
+- **Jets**: Second-order automatic differentiation storing value, gradient, and Hessian
+- **Riemannian Metrics**: Define metrics, compute inner products, raise and lower indices
+- **Connections**: Levi-Civita connection and Christoffel symbols
+- **Curvature**: Riemann curvature tensor, Ricci tensor, and scalar curvature
+- **Coordinate Transformations**: Pullback metrics under coordinate changes
+- **Normal Coordinates**: Transform to Riemann normal coordinates where the metric is locally Euclidean
+- **Geodesics**: Exponential and logarithmic maps via Taylor approximation or ODE integration
+
+## Installation
+
+### Using uv (recommended)
+
+```bash
+uv sync
+```
+
+### Using pip
+
+```bash
+pip install -e .
+```
+
+### Requirements
+
+- Python 3.12+
+- JAX and jaxlib
+- Equinox
+- jaxtyping
+- diffrax (for ODE-based geodesic computation)
+
+## Quick Start
+
+```python
+import jax
+import jax.numpy as jnp
+from jax import Array
+from local_coordinates.jet import Jet, function_to_jet
+from local_coordinates.basis import BasisVectors, get_standard_basis
+from local_coordinates.metric import RiemannianMetric
+from local_coordinates.connection import Connection, get_levi_civita_connection
+from local_coordinates.riemann import (
+    RiemannCurvatureTensor,
+    RicciTensor,
+    get_riemann_curvature_tensor,
+    get_ricci_tensor,
+)
+
+# Define a position-dependent metric
+def metric_components(x: Array) -> Array:
+    return jnp.array([
+        [1 + 0.1*x[0]**2, 0.0],
+        [0.0, 1 + 0.1*x[1]**2]
+    ])
+
+# Create the metric at a point
+p: Array = jnp.array([1.0, 1.0])
+basis: BasisVectors = get_standard_basis(p)
+metric_jet: Jet = function_to_jet(metric_components, p)
+metric: RiemannianMetric = RiemannianMetric(basis=basis, components=metric_jet)
+
+# Compute geometric quantities
+connection: Connection = get_levi_civita_connection(metric)
+riemann: RiemannCurvatureTensor = get_riemann_curvature_tensor(connection)
+ricci: RicciTensor = get_ricci_tensor(connection, R=riemann)
+
+# Scalar curvature
+g_inv: Array = jnp.linalg.inv(metric.components.value)
+scalar_curvature: Array = jnp.einsum("ij,ij->", g_inv, ricci.components.value)
+
+print(f"Metric at p:\n{metric.components.value}")
+print(f"Scalar curvature: {scalar_curvature}")
+```
+
+## Library Architecture
+
+```
+local_coordinates/
+├── jet.py              # Jets: second-order Taylor data (value, gradient, hessian)
+├── jacobian.py         # Jacobians for coordinate transformations
+├── basis.py            # BasisVectors: tangent space bases
+├── frame.py            # Frame: basis vectors with Lie brackets
+├── tangent.py          # TangentVector: vectors in tangent spaces
+├── tensor.py           # Tensor: generic (k,l) tensors
+├── metric.py           # RiemannianMetric: inner products on tangent spaces
+├── connection.py       # Connection: Christoffel symbols, covariant derivatives
+├── riemann.py          # RiemannCurvatureTensor and RicciTensor
+├── normal_coords.py    # Riemann normal coordinates
+└── exponential_map.py  # Exponential and logarithmic maps
+```
+
+## Documentation
+
+For comprehensive documentation with examples, see [TUTORIAL.md](TUTORIAL.md).
+
+AI assistant skills for task-specific guidance are available in `.cursor/skills/`:
+
+| Skill | Description |
+|-------|-------------|
+| **create-riemannian-metric** | Create RiemannianMetric objects from metric functions |
+| **compute-curvature** | Compute Levi-Civita connection, Riemann tensor, Ricci tensor |
+| **pullback-metric** | Compute pullback metrics under coordinate transformations |
+| **riemann-normal-coordinates** | Transform objects to Riemann normal coordinates |
+| **compute-geodesics** | Compute geodesics via exponential/logarithmic maps |
+| **jet-differentiation** | Use Jets for second-order automatic differentiation |
+
+## Important Conventions
+
+### Column-Vector Convention
+
+The library uses the column-vector convention throughout:
+
+- Basis vectors are stored as columns of matrices
+- `E[:, j]` represents the j-th basis vector
+- `E[a, j]` is the a-th component of the j-th basis vector
+
+### Index Conventions
+
+- Christoffel symbols: `Gamma[i, j, k]` = Γ^k\_ij
+- Riemann tensor: `R[i, j, k, m]` = R^m\_ijk
+- Tensors use 1-based indexing for raise/lower operations
+
+## License
+
+See [LICENSE](LICENSE) for details.

localgeom-0.1.0/README.md

@@ -0,0 +1,142 @@
+# local_coordinates
+
+A JAX-based framework for differential geometry computations on Riemannian manifolds.
+
+## Overview
+
+The `local_coordinates` library provides a type-safe, coordinate-aware system for performing differential geometry computations. It leverages JAX's automatic differentiation to compute not just gradients, but also Hessians, enabling second-order geometric computations like curvature tensors and geodesics.
+
+**Key use cases:**
+
+- Computing Riemannian metrics and their properties
+- Calculating curvature tensors (Riemann, Ricci, scalar)
+- Working with coordinate transformations and pullback metrics
+- Computing geodesics via exponential and logarithmic maps
+- Transforming to Riemann normal coordinates
+
+## Features
+
+- **Jets**: Second-order automatic differentiation storing value, gradient, and Hessian
+- **Riemannian Metrics**: Define metrics, compute inner products, raise and lower indices
+- **Connections**: Levi-Civita connection and Christoffel symbols
+- **Curvature**: Riemann curvature tensor, Ricci tensor, and scalar curvature
+- **Coordinate Transformations**: Pullback metrics under coordinate changes
+- **Normal Coordinates**: Transform to Riemann normal coordinates where the metric is locally Euclidean
+- **Geodesics**: Exponential and logarithmic maps via Taylor approximation or ODE integration
+
+## Installation
+
+### Using uv (recommended)
+
+```bash
+uv sync
+```
+
+### Using pip
+
+```bash
+pip install -e .
+```
+
+### Requirements
+
+- Python 3.12+
+- JAX and jaxlib
+- Equinox
+- jaxtyping
+- diffrax (for ODE-based geodesic computation)
+
+## Quick Start
+
+```python
+import jax
+import jax.numpy as jnp
+from jax import Array
+from local_coordinates.jet import Jet, function_to_jet
+from local_coordinates.basis import BasisVectors, get_standard_basis
+from local_coordinates.metric import RiemannianMetric
+from local_coordinates.connection import Connection, get_levi_civita_connection
+from local_coordinates.riemann import (
+    RiemannCurvatureTensor,
+    RicciTensor,
+    get_riemann_curvature_tensor,
+    get_ricci_tensor,
+)
+
+# Define a position-dependent metric
+def metric_components(x: Array) -> Array:
+    return jnp.array([
+        [1 + 0.1*x[0]**2, 0.0],
+        [0.0, 1 + 0.1*x[1]**2]
+    ])
+
+# Create the metric at a point
+p: Array = jnp.array([1.0, 1.0])
+basis: BasisVectors = get_standard_basis(p)
+metric_jet: Jet = function_to_jet(metric_components, p)
+metric: RiemannianMetric = RiemannianMetric(basis=basis, components=metric_jet)
+
+# Compute geometric quantities
+connection: Connection = get_levi_civita_connection(metric)
+riemann: RiemannCurvatureTensor = get_riemann_curvature_tensor(connection)
+ricci: RicciTensor = get_ricci_tensor(connection, R=riemann)
+
+# Scalar curvature
+g_inv: Array = jnp.linalg.inv(metric.components.value)
+scalar_curvature: Array = jnp.einsum("ij,ij->", g_inv, ricci.components.value)
+
+print(f"Metric at p:\n{metric.components.value}")
+print(f"Scalar curvature: {scalar_curvature}")
+```
+
+## Library Architecture
+
+```
+local_coordinates/
+├── jet.py              # Jets: second-order Taylor data (value, gradient, hessian)
+├── jacobian.py         # Jacobians for coordinate transformations
+├── basis.py            # BasisVectors: tangent space bases
+├── frame.py            # Frame: basis vectors with Lie brackets
+├── tangent.py          # TangentVector: vectors in tangent spaces
+├── tensor.py           # Tensor: generic (k,l) tensors
+├── metric.py           # RiemannianMetric: inner products on tangent spaces
+├── connection.py       # Connection: Christoffel symbols, covariant derivatives
+├── riemann.py          # RiemannCurvatureTensor and RicciTensor
+├── normal_coords.py    # Riemann normal coordinates
+└── exponential_map.py  # Exponential and logarithmic maps
+```
+
+## Documentation
+
+For comprehensive documentation with examples, see [TUTORIAL.md](TUTORIAL.md).
+
+AI assistant skills for task-specific guidance are available in `.cursor/skills/`:
+
+| Skill | Description |
+|-------|-------------|
+| **create-riemannian-metric** | Create RiemannianMetric objects from metric functions |
+| **compute-curvature** | Compute Levi-Civita connection, Riemann tensor, Ricci tensor |
+| **pullback-metric** | Compute pullback metrics under coordinate transformations |
+| **riemann-normal-coordinates** | Transform objects to Riemann normal coordinates |
+| **compute-geodesics** | Compute geodesics via exponential/logarithmic maps |
+| **jet-differentiation** | Use Jets for second-order automatic differentiation |
+
+## Important Conventions
+
+### Column-Vector Convention
+
+The library uses the column-vector convention throughout:
+
+- Basis vectors are stored as columns of matrices
+- `E[:, j]` represents the j-th basis vector
+- `E[a, j]` is the a-th component of the j-th basis vector
+
+### Index Conventions
+
+- Christoffel symbols: `Gamma[i, j, k]` = Γ^k\_ij
+- Riemann tensor: `R[i, j, k, m]` = R^m\_ijk
+- Tensors use 1-based indexing for raise/lower operations
+
+## License
+
+See [LICENSE](LICENSE) for details.

localgeom-0.1.0/local_coordinates/__init__.py

@@ -0,0 +1,19 @@
+"""local_coordinates: differential geometry computations on Riemannian manifolds."""
+
+__version__ = "0.1.0"
+
+from local_coordinates.base import AbstractBatchableObject, auto_vmap
+from local_coordinates.jet import Jet, function_to_jet, jet_decorator
+from local_coordinates.jacobian import Jacobian
+from local_coordinates.basis import BasisVectors, get_standard_basis
+from local_coordinates.tangent import TangentVector
+from local_coordinates.tensor import Tensor, TensorType
+from local_coordinates.frame import Frame
+from local_coordinates.metric import RiemannianMetric
+from local_coordinates.connection import Connection, get_levi_civita_connection
+from local_coordinates.riemann import (
+  RiemannCurvatureTensor,
+  RicciTensor,
+  get_riemann_curvature_tensor,
+  get_ricci_tensor,
+)

localgeom-0.1.0/local_coordinates/base.py

@@ -0,0 +1,99 @@
+import jax.numpy as jnp
+from typing import Tuple, Union, Any
+import equinox as eqx
+from jaxtyping import PyTree
+from functools import wraps
+import abc
+import jax.tree_util as jtu
+
+__all__ = ["AbstractBatchableObject", "auto_vmap"]
+
+
+def auto_vmap(f):
+  """Decorator that automatically vectorizes methods of AbstractBatchableObject.
+
+  Applies JAX's vmap to methods of objects inheriting from
+  AbstractBatchableObject, handling batched operations without explicit
+  vectorization code. It checks if the object is batched and, if so,
+  applies vmap to the method call.
+
+  Args:
+    f: The method to be vectorized
+
+  Returns:
+    A wrapped function that automatically handles batched inputs
+
+  Example:
+    ```python
+    class MyObject(AbstractBatchableObject):
+      @auto_vmap
+      def compute(self, x):
+        ...
+    ```
+  """
+  @wraps(f)
+  def f_wrapper(self, *args, **kwargs):
+    if self.batch_size:
+      if isinstance(self.batch_size, tuple):
+        axis_size = self.batch_size[0]
+      else:
+        axis_size = self.batch_size
+
+      def get_in_axis(arg):
+        if eqx.is_array(arg):
+          return 0 if arg.ndim > 0 and arg.shape[0] == axis_size else None
+        return None
+
+      in_axes_self = jtu.tree_map(get_in_axis, self)
+      in_axes_args = jtu.tree_map(get_in_axis, args)
+      in_axes_kwargs = jtu.tree_map(get_in_axis, kwargs)
+
+      return eqx.filter_vmap(
+        lambda s, a, k: f_wrapper(s, *a, **k),
+        in_axes=(in_axes_self, in_axes_args, in_axes_kwargs)
+      )(self, args, kwargs)
+    return f(self, *args, **kwargs)
+  return f_wrapper
+
+
+class AbstractBatchableObject(eqx.Module, abc.ABC):
+  """Base class for objects that support batched operations.
+
+  Provides a consistent interface for handling batched computations,
+  including properties and methods to query batch dimensions and
+  perform batch operations. Objects can be treated independently or
+  as batches with the same API, enabling efficient vectorized
+  operations through JAX's vmap.
+  """
+
+  @property
+  @abc.abstractmethod
+  def batch_size(self) -> Union[Tuple[int], int, None]:
+    """Get the batch dimensions of this object.
+
+    Returns:
+      A tuple of the leading dimensions if batched multiple times,
+      an int if batched along a single dimension,
+      or None if not batched.
+    """
+    pass
+
+  @classmethod
+  def zeros_like(cls, other: "AbstractBatchableObject") -> "AbstractBatchableObject":
+    """Create a new instance with the same structure but all arrays zeroed."""
+    params, static = eqx.partition(other, eqx.is_array)
+    zero_params = jtu.tree_map(lambda x: jnp.zeros_like(x), params)
+    return eqx.combine(zero_params, static)
+
+  @property
+  def shape(self) -> PyTree:
+    """Get the shapes of all array parameters in this object."""
+    params, static = eqx.partition(self, eqx.is_array)
+    shapes = jtu.tree_map(lambda x: x.shape, params)
+    return shapes
+
+  def __getitem__(self, idx: Any):
+    """Extract a slice or subset of this batched object."""
+    params, static = eqx.partition(self, eqx.is_array)
+    sliced_params = jtu.tree_map(lambda x: x[idx], params)
+    return eqx.combine(sliced_params, static)