mpnum

mpnum: A matrix product representation library for Python - Published in JOSS (2017)

https://github.com/dsuess/mpnum

Science Score: 49.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
    Links to: arxiv.org, joss.theoj.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.7%) to scientific vocabulary

Keywords

dmrg matrix-product tensor-train
Last synced: 6 months ago · JSON representation

Repository

Matrix Product Representation library for Python

Basic Info
  • Host: GitHub
  • Owner: dsuess
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: master
  • Size: 1.86 MB
Statistics
  • Stars: 55
  • Watchers: 5
  • Forks: 18
  • Open Issues: 12
  • Releases: 7
Topics
dmrg matrix-product tensor-train
Created almost 10 years ago · Last pushed over 3 years ago
Metadata Files
Readme Changelog License

README.md

mpnum

A matrix product representation library for Python

JOSS PyPI Travis Documentation Status Coverage Status Maintainability

mpnum is a flexible, user-friendly, and expandable toolbox for the matrix product state/tensor train tensor format. mpnum provides:

  • support for well-known matrix product representations, such as:
    • matrix product states (MPS), also known as tensor trains (TT)
    • matrix product operators (MPO)
    • local purification matrix product states (PMPS)
    • arbitrary matrix product arrays (MPA)
  • arithmetic operations: addition, multiplication, contraction etc.
  • compression, canonical forms, etc.
  • finding extremal eigenvalues and eigenvectors of MPOs (DMRG)
  • flexible tools for new matrix product algorithms

To install the latest stable version run

pip install mpnum

If you want to install mpnum from source, please run (on Unix)

git clone https://github.com/dseuss/mpnum.git
cd mpnum
pip install .

In order to run the tests and build the documentation, you have to install the development dependencies via

pip install -r requirements.txt

For more information, see:

Required packages:

  • six, numpy, scipy

Supported Python versions:

  • 2.7, 3.4, 3.5, 3.6

Alternatives:

How to contribute

Contributions of any kind are very welcome. Please use the issue tracker for bug reports. If you want to contribute code, please see the section on how to contribute in the documentation.

Contributors

License

Distributed under the terms of the BSD 3-Clause License (see LICENSE).

Citations

If you use mpnum for yor paper, please cite:

Suess, Daniel and Milan Holzäpfel (2017). mpnum: A matrix product representation library for Python. Journal of Open Source Software, 2(20), 465, https://doi.org/10.21105/joss.00465

mpnum has been used and cited in the following publications:

Owner

  • Name: Daniel Suess
  • Login: dsuess
  • Kind: user
  • Location: Sydney
  • Company: @Nearmap

Matmuls all the way down

GitHub Events

Total
  • Issues event: 2
  • Watch event: 1
Last Year
  • Issues event: 2
  • Watch event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 759
  • Total Committers: 2
  • Avg Commits per committer: 379.5
  • Development Distribution Score (DDS): 0.437
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Milan Holzaepfel m****l@m****e 427
Daniel Suess d****l@d****e 332
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 32
  • Total pull requests: 24
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 5 hours
  • Total issue authors: 8
  • Total pull request authors: 3
  • Average comments per issue: 1.59
  • Average comments per pull request: 1.29
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • dsuess (16)
  • milan-hl (9)
  • gharib85 (2)
  • NicolaLorenzoni (1)
  • ishdhand (1)
  • dbsi-pinkman (1)
  • mattorourke17 (1)
  • scy-v (1)
Pull Request Authors
  • dsuess (19)
  • milan-hl (4)
  • MoritzLange (1)
Top Labels
Issue Labels
enhancement (8) bug (5) question (1)
Pull Request Labels
enhancement (1)

Dependencies

requirements.txt pypi
  • NumPy >=1.5.1
  • PyTest >=3.0.1
  • SciPy >=0.15
  • h5py >=2.4
  • nbsphinx >=0.2
  • pytest-benchmark >=3
  • pytest-runner >=2.11
  • six >=1.0
  • sphinx >=1.6
  • sphinx_rtd_theme >=0.2.5b2
setup.py pypi
  • NumPy >=1.5.1
  • SciPy >=0.15
  • six >=1.0