squlearn 0.1.0__tar.gz → 0.3.0__tar.gz

squlearn-0.3.0/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[squlearn@gmail.com](mailto:squlearn@gmail.com).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

squlearn-0.1.0/README.md → squlearn-0.3.0/.github/CONTRIBUTING.md

@@ -1,83 +1,48 @@
-# sQUlearn 0.1.0
-
-<span style="color:red;font-size:20px">Note that this is an early access version! Not everything that is described is already working 100%.</span>
-
-## Prerequisites
-
-The package requires **at least Python 3.9**.
-## Installation
-
-### Stable Release
-
-To install the stable release version of sQUlearn, run the following command:
-```bash
-pip install squlearn
-```
-
-Alternatively, you can install sQUlearn directly from GitHub via
-```bash
-pip install git+ssh://git@github.com:sQUlearn/squlearn.git
-```
-
-## Examples
-There are several more elaborate examples available in the folder ``./examples`` which display the features of this package.
-Tutorials for beginners can be found at ``./examples/tutorials``.
-
-## Contribution
-If you plan to contribute to this project, please read this section carefully and check that your contribution fits the desired process and style.
-
-### Install development version
-To contribute to sQUlearn install the package from the source code:
-
-```bash
-git clone https://github.com/sQUlearn/squlearn.git && cd squlearn
-pip install -e .
-```
-
-### Devtools
-Install the recommended tools with
-```bash
-pip install -r requirements_dev.txt
-```
-
-### Style Guide
-#### Code Style
-We try to match all of our python code closely to the [PEP8 style guide](https://pep8.org/) with the exception of using a line length of `99`. To ensure this we use the [Black formater](https://black.readthedocs.io/en/stable/index.html) with the configuration specified in [pyproject.toml](https://github.com/sQUlearn/squlearn/blob/main/pyproject.toml). To format your code, run
-```bash
-black path/to/folder/or/file.py
-```
-from the top level directory to ensure the use of the `pyproject.toml` configuration file.
-
-We don't enforce but highly encourage the use of the [pylint linter](https://docs.pylint.org/) to check newly written code and adapt accordingly. To run the linter with the desired configuration run
-```bash
-pylint path/to/folder/or/file.py
-```
-from the top level directory to again ensure the use of the `pyproject.toml` configuration file. Running pylint before and after the contribution shouldn't add violations and/or lower the overall code score.
-
-#### Docstrings
-We furthermore desire to use the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) for our Docstrings. Generally we at least expect
- - A one-line summary, terminated by a period, and
- - a description of the class/method.
-
-For classes we furthermore expect
- - A list of attributes.
-
-For methods we furthermore expect
- - A list of arguments, and
- - A list of return values.
-
-### Git Flow
-We use the Git Flow branch structure specified [here](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) except for release branches.
-
----
-
-## License
-
-[Apache License 2.0](https://github.com/sQUlearn/squlearn/blob/main/LICENSE.txt)
-
-## Imprint
-This project is maintained by the quantum computing group at the Fraunhofer Institute for Manufacturing Engineering and Automation IPA. It started as a collection of implementations of quantum machine learning methods.
-
-https://www.ipa.fraunhofer.de/en/expertise/cyber-cognitive-intelligence-cci/quantencomputing.html
-
----
+# Contributing
+If you plan to contribute to this project, please read this section carefully and check that your contribution fits the desired process and style.
+
+## Install development version
+To contribute to sQUlearn install the package from the source code:
+
+```bash
+git clone https://github.com/sQUlearn/squlearn.git && cd squlearn
+git checkout develop
+pip install -e .
+```
+
+> Note that editable installing as above might require an updated version of pip `pip install pip --upgrade` 
+
+## Devtools
+Install the recommended tools with
+```bash
+pip install -e .[dev]
+```
+
+## Style Guide
+### Code Style
+We try to match all of our python code closely to the [PEP8 style guide](https://pep8.org/) with the exception of using a line length of `99`. To ensure this we use the [Black formater](https://black.readthedocs.io/en/stable/index.html) with the configuration specified in [pyproject.toml](https://github.com/sQUlearn/squlearn/blob/main/pyproject.toml). To format your code, run
+```bash
+black path/to/folder/or/file.py
+```
+from the top level directory to ensure the use of the `pyproject.toml` configuration file.
+
+We don't enforce but highly encourage the use of the [pylint linter](https://docs.pylint.org/) to check newly written code and adapt accordingly. To run the linter with the desired configuration run
+```bash
+pylint path/to/folder/or/file.py
+```
+from the top level directory to again ensure the use of the `pyproject.toml` configuration file. Running pylint before and after the contribution shouldn't add violations and/or lower the overall code score.
+
+### Docstrings
+We furthermore desire to use the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) for our Docstrings. Generally we at least expect
+ - A one-line summary, terminated by a period, and
+ - a description of the class/method.
+
+For classes we furthermore expect
+ - A list of attributes.
+
+For methods we furthermore expect
+ - A list of arguments, and
+ - A list of return values.
+
+## Git Flow
+We use the Git Flow branch structure specified [here](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) except for release branches.

squlearn-0.3.0/.github/workflows/doc_checks.yml

@@ -0,0 +1,18 @@
+name: Documentation check
+on:
+- pull_request
+
+jobs:
+  doc_checks:
+    runs-on: ubuntu-latest
+
+    steps:
+        - name: Cancel Workflow Action
+          uses: styfle/cancel-workflow-action@0.11.0
+
+        - uses: actions/checkout@v2
+        - uses: sQUlearn/sphinx-action@master
+          with:
+            docs-folder: "docs/"
+            pre-build-command: "pip3 install ."
+            build-command: "sphinx-build -b html . _build -W --keep-going"

squlearn-0.3.0/.github/workflows/format.yml

@@ -0,0 +1,27 @@
+name: Formatting check
+on:
+- pull_request
+
+jobs:
+  black:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Cancel Workflow Action
+        uses: styfle/cancel-workflow-action@0.11.0
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Install dependencies
+        run: pip install black[jupyter]
+
+      - uses: actions/checkout@v2
+
+      - name: Run Black
+        run: |
+          black -l 99 src --check
+          black -l 99 tests --check
+          black -l 99 --ipynb examples --check

squlearn-0.3.0/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish to PyPI
+on:
+  release:
+    types: [published]
+
+jobs:
+    pypi-publish:
+      name: Upload release to PyPI
+      runs-on: ubuntu-latest
+      environment:
+        name: release
+        url: https://pypi.org/p/squlearn
+      permissions:
+        id-token: write
+      steps:
+        - name: Set up Python
+          uses: actions/setup-python@v2
+          with:
+            python-version: 3.9
+
+        - name: Install dependencies
+          run: pip install flit
+
+        - uses: actions/checkout@v2
+        
+        - name: Build
+          run: flit build
+
+        - name: Publish package distributions to PyPI
+          uses: pypa/gh-action-pypi-publish@release/v1

squlearn-0.3.0/.github/workflows/publish_docs.yml

@@ -0,0 +1,37 @@
+name: Publish to GH Pages
+on:
+  release:
+    types: [published]
+
+jobs:
+    publish-pages:
+      name: Publish to GH Pages
+      runs-on: ubuntu-latest
+      steps:
+          - name: Checkout Source Code
+            uses: actions/checkout@v2
+          - name: Checkout GH Pages
+            uses: actions/checkout@v2
+            with:
+              repository: sQUlearn/squlearn.github.io
+              path: "docs/_build"
+              token: ${{ secrets.GITHUB_TOKEN }}
+          - name: Build Docs
+            uses: sQUlearn/sphinx-action@master
+            with:
+              docs-folder: "docs/"
+              pre-build-command: "pip3 install ."
+              build-command: "sphinx-build -b html . _build -W"
+          - name: Commit Files
+            run: |
+              cd docs/_build
+              git config --global user.email "github-actions[bot]@users.noreply.github.com"
+              git config --global user.name "github-actions[bot]"
+              git add .
+              git commit -m "update documentation ${{ github.event.release.tag_name }}"
+              git tag -a "${{ github.event.release.tag_name }}" -m "${{ github.event.release.name}}"
+          - name: Push Changes
+            uses: ad-m/github-push-action@master
+            with:
+              directory: docs/_build
+              repository: sQUlearn/squlearn.github.io

squlearn-0.3.0/.gitignore

@@ -0,0 +1,168 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/modules/generated/*
+docs/examples/images
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# VSCode
+.vscode/
+
+#Example logs
+examples/qnn/*_log.csv