NetKet
  • Get Started
  • Documentation
  • Tutorials
  • Citing NetKet
  • About
  • Site

    Getting Started!

    In few easy steps

    Make sure you have Python 3.7 or higher installed on Mac or Linux

    If Python 3.7 is not available on your computer, don’t despair! You can use pyenv (the easiest way to install it is with the pyenv installer) to install any Python version, or you can use Anaconda, even though the latter is not recomended if you plan on using MPI.

    Windows is not natively supported because Jax does not yet support it. However, if you use WSL (Windows Subsystem for Linux) NetKet will run smoothly.

    If you plan to use MPI, make sure you have an up to date version of the mpicc compilers available on your path.

    When using MPI, we recommend not to use Anaconda unless it’s for small experimentation on a laptop. This is due to a dependency of netket, mpi4jax. You can read more about the limitations on the mpi4jax documentation.

    pip install --upgrade pip && pip install netket Conda is also supported, but not reccomended. However you can use a conda environment and install netket with pip inside this environment.

    If you are using pip, you should first upgrade it with pip install –upgrade pip to avoid issues with dependencies (any version after pip>=20.3 will be good).

    If you want to use MPI, use pip install netket[mpi].

    If you want to develop netket, extra development dependencies are installed by running pip install netket[all,dev]

    Explore our Tutorials and check out our Examples

    Tutorials are commented python notebooks. Examples are sample python files that can be run. If you want to experiment with mpi, try running some examples with mpirun -np2 python path/to/example.py

    Back to top

    © Copyright 2019-2021, The Netket authors - All rights reserved.
    Created using Sphinx 3.5.4.