https://github.com/krivenko/pycommute

Python bindings for libcommute
https://github.com/krivenko/pycommute

algebra exact-diagonalization many-body-physics physics python quantum

Last synced: 4 months ago
JSON representation

Python bindings for libcommute

• Host: GitHub
• URL: https://github.com/krivenko/pycommute
• Owner: krivenko
• License: mpl-2.0
• Created: 2019-11-01T13:45:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-27T09:17:50.000Z (7 months ago)
• Last Synced: 2024-09-27T14:16:28.716Z (4 months ago)
• Topics: algebra, exact-diagonalization, many-body-physics, physics, python, quantum
• Language: Python
• Homepage: https://krivenko.github.io/pycommute/
• Size: 6.55 MB
• Stars: 7
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Citation: CITATIONS.bib

Awesome Lists containing this project

README

        
![pycommute logo](docs/images/logo.svg)

[![Package on PyPI](https://img.shields.io/pypi/v/pycommute.svg)](

https://pypi.org/project/pycommute)

[![Build and test](https://github.com/krivenko/pycommute/actions/workflows/build-and-test.yml/badge.svg)](

https://github.com/krivenko/pycommute/actions/workflows/build-and-test.yml)

[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-red)](

https://krivenko.github.io/pycommute)

*pycommute* is a Python package providing bindings for the

[libcommute](https://github.com/krivenko/libcommute) quantum operator algerba

library.

You can find a few

[usage examples](https://krivenko.github.io/pycommute/examples.html) and an

[API reference](https://krivenko.github.io/pycommute/reference.html) at

*pycommute*'s [documentation website](https://krivenko.github.io/pycommute/).

Installation from sources

-------------------------

* [Download](https://github.com/krivenko/libcommute/releases) source code of

  *libcommute* 0.6 or newer and optionally

  [install](https://krivenko.github.io/libcommute/installation.html) it.

* Install Python prerequisites:

  - [packaging >= 17.0](https://pypi.org/project/packaging/)

  - [pybind11 >= 2.6.0](https://pypi.org/project/pybind11/)

  - [numpy >= 1.12.0](https://pypi.org/project/numpy/)

* Run the following command in the unpacked source archive of *pycommute*,

```

LIBCOMMUTE_INCLUDEDIR="/include" python setup.py install

```

```` must be either installation or source directory of

*libcommute*.

Automated installation using ``pip``

------------------------------------

```

LIBCOMMUTE_INCLUDEDIR="/include" pip install pycommute

```

Docker images

-------------

Docker images of tagged releases of *pycommute* are available from

[Docker Hub](https://hub.docker.com/repository/docker/ikrivenko/pycommute).

```

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

```

This command will pull the most recent image and launch a

[Jupyter](https://jupyter.org/) notebook server accessible at

[http://127.0.0.1:8888/](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/.