pycommute

Python bindings for libcommute

https://github.com/krivenko/pycommute

Science Score: 57.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
    Found 1 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.8%) to scientific vocabulary

Keywords

algebra exact-diagonalization many-body-physics physics python quantum
Last synced: 4 months ago · JSON representation ·

Repository

Python bindings for libcommute

Basic Info
Statistics
  • Stars: 10
  • Watchers: 2
  • Forks: 3
  • Open Issues: 0
  • Releases: 2
Topics
algebra exact-diagonalization many-body-physics physics python quantum
Created about 6 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.md

pycommute logo

Package on PyPI Build and test Documentation

pycommute is a Python package providing bindings for the libcommute quantum operator algebra library.

You can find a few usage examples and an API reference at pycommute's documentation website.

Installation from sources

LIBCOMMUTE_INCLUDEDIR="<path_to_libcommute>/include" python setup.py install

<path_to_libcommute> must be either installation or source directory of libcommute.

Automated installation using pip

LIBCOMMUTE_INCLUDEDIR="<path_to_libcommute>/include" pip install pycommute

Docker images

Docker images of tagged releases of pycommute are available from Docker Hub.

docker run --rm -p 8888:8888 ikrivenko/pycommute:latest

This command will pull the most recent image and launch a Jupyter notebook server accessible at http://127.0.0.1:8888/. The server is run in a directory with a few interactive example notebooks.

Citing

If you find this package useful for your research, you can help me by citing it using the following BibTeX entry.

@article{pycommute, title = {{libcommute/pycommute: A quantum operator algebra domain-specific language and exact diagonalization toolkit}}, author = {Igor Krivenko}, journal = {SoftwareX}, volume = {17}, pages = {100937}, year = {2022}, issn = {2352-7110}, doi = {10.1016/j.softx.2021.100937} }

License

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Owner

  • Name: Igor Krivenko
  • Login: krivenko
  • Kind: user
  • Location: Hamburg, Germany
  • Company: Universität Hamburg

Citation (CITATIONS.bib)

@article{libcommute_pycommute,
    title = {{libcommute/pycommute: A quantum operator algebra domain-specific
              language and exact diagonalization toolkit}},
    author = {Igor Krivenko},
    journal = {SoftwareX},
    volume = {17},
    pages = {100937},
    year = {2022},
    issn = {2352-7110},
    doi = {10.1016/j.softx.2021.100937}
}

GitHub Events

Total
  • Watch event: 3
  • Delete event: 3
  • Push event: 12
  • Create event: 2
Last Year
  • Watch event: 3
  • Delete event: 3
  • Push event: 12
  • Create event: 2

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 140
  • Total Committers: 1
  • Avg Commits per committer: 140.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 15
  • Committers: 1
  • Avg Commits per committer: 15.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Igor Krivenko i****o@g****m 140

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 7 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 4
  • Total maintainers: 1
pypi.org: pycommute

Python bindings for the libcommute C++ library

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 7 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 16.8%
Stargazers count: 19.3%
Average: 20.9%
Dependent repos count: 21.6%
Downloads: 36.9%
Maintainers (1)
Last synced: 5 months ago

Dependencies

requirements.txt pypi
  • Sphinx >=2.1.0
  • flake8 *
  • myst-parser *
  • networkx *
  • numpy >=1.12.0
  • packaging >=17.0
  • pybind11 >=2.6.0
  • setuptools >=42.0.0
  • sphinx-rtd-theme *
  • tox *
  • wheel *
setup.py pypi
  • numpy >=1.12.0
.github/workflows/build-and-test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/deploy-docs.yml actions
  • JamesIves/github-pages-deploy-action v4 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/publish-on-pypi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/push-to-dockerhub.yml actions
  • docker/build-push-action v2 composite
  • docker/login-action v2 composite
  • docker/setup-buildx-action v2 composite
  • docker/setup-qemu-action v2 composite
  • rlespinasse/github-slug-action v4 composite
Dockerfile docker
  • base latest build
  • ubuntu 20.04 build
pyproject.toml pypi