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.
Netket supports MacOS and Linux. We reccomend to install NetKet using
For instructions on how to install the latest stable/beta release of NetKet see the Getting Started section of our website.
If you wish to install the current development version of NetKet, which is the master branch of this GitHub repository, together with the additional dependencies, you can run the following command:
pip install 'git+https://github.com/netket/netket.git#egg=netket[all]'
You can also install the MPI-related dependencies by using
[dev,mpi] between the square brackets.
We recommend to install NetKet with all it's extra dependencies, which are documented below.
However, if you do not have a working MPI compiler in your PATH this installation will most likely fail because
it will attempt to install
mpi4py, which enables MPI support in netket.
The latest release of Netket is not currently available on conda-forge. However, you can still install NetKet with pip inside conda environments.
When installing netket with pip, you can pass the following extra variants as square brakets. You can install several of them by separating them with a comma.
mpi4pyto enable multi-process parallelism. Requires a working MPI compiler in your path
tensorboardxto enable logging to tensorboard.
To enable MPI support you must install mpi4jax. Please note that we advise to install mpi4jax with the same tool (conda or pip) with which you install it's dependency
To check whever MPI support is enabled, check the flags
import netket netket.utils.mpi.available True
Variational Monte Carlo
Neural-Network Quantum State Tomography