filter_functions 1.2.0__tar.gz

filter_functions-1.2.0/.github/workflows/main.yml

@@ -0,0 +1,80 @@
+name: Main
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    name: Run tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python_version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        install_extras: ['tests', 'plotting,fancy_progressbar,tests', 'plotting,bloch_sphere_visualization,fancy_progressbar,doc,tests']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python_version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python_version }}
+        cache: pip
+        check-latest: true
+
+    - name: Install
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install hatch .[${{ matrix.install_extras }}]
+
+    - name: Test with pytest
+      run: |
+        python -m pytest
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        name: ${{ matrix.python }} - ${{ matrix.install_extras }}
+        env_vars: OS,PYTHON
+        fail_ci_if_error: false
+        token: ${{ secrets.CODECOV_TOKEN }} # required
+        verbose: true
+    - name: Upload test results to Codecov
+      if: ${{ !cancelled() }}
+      uses: codecov/test-results-action@v1
+      with:
+        name: ${{ matrix.python }} - ${{ matrix.install_extras }}
+        token: ${{ secrets.CODECOV_TOKEN }}
+
+
+  release:
+    name: Publish to PyPi
+    runs-on: ubuntu-latest
+    needs: test
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+        cache: pip
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install hatch
+
+    - name: Build package
+      run: |
+        python -m hatch build
+
+    - name: Publish package
+      env:
+        HATCH_INDEX_USER: __token__
+        HATCH_INDEX_AUTH: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        python -m hatch publish

filter_functions-1.2.0/.readthedocs.yml

@@ -0,0 +1,26 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: mambaforge-latest
+
+conda:
+  environment: environment.yml
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+         - doc
+         - plotting
+         - bloch_sphere_visualization
+
+sphinx:
+  builder: html
+  configuration: doc/source/conf.py
+
+formats:
+  - pdf
+  - epub

filter_functions-1.2.0/CITATION.cff

@@ -0,0 +1,101 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: >-
+  filter_functions
+message: >-
+  If this software has benefited your research, please 
+  consider citing it as below.
+type: software
+doi: 10.5281/zenodo.4575000
+authors:
+  - given-names: Tobias
+    family-names: Hangleiter
+    email: tobias.hangleiter@rwth-aachen.de
+    affiliation: >-
+      JARA-FIT Institute for Quantum Information,
+      Forschungszentrum Jülich GmbH and RWTH Aachen
+      University, 52074 Aachen, Germany
+    orcid: 'https://orcid.org/0000-0002-5177-6162'
+  - given-names: Isabel
+    family-names: Nha Minh Le
+    email: isabel.le@rwth-aachen.de
+    affiliation: >-
+      JARA-FIT Institute for Quantum Information,
+      Forschungszentrum Jülich GmbH and RWTH Aachen
+      University, 52074 Aachen, Germany
+    orcid: 'https://orcid.org/0000-0001-6707-044X'
+  - given-names: Julian D.
+    family-names: Teske
+    email: julian.teske@rwth-aachen.de
+    affiliation: >-
+      JARA-FIT Institute for Quantum Information,
+      Forschungszentrum Jülich GmbH and RWTH Aachen
+      University, 52074 Aachen, Germany
+    orcid: 'https://orcid.org/0000-0002-7590-7876'
+preferred-citation:
+  type: article
+  authors:
+  - given-names: Tobias
+    family-names: Hangleiter
+    email: tobias.hangleiter@rwth-aachen.de
+    affiliation: >-
+      JARA-FIT Institute for Quantum Information,
+      Forschungszentrum Jülich GmbH and RWTH Aachen
+      University, 52074 Aachen, Germany
+    orcid: 'https://orcid.org/0000-0002-5177-6162'
+  - given-names: Pascal
+    family-names: Cerfontaine
+    email: pascal.cerfontaine@rwth-aachen.de
+    affiliation: >-
+      JARA-FIT Institute for Quantum Information,
+      Forschungszentrum Jülich GmbH and RWTH Aachen
+      University, 52074 Aachen, Germany
+    orcid: 'https://orcid.org/0000-0002-8227-4018'
+  - given-names: Hendrik
+    family-names: Bluhm
+    email: bluhm@physik.rwth-aachen.de
+    affiliation: >-
+      JARA-FIT Institute for Quantum Information,
+      Forschungszentrum Jülich GmbH and RWTH Aachen
+      University, 52074 Aachen, Germany
+    orcid: 'https://orcid.org/0000-0002-5224-7254'
+  doi: 10.1103/PhysRevResearch.3.043047
+  journal: Physical Review Research
+  month: 10
+  year: 2021
+  start: 043047
+  title: >-
+    Filter-function formalism and software package 
+    to compute quantum processes of gate sequences 
+    for classical non-Markovian noise
+  issue: 4
+  volume: 3
+identifiers:
+  - type: doi
+    value: 10.1103/PhysRevResearch.3.043047
+    description: >-
+      Article on the formalism and software
+      implementation
+  - type: doi
+    value: 10.5281/zenodo.4575000
+    description: Zenodo DOI for the software package
+  - type: doi
+    value: 10.1103/PhysRevLett.127.170403
+    description: Letter introducing parts of the formalism
+  - type: doi
+    value: 10.1103/PhysRevApplied.17.024006
+    description: Article on analytic derivatives
+repository-code: 'https://github.com/qutech/filter_functions'
+url: >-
+  https://www.quantuminfo.physik.rwth-aachen.de/cms/Quantuminfo/Forschung/Quantum-Technology-Group/~zcsx/code/lidx/1/
+keywords:
+  - python
+  - physics
+  - quantum computing
+  - quantum information
+  - qutip
+  - filter functions
+  - quantum control
+license: GPL-3.0

filter_functions-1.2.0/CONTRIBUTING.md

@@ -0,0 +1,6 @@
+# Contributing to this project
+## Licensing strategy
+
+We are committed to make our research software available to other researchers with minimal limitations and hope to motivate some to help improving it. However, economic and strategic interests are becoming increasingly influential in the field of quantum computing. We have therefore [chosen the copyleft GPL license](LICENSE) to prevent an uncontrolled incorporation in proprietary software packages. However, to facilitate a potential future use in a commercial context, we would like to retain the possibility to offer the software packages developed under our lead under a different license. As this requires control of the copyright, we may ask contributors to execute a copyright assignment agreement. Following common practice, this agreement will license back all relevant rights of contributors regarding their contributions. We feel that this is a fair arrangement at least for minor contributions.
+
+We hope that this strategy will not be a barrier to using the software at hand or to contributing to its advancement. If it does, please do not hesitate to contact us to consider alternative approaches.