Merge pull request #10 from cirKITers/doc

Documentation (MkDocs)

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+### Packaging
+
+Building and packaging requires some extra steps (assuming Poetry):
+- `poetry run devpi use https://ea3a0fbb-599f-4d83-86f1-0e71abe27513.ka.bw-cloud-instance.org`
+- `poetry run devpi login alice --password=456`
+- `poetry run devpi use alice/quantum`
+- `poetry config repositories.quantum https://ea3a0fbb-599f-4d83-86f1-0e71abe27513.ka.bw-cloud-instance.org/lc3267/quantum`
+- `poetry config http-basic.quantum alice 456` (or remove password for interactive prompt)
+- `poetry version (major|minor|patch|premajor|preminor|prepatch)` as explained [here](https://python-poetry.org/docs/cli/#version)
+- `poetry publish --build -r quantum`
+
+### Documentation
+
+For local testing:
+- `mkdocs serve`
+
+For pushing to Github pages:
+- `mkdocs gh-deploy`

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024, Copyright Owner: Ostbayerische Technische Hochschule Regensburg (OTH Regensburg), Karlsruhe Institute of Technology (KIT). Author: Maja Franz (OTH), Melvin Strobl (KIT).  Contact: [email protected], Scientific Computing Center (SCC)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,27 +1,16 @@
 # QML Essentials
 
-This repo contains some of the commonly used Ansaetze and coding stuff required for working with QML and Data-Reuploading models.
-
-## Installation
+[![Pipx Status](https://servers.stroblme.de/api/badge/3/uptime/72?color=%2331c754&labelColor=%233f4850)](https://servers.stroblme.de/status/open) [![Lint and Pytest](https://github.com/cirKITers/qml-essentials/actions/workflows/python-app.yml/badge.svg)](https://github.com/cirKITers/qml-essentials/actions/workflows/python-app.yml) [![Page Build](https://github.com/cirKITers/qml-essentials/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/cirKITers/qml-essentials/actions/workflows/pages/pages-build-deployment)
 
-![Pipx Status](https://servers.stroblme.de/api/badge/3/uptime/72?color=%2331c754&labelColor=%233f4850) [![Lint and Pytest](https://github.com/cirKITers/qml-essentials/actions/workflows/python-app.yml/badge.svg)](https://github.com/cirKITers/qml-essentials/actions/workflows/python-app.yml)
+## :scroll: About
 
-The package is available at [this index](https://ea3a0fbb-599f-4d83-86f1-0e71abe27513.ka.bw-cloud-instance.org/lc3267/quantum).
+This repo contains some of the commonly used Ansaetze and coding stuff required for working with QML and Data-Reuploading models.
+There are also dedicated classes to calculate entanglement and expressiblity of a provided model as well as its Fourier coefficients.
 
-Assuming you have Poetry installed
-- `poetry source add --priority=supplemental quantum https://ea3a0fbb-599f-4d83-86f1-0e71abe27513.ka.bw-cloud-instance.org/lc3267/quantum/+simple/`
-- `poetry add --source quantum qml-essentials`
+## :rocket: Getting Started
 
-With plain pip:
-- `pip install --index-url https://ea3a0fbb-599f-4d83-86f1-0e71abe27513.ka.bw-cloud-instance.org/lc3267/quantum/+simple/ qml-essentials`
+You can find installation instructions and documentation on the corresponding [Github Page](https://cirkiters.github.io/qml-essentials/).
 
-## Contributing
+## :construction: Contributing
 
-Building and packaging requires some extra steps (assuming Poetry):
-- `poetry run devpi use https://ea3a0fbb-599f-4d83-86f1-0e71abe27513.ka.bw-cloud-instance.org`
-- `poetry run devpi login alice --password=456`
-- `poetry run devpi use alice/quantum`
-- `poetry config repositories.quantum https://ea3a0fbb-599f-4d83-86f1-0e71abe27513.ka.bw-cloud-instance.org/lc3267/quantum`
-- `poetry config http-basic.quantum alice 456` (or remove password for interactive prompt)
-- `poetry version (major|minor|patch|premajor|preminor|prepatch)` as explained [here](https://python-poetry.org/docs/cli/#version)
-- `poetry publish --build -r quantum`
+Contributions are very welcome! See [Contribution Guidelines](https://github.com/cirKITers/qml-essentials/blob/main/CONTRIBUTING.md).

docs/index.md

@@ -0,0 +1,19 @@
+[![Pipx Status](https://servers.stroblme.de/api/badge/3/uptime/72?color=%2331c754&labelColor=%233f4850)](https://servers.stroblme.de/status/open) [![Lint and Pytest](https://github.com/cirKITers/qml-essentials/actions/workflows/python-app.yml/badge.svg)](https://github.com/cirKITers/qml-essentials/actions/workflows/python-app.yml) [![Page Build](https://github.com/cirKITers/qml-essentials/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/cirKITers/qml-essentials/actions/workflows/pages/pages-build-deployment)
+
+This repo contains some of the commonly used Ansaetze and coding stuff required for working with QML and Data-Reuploading models.
+There are also dedicated classes to calculate entanglement and expressiblity of a provided model as well as its Fourier coefficients.
+
+## Installation
+
+The package is available at [this index](https://ea3a0fbb-599f-4d83-86f1-0e71abe27513.ka.bw-cloud-instance.org/lc3267/quantum).
+
+There are two installation methods:
+
+### [Poetry](https://python-poetry.org/)
+
+- `poetry source add --priority=supplemental quantum https://ea3a0fbb-599f-4d83-86f1-0e71abe27513.ka.bw-cloud-instance.org/lc3267/quantum/+simple/`
+- `poetry add --source quantum qml-essentials`
+
+### pip
+
+- `pip install --index-url https://ea3a0fbb-599f-4d83-86f1-0e71abe27513.ka.bw-cloud-instance.org/lc3267/quantum/+simple/ qml-essentials`

docs/references.md

@@ -0,0 +1,49 @@
+## Ansaetze
+
+```python
+from qml_essentials.ansaetze import Ansaetze
+```
+
+::: qml_essentials.ansaetze.Ansaetze
+    options:
+      heading_level: 3
+
+## Model
+
+```python
+from qml_essentials.model import Model
+```
+
+::: qml_essentials.model.Model
+    options:
+      heading_level: 3
+
+## Entanglement
+
+```python
+from qml_essentials.entanglement import Entanglement
+```
+
+::: qml_essentials.entanglement.Entanglement
+    options:
+      heading_level: 3
+
+## Expressibility
+
+```python
+from qml_essentials.expressibility import Expressibility
+```
+
+::: qml_essentials.expressibility.Expressibility
+    options:
+      heading_level: 3
+
+## Coefficients
+
+```python
+from qml_essentials.coefficients import Coefficients
+```
+
+::: qml_essentials.coefficients.Coefficients
+    options:
+      heading_level: 3

mkdocs.yml

@@ -0,0 +1,39 @@
+site_name: QML Essentials
+theme:
+  name: material
+  highlightjs: true
+  palette:
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: teal
+      accent: cyan
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: teal
+      accent: cyan
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+plugins:
+  - search
+  - mkdocstrings
+markdown_extensions:
+  - markdown_include.include:
+      base_path: .
+  - toc:
+        permalink: "#"
+        baselevel: 1
+        separator: "_"
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji 
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/cirKITers/qml-essentials
+      name: Github