Metadata-Version: 2.4
Name: NetKet
Version: 3.19.2
Summary: Netket : Machine Learning toolbox for many-body quantum systems.
Project-URL: homepage, https://www.netket.org
Project-URL: documentation, https://netket.readthedocs.io/en/latest/#
Project-URL: repository, https://github.com/netket/netket
Project-URL: changelog, https://netket.readthedocs.io/en/latest/docs/changelog.html
Author: Giuseppe Carleo, Filippo Vicentini, The NetKet authors
License: Apache 2.0
License-File: LICENSE
Keywords: Jax,Machine Learning,Monte Carlo,Neural Networks,Neural Quantum States,Quantum
Classifier: Development Status :: 5 - Production/Stable
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: einops>=0.8.1
Requires-Dist: equinox>=0.11.3
Requires-Dist: flax>=0.10.2
Requires-Dist: igraph>=0.10.0
Requires-Dist: jax<0.6,>=0.4.35
Requires-Dist: numba>=0.59
Requires-Dist: numpy<3.0,>=1.20
Requires-Dist: optax<0.3,>=0.2.2
Requires-Dist: orjson<4,>=3.4
Requires-Dist: plum-dispatch>=2.4
Requires-Dist: rich>=12.0
Requires-Dist: scipy<2,>=1.5.3
Requires-Dist: sparse>=0.12.0
Requires-Dist: tqdm<5,>=4.60
Provides-Extra: cuda
Requires-Dist: jax[cuda12]; (sys_platform == 'linux') and extra == 'cuda'
Provides-Extra: dev
Requires-Dist: black==25.1.0; extra == 'dev'
Requires-Dist: build>=1; extra == 'dev'
Requires-Dist: coverage>=5; extra == 'dev'
Requires-Dist: matplotlib>=3; extra == 'dev'
Requires-Dist: networkx>=2.4; extra == 'dev'
Requires-Dist: pre-commit>=2.7; extra == 'dev'
Requires-Dist: pytest-cov>=2.10.1; extra == 'dev'
Requires-Dist: pytest-json-report>=1.3; extra == 'dev'
Requires-Dist: pytest-xdist[psutil]>=2; extra == 'dev'
Requires-Dist: pytest>=6; extra == 'dev'
Requires-Dist: qutip>=5; extra == 'dev'
Requires-Dist: ruff==0.12.2; extra == 'dev'
Requires-Dist: wheel>=0.38.1; extra == 'dev'
Provides-Extra: docs
Requires-Dist: ipywidgets>=8.1.7; extra == 'docs'
Requires-Dist: myst-nb<1.4,>=1.0; extra == 'docs'
Requires-Dist: myst-parser<4.1.0,>=2.0.0; extra == 'docs'
Requires-Dist: nbconvert>=7.16.6; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints<4.0,>=1.22; extra == 'docs'
Requires-Dist: sphinx-book-theme~=1.1.0; extra == 'docs'
Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'docs'
Requires-Dist: sphinx-design>=0.4.0; extra == 'docs'
Requires-Dist: sphinxcontrib-fulltoc~=1.2.0; extra == 'docs'
Requires-Dist: sphinxcontrib-jsmath~=1.0.1; extra == 'docs'
Requires-Dist: sphinx~=8.2.3; extra == 'docs'
Provides-Extra: extra
Requires-Dist: h5py>=3.7.0; extra == 'extra'
Requires-Dist: openfermion>=1.0.0; extra == 'extra'
Requires-Dist: qutip>=4; extra == 'extra'
Requires-Dist: tensorboardx>=2.0.0; extra == 'extra'
Provides-Extra: pyscf
Requires-Dist: pyscf>=2.0; extra == 'pyscf'
Description-Content-Type: text/markdown

<div align="center">
<img src="https://www.netket.org/logo/logo_simple.jpg" alt="logo" width="400"></img>
</div>

# __NetKet__

[![Powered by NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org)
[![Release](https://img.shields.io/github/release/netket/netket.svg)](https://github.com/netket/netket/releases)
[![Paper (v3)](https://img.shields.io/badge/paper%20%28v3%29-arXiv%3A2112.10526-B31B1B)](https://scipost.org/SciPostPhysCodeb.7/pdf)
[![codecov](https://codecov.io/gh/netket/netket/branch/master/graph/badge.svg?token=gzcOlpO5lB)](https://codecov.io/gh/netket/netket)
[![Slack](https://img.shields.io/badge/slack-chat-green.svg)](https://join.slack.com/t/mlquantum/shared_invite/zt-19wibmfdv-LLRI6i43wrLev6oQX0OfOw)

NetKet is an open-source project delivering cutting-edge methods for the study of many-body quantum systems with artificial neural networks and machine learning techniques.
It is a Python library built on [JAX](https://github.com/google/jax).

NetKet is an affiliated project to [numFOCUS](https://numfocus.org).

- **Homepage:** <https://www.netket.org>
- **Citing:** <https://www.netket.org/cite/>
- **Documentation:** <https://netket.readthedocs.io/en/latest/index.html>
- **Tutorials:** <https://netket.readthedocs.io/en/latest/tutorials/gs-ising.html>
- **Examples:** <https://github.com/netket/netket/tree/master/Examples>
- **Source code:** <https://github.com/netket/netket>

## Installation and Usage

NetKet runs on MacOS and Linux and requires Python 3.11 or later. We recommend installing NetKet using `pip` or `uv`. **Do not use conda** as JAX has known issues when installed through conda.

```sh
pip install --upgrade pip
pip install netket
```

**With GPU support (Linux only):**
```sh
pip install 'netket[cuda]'
```

**Development version:**
```sh
pip install git+https://github.com/netket/netket.git
```

For detailed installation instructions including GPU setup, see our [installation guide](https://netket.readthedocs.io/en/latest/install.html).

## Getting Started

To get started with NetKet, we recommend you give a look at our [tutorials page](https://netket.readthedocs.io/en/latest/tutorials/gs-ising.html), by running them on your computer or on [Google Colaboratory](https://colab.research.google.com).
There are also many example scripts that you can download, run and edit that showcase some use-cases of NetKet, although they are not commented.

If you want to get in touch with us, feel free to open an issue or a discussion here on GitHub, or to join the MLQuantum slack group where several people involved with NetKet hang out. To join the slack channel just accept [this invitation](https://join.slack.com/t/mlquantum/shared_invite/zt-19wibmfdv-LLRI6i43wrLev6oQX0OfOw)

## License

[Apache License 2.0](https://github.com/netket/netket/blob/master/LICENSE)
