Fast Euclid equivariant operations for JAX
Project description
🌐 e3j
Euclid-equivariant operations and harmonic polynomials for JAX.
This library is a fast and full-featured Euclidean equivariance backend which can be used in place of e3nn and e3x to replace slow operations in Machine Learned Interatomic Potentials (MLIPs) with carefully optimized and open-source CUDA and Pallas kernels for GPU and TPU.
The equivariance backend of our MLIP library is e3j as of mlip 0.2.0.
Note:
e3jis currently in pre-release, with version 0.1.0 planned for early June 2026. Additional CUDA kernels and dedicated Pallas kernels for TPU will be rolled out progressively.
Installation
Pulling from PyPI
The e3j package is available on PyPI.
It consists of a thin JAX-based Python API which can run on CPU, GPU and TPU, supporting Python versions from 3.11 to 3.14 included.
For efficiency on GPU, our CUDA binaries are bundled as the e3j_ops
package on PyPI. The compatible version of the binaries should
be pulled by requiring the "e3j[ops]" extra:
# requirements.txt
e3j[ops] >= 0.1.0b0
jax[cuda13_local] ~= 0.8.0
See JAX installation instructions for more information on JAX versions and their CUDA support. We recommend using a version of JAX above 0.7.0 and CUDA 13.
Building from source
Our dependencies are managed with uv. After cloning the repository, you can build from source by running run one of:
# Existing CUDA 13 install with `e3j_ops` kernels:
uv sync --group cuda13_local --extra ops
# Install CUDA 13 via pip and the `exp` group for benchmarks:
uv sync --group cuda13 --extra ops
The Python build internally relies on CMake, scikit-build and pybind11. You can also look at the Makefile for alternate recipes to build kernels, C++ tests and the Python bindings.
The e3j_ops Python package only contains our CUDA binaries and bindings to their associated XLA handlers. It is not meant to be used as standalone until its ABI is reported stable.
Project structure
The JAX primitives wrapping our custom XLA handlers are defined in the e3j.ops subpackage of e3j, provided the e3j_ops binaries can be found in the environment.
- src/e3j : Python source
- core : Non-parameterized equivariant operations
- linen : Parameterized equivariant operations as flax.linen.Module instances
- ops : JAX primitives and AD rules around the XLA-FFI bindings of e3j_ops
- tests : Python test suite, based on pytest
- test_ops : XLA-FFI bindings tests marked with
"e3j_ops"
- test_ops : XLA-FFI bindings tests marked with
- Makefile : build recipes for CUDA/C++ objects and tests
- lib/e3j_ops : CUDA/C++ source for the
e3j_opssubpackage- cuda : custom kernel implementations
- ffi : XLA and Python binding boilerplate
- tests : pure C++ tests for CUDA kernels
- CMakeLists.txt : holistic build recipe for pyproject.toml integration with scikit-build
Contributing
Although it is too early for e3j to accept significant external contributions, bug reports or questions are very welcome via GitHub issues and discussions.
Citing
If you use e3j within your work, we kindly ask you to cite the following preprint:
@article{Peltre26-e3j,
title = {{E3J}: an Efficient and Open-Source Euclidean Equivariance Backend},
author = {Peltre, Olivier and Picard, Armand and Pichard, Adrien and Giacomoni, Luca and Braganca, Miguel and Heyraud, Valentin and Brunken, Christoph and Tilly, Jules},
journal = {preprint},
year = {2026},
url = {(preprint)}
}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file e3j-0.1.0b2.tar.gz.
File metadata
- Download URL: e3j-0.1.0b2.tar.gz
- Upload date:
- Size: 444.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
470fb8bc463f74bb603adab991d0bcdf89dff4ff255117a4c8e092b66bbf0db2
|
|
| MD5 |
7ef6f584104382e0eb32e0283c5d3cfe
|
|
| BLAKE2b-256 |
246a65a4fb39ae0c86b9d05ff29c87c253702cd604f5813c71023048f0dec3ef
|
File details
Details for the file e3j-0.1.0b2-py3-none-any.whl.
File metadata
- Download URL: e3j-0.1.0b2-py3-none-any.whl
- Upload date:
- Size: 79.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
953459c02f5d7c9bf49f648f6183e8530ffd51f157c01628f1faf3ec676e6278
|
|
| MD5 |
f6accd72c30361846d23e2d4d783dbed
|
|
| BLAKE2b-256 |
659590e7995b7795e0a44e9691f31e18c0d6ad9b5805af72fb94d60d9a7493c9
|