Metadata-Version: 2.4
Name: neuraLQX
Version: 1.0.1
Summary: A high-performance simulations toolkit for loop quantum gravity.
Project-URL: Homepage, https://neuralqx.readthedocs.io
Project-URL: Repository, https://github.com/waleed-sh/neuralqx
Project-URL: Issues, https://github.com/waleed-sh/neuralqx/issues
Project-URL: Documentation, https://neuralqx.readthedocs.io/en/latest/documentation/api/index.html
Project-URL: Changelog, https://neuralqx.readthedocs.io/en/latest/change_log.html
Author-email: Waleed Sherif <waleed.sherif@fau.de>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: Jax,Loop quantum gravity,Machine learning,Netket,Neural Quantum States,Neural networks,Quantum,Variational Monte Carlo
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Requires-Dist: bs4
Requires-Dist: cryptography
Requires-Dist: dash>=2.18.2
Requires-Dist: humanize
Requires-Dist: jax
Requires-Dist: jaxlib
Requires-Dist: matplotlib
Requires-Dist: netket<=3.18.1,>=3.17
Requires-Dist: networkx
Requires-Dist: optax>=0.2.4
Requires-Dist: plotly<=6.0.0,>=5.24.1
Requires-Dist: plum-dispatch
Requires-Dist: psutil
Requires-Dist: tabulate
Provides-Extra: dev
Requires-Dist: black>=26.1.0; extra == 'dev'
Requires-Dist: build>=1.2; extra == 'dev'
Requires-Dist: coverage[toml]>=7.6; extra == 'dev'
Requires-Dist: mypy>=1.11; extra == 'dev'
Requires-Dist: pre-commit>=3.6; extra == 'dev'
Requires-Dist: pytest-cov>=5; extra == 'dev'
Requires-Dist: pytest-json-report>=1.5; extra == 'dev'
Requires-Dist: pytest-xdist[psutil]>=3; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Requires-Dist: wheel>=0.43; extra == 'dev'
Provides-Extra: docs
Requires-Dist: myst-nb<1.4,>=1.2; extra == 'docs'
Requires-Dist: myst-parser<4.1.0,>=2.0.0; extra == 'docs'
Requires-Dist: shibuya==2025.12.19; extra == 'docs'
Requires-Dist: sphinx-autobuild==2025.8.25; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints<4.0,>=1.22; extra == 'docs'
Requires-Dist: sphinx-copybutton==0.5.2; extra == 'docs'
Requires-Dist: sphinx-design>=0.4.0; extra == 'docs'
Requires-Dist: sphinx-rtd-theme~=3.0.0; extra == 'docs'
Requires-Dist: sphinx<9.1.0,>=8.2.3; extra == 'docs'
Provides-Extra: mpi
Requires-Dist: jax==0.5.2; extra == 'mpi'
Requires-Dist: mpi4jax==0.7.1; extra == 'mpi'
Requires-Dist: mpi4py==4.1.0; extra == 'mpi'
Provides-Extra: profile
Requires-Dist: cupy; extra == 'profile'
Requires-Dist: nvidia-ml-py>=12.560.30; extra == 'profile'
Requires-Dist: nvtx>=0.2.5; extra == 'profile'
Requires-Dist: py-cpuinfo>=9.0.0; extra == 'profile'
Requires-Dist: tensorboard-plugin-profile; extra == 'profile'
Requires-Dist: tensorflow; extra == 'profile'
Description-Content-Type: text/markdown

<div align="center">
  <img src="https://github.com/waleed-sh/neuraLQX/blob/1b53438720fd3411dac0e562e5b08fe6ea021162/docs/_static/_logo.png" alt="neuraLQX logo" width="420" />
</div>

<div align="center">

# neuraLQX
**High-performance variational simulations for canonical Loop Quantum Gravity - built on [NetKet](https://www.github.com/netket/netket) & [JAX](https://github.com/jax-ml/jax).**

[![PyPI](https://img.shields.io/pypi/v/neuralqx.svg?cachebust=1)](https://pypi.org/project/neuralqx/)
![Python](https://img.shields.io/badge/python-%3E%3D3.11-blue)
[![License](https://img.shields.io/github/license/waleed-sh/neuraLQX.svg)](https://github.com/waleed-sh/neuraLQX/blob/main/LICENSE)
[![Documentation Status](https://readthedocs.org/projects/neuralqx/badge/?version=latest)](https://neuralqx.readthedocs.io/en/latest/?badge=latest)

</div>

---

neuraLQX is an open-source Python package for variational canonical Loop Quantum Gravity.
It lets you work directly with LQG-native building blocks, graphs, Hilbert spaces, gauge groups, constraints, and projectors,
while leveraging the battle-tested and state of the art variational backend of NetKet.

Under the hood, neuraLQX builds on NetKet and JAX, making fast Monte Carlo methods, automatic differentiation, and scalable optimisation
available in an API that speaks the language of LQG.



## Installation

neuraLQX requires **Python ≥ 3.11**.

### Stable release (PyPI)

```bash
pip install --upgrade neuralqx
```

### From source (editable)

```bash
git clone https://www.github.com/waleed-sh/neuralqx
cd neuralqx
pip install -e .
```

### Optional extras

#### Developer / contributor dependencies

```bash
pip install --upgrade "neuralqx[dev]"
```

#### MPI (local use only, requires an MPI toolchain)

```bash
mpicc --showme:link
pip install --upgrade "neuralqx[mpi]"
```

#### Docs

```bash
pip install --upgrade "neuralqx[docs]"
```

#### Profiling

```bash
pip install --upgrade "neuralqx[profile]"
```

## Getting help & contributing

- **Questions / ideas:** GitHub Discussions  
  https://github.com/waleed-sh/neuraLQX/discussions

- **Bug reports:** GitHub Issues  
  https://github.com/waleed-sh/neuraLQX/issues

- **Contributing:** contributor guide  
  https://neuralqx.readthedocs.io/en/latest/contribute.html


## License

This package is licensed under the [Apache License 2.0](https://github.com/waleed-sh/neuraLQX/blob/main/LICENSE).
