netket

Machine learning algorithms for many-body quantum systems

https://github.com/netket/netket

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    15 of 71 committers (21.1%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (18.8%) to scientific vocabulary

Keywords

deep-learning hamiltonian jax machine-learning markov-chain-monte-carlo monte-carlo-methods neural-networks physics-simulation quantum quantum-state-tomography unitaryhack variational-method variational-monte-carlo

Keywords from Contributors

distributed quantum-circuit quantum-computing jit mpi parallel-computing xla interactive quantum-information parallel
Last synced: 4 months ago · JSON representation ·

Repository

Machine learning algorithms for many-body quantum systems

Basic Info
  • Host: GitHub
  • Owner: netket
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Homepage: https://www.netket.org
  • Size: 65.3 MB
Statistics
  • Stars: 622
  • Watchers: 24
  • Forks: 203
  • Open Issues: 101
  • Releases: 82
Topics
deep-learning hamiltonian jax machine-learning markov-chain-monte-carlo monte-carlo-methods neural-networks physics-simulation quantum quantum-state-tomography unitaryhack variational-method variational-monte-carlo
Created over 7 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

logo

NetKet

Powered by NumFOCUS Release Paper (v3) codecov Slack

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 is an affiliated project to numFOCUS.

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.

Getting Started

To get started with NetKet, we recommend you give a look at our tutorials page, by running them on your computer or on Google Colaboratory. 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

License

Apache License 2.0

Owner

  • Name: NetKet
  • Login: netket
  • Kind: organization

Open-source project for the development of machine intelligence for many-body quantum systems.

Citation (CITATIONS.bib)

@misc{netket3:2021,
    title={NetKet 3: Machine Learning Toolbox for Many-Body Quantum Systems},
    author={Filippo Vicentini and Damian Hofmann and Attila Szabó and Dian Wu and Christopher Roth
        and Clemens Giuliani and Gabriel Pescia and Jannes Nys and Vladimir Vargas-Calderon
        and Nikita Astrakhantsev and Giuseppe Carleo},
    year={2021},
    eprint={2112.10526},
    archivePrefix={arXiv},
    primaryClass={quant-ph},
    url={https://arxiv.org/abs/2112.10526}
}

@article{netket2:2019,
    author    = {Carleo, Giuseppe and Choo, Kenny and Hofmann, Damian and
        Smith, James E.~T. and Westerhout, Tom and Alet, Fabien and
        Davis, Emily J. and Efthymiou, Stavros and Glasser, Ivan and
        Lin, Sheng-Hsuan and Mauri, Marta and Mazzola, Guglielmo and
        Mendl, Christian B. and van Nieuwenburg, Evert and
        O'Reilly, Ossian and Th{\'e}veniaut, Hugo and Torlai, Giacomo and Vicentini, Filippo and
        Wietek, Alexander},
    title     = {NetKet: A Machine Learning Toolkit for Many-Body Quantum Systems},
    journal   = {SoftwareX},
    pages     = {100311},
    doi       = {10.1016/j.softx.2019.100311},
    url       = {http://www.sciencedirect.com/science/article/pii/S2352711019300974},
    year      = 2019
}

GitHub Events

Total
  • Fork event: 15
  • Create event: 38
  • Commit comment event: 4
  • Release event: 13
  • Issues event: 41
  • Watch event: 70
  • Delete event: 30
  • Member event: 1
  • Issue comment event: 360
  • Push event: 200
  • Pull request review comment event: 147
  • Pull request review event: 147
  • Pull request event: 164
Last Year
  • Fork event: 15
  • Create event: 38
  • Commit comment event: 4
  • Release event: 13
  • Issues event: 41
  • Watch event: 70
  • Delete event: 30
  • Member event: 1
  • Issue comment event: 360
  • Push event: 200
  • Pull request review comment event: 147
  • Pull request review event: 147
  • Pull request event: 164

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 2,804
  • Total Committers: 71
  • Avg Commits per committer: 39.493
  • Development Distribution Score (DDS): 0.714
Past Year
  • Commits: 203
  • Committers: 17
  • Avg Commits per committer: 11.941
  • Development Distribution Score (DDS): 0.33
Top Committers
Name Email Commits
Filippo Vicentini f****i@g****m 801
Giuseppe Carleo 2****o 589
Damian Hofmann d****n@m****e 346
Tom Westerhout t****t@s****l 219
kenny_choo k****o@u****h 129
jamesETsmith j****5@c****u 59
Damian Hofmann f****t 55
dependabot[bot] 4****] 53
Dian Wu d****u@e****h 46
Evert van Nieuwenburg e****g@g****m 41
chrisrothUT c****h@u****u 38
ShHsLin s****n@t****e 36
Clemens Giuliani c****s@i****t 36
Vladimir Vargas v****c@u****o 34
Attila Szabó 3****o 29
gtorlai g****i@u****a 26
Marta Mauri m****a@M****l 25
Jannes Nys j****s@g****m 25
chrisrothUT 6****T 21
Nikita Astrakhantsev n****t@g****m 20
guglielmo g****y@d****h 16
stavros11 3****1 14
Tom t****a@u****e 14
alet a****t@i****r 11
Vladimir Vargas-Calderón 3****O 9
Gabriel Pescia 7****a 8
Emily Jane Davis e****d@s****u 8
Chen Ao a****n@s****h 8
Giuseppe Carleo g****o@c****g 7
ooreilly o****y@u****u 7
and 41 more...

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 127
  • Total pull requests: 665
  • Average time to close issues: 11 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 47
  • Total pull request authors: 39
  • Average comments per issue: 2.73
  • Average comments per pull request: 2.55
  • Merged pull requests: 478
  • Bot issues: 0
  • Bot pull requests: 77
Past Year
  • Issues: 33
  • Pull requests: 104
  • Average time to close issues: 27 days
  • Average time to close pull requests: 5 days
  • Issue authors: 21
  • Pull request authors: 23
  • Average comments per issue: 1.15
  • Average comments per pull request: 2.25
  • Merged pull requests: 59
  • Bot issues: 0
  • Bot pull requests: 9
Top Authors
Issue Authors
  • PhilipVinc (48)
  • jwnys (9)
  • attila-i-szabo (7)
  • gcarleo (6)
  • dsmic (3)
  • macekmar (3)
  • Gautameshwar (3)
  • lindamauron (3)
  • MarcMachaczek (3)
  • Chihiro1099 (2)
  • Rose-max111 (2)
  • VolodyaCO (2)
  • chrisrothUT (2)
  • abukva (1)
  • MandMarc (1)
Pull Request Authors
  • PhilipVinc (348)
  • dependabot[bot] (77)
  • inailuig (55)
  • jwnys (22)
  • wdphy16 (21)
  • gcarleo (19)
  • alleSini99 (18)
  • attila-i-szabo (17)
  • lindamauron (9)
  • VolodyaCO (8)
  • chrisrothUT (6)
  • lgravina1997 (6)
  • macekmar (6)
  • Z-Denis (5)
  • vigsterkr (5)
Top Labels
Issue Labels
enhancement (25) bug (20) contributor welcome (16) help wanted (8) fermions (4) good first issue (4) docs (3) fix proposed (2) error checking (2) unitaryhack-bounty (1) v3.0 (1) Jax (1) question (1) forget-me-not (1)
Pull Request Labels
dependencies (77) codex (5) enhancement (3) python (3) bug (2)

Packages

  • Total packages: 4
  • Total downloads:
    • pypi 3,876 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 5
    (may contain duplicates)
  • Total versions: 163
  • Total maintainers: 3
pypi.org: netket

Netket : Machine Learning toolbox for many-body quantum systems.

  • Versions: 86
  • Dependent Packages: 0
  • Dependent Repositories: 5
  • Downloads: 3,876 Last month
  • Docker Downloads: 0
Rankings
Docker downloads count: 2.3%
Average: 6.4%
Dependent repos count: 6.7%
Downloads: 6.8%
Dependent packages count: 10.0%
Maintainers (2)
Last synced: 4 months ago
proxy.golang.org: github.com/netket/netket
  • Versions: 47
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 6.5%
Average: 6.7%
Dependent repos count: 6.9%
Last synced: 4 months ago
spack.io: py-netket

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.

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Forks count: 8.4%
Stargazers count: 10.7%
Average: 19.1%
Dependent packages count: 57.3%
Maintainers (1)
Last synced: 4 months ago
conda-forge.org: netket

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 C++ primitives.

  • Versions: 23
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 13.8%
Stargazers count: 17.8%
Average: 29.2%
Dependent repos count: 34.0%
Dependent packages count: 51.2%
Last synced: 4 months ago

Dependencies

.github/workflows/CI.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
  • mpi4py/setup-mpi v1 composite
.github/workflows/formatting_check.yml actions
  • actions/checkout v3 composite
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
  • actions/setup-python v2 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • flax >=0.6, <0.7
  • igraph >=0.9.8, <0.11.0
  • jax >=0.3.16, <0.5
  • jaxlib >=0.3.15, <0.5
  • numba >=0.52, <0.57
  • numba4jax >=0.0.10, <0.1
  • numpy ~=1.20
  • optax >=0.1.3, <0.2
  • orjson >=3.4, <4
  • plum-dispatch >=1.5.1, <2
  • scipy >=1.5.3, <2
  • tqdm >=4.60, <5