Data

Tools

Indexes

Applications

Experiments

Open Source Science

qfunk

Quantum information methods that everybody needs.

https://github.com/simonsupercool/qfunk

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
    1 of 4 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords

quantum-information
Last synced: 7 months ago · JSON representation ·

Repository

Quantum information methods that everybody needs.

Basic Info
  • Host: GitHub
  • Owner: simonsupercool
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 244 KB
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 3
Topics
quantum-information
Created over 5 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

Contributors Forks Stargazers Issues MIT License


Logo

QFUNK

Quantum information methods that everybody needs.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License

About The Project

This package is intended as a central repository for python code pertaining to quantum information science, primarily the subfield of open quantum system dynamics.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

As of the current version, qfunk has only basic dependencies on numpy and scipy. The most recent of these can be downloaded like so sh conda install numpy, scipy

Installation

  1. Clone the repo sh git clone https://github.com/simonsupercool/qfunk.git
  2. CD into directory and install package via local pip command sh pip install qfunk
  3. Run the test suite sh python test.py

If all tests pass then the installation was a success, otherwise please raise an issue that includes the failed test output.

Usage

As a general package for quantum information, most standard linear algebra operations are available in qfunk that pertain to this field. On top of this more specific functionality is available, primarily dealing with quantum optics and open quantum systems. Specific examples of which may be found in the examples folder.

For more examples, please refer to the Documentation

Contributing

This package is intended as a broad repository for quantum information related code. As such any contribution that meets this criteria are welcome. If you wish to contribute:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/HowCouldYouHaveNotDoneThisAlready)
  3. Commit your Changes (git commit -m 'Add some HowCouldYouHaveNotDoneThisAlready')
  4. Push to the Branch (git push origin feature/HowCouldYouHaveNotDoneThisAlready)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Citation (CITATION.cff) 

# YAML 1.2
---
authors: 
  -
    affiliation: IQOQI
    family-names: Milz
    given-names: Simon
    orcid: "https://orcid.org/0000-0002-6987-5513"
  -
    family-names: Morris
    given-names: Joshua
    orcid: "https://orcid.org/0000-0002-1022-7976"
cff-version: "1.1.0"
date-released: 2021-09-24
license: MIT
message: "If you use this software, please cite it as below"
repository-code: "https://github.com/simonsupercool/qfunk"
title: QFunk
version: "1.0"
...

GitHub Events

Total
Last Year

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 53
  • Total Committers: 4
  • Avg Commits per committer: 13.25
  • Development Distribution Score (DDS): 0.491
Top Committers
Name Email Commits
Joshua Morris j****s@u****t 27
riesenohrwombat 4****t@u****m 10
Simon Milz 4****l@u****m 9
simonsupercool s****z@g****m 7
Committer Domains (Top 20 + Academic)
univie.ac.at: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 1
  • Total pull requests: 28
  • Average time to close issues: less than a minute
  • Average time to close pull requests: 9 days
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.04
  • Merged pull requests: 26
  • 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
View more stats
Top Authors
Issue Authors
  • simonsupercool (1)
Pull Request Authors
  • QCmonk (19)
  • simonsupercool (9)
Top Labels
Issue Labels
Pull Request Labels
enhancement (16) tests (7) bug (5) documentation (3)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 11 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
pypi.org: qfunk

quantum information library

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 11 Last month
Rankings
Dependent packages count: 6.6%
Average: 25.0%
Forks count: 30.5%
Dependent repos count: 30.6%
Stargazers count: 32.3%
Maintainers (1)
QCMonk
Last synced: 8 months ago

Dependencies

setup.py pypi