diff --git a/.flake8 b/.flake8
deleted file mode 100644
index 06945f4..0000000
--- a/.flake8
+++ /dev/null
@@ -1,3 +0,0 @@
-[flake8]
-max-line-length = 119
-ignore = E203, W503
diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml
new file mode 100644
index 0000000..86f56c1
--- /dev/null
+++ b/.github/workflows/docs_build.yml
@@ -0,0 +1,45 @@
+name: docs (build)
+
+on:
+ pull_request:
+ branches:
+ - main
+ paths:
+ - .pre-commit-config.yaml
+ - .github/workflows/docs_build.yml
+ - '**.py'
+ - '**.ipynb'
+ - poetry.lock
+ - pyproject.toml
+ - '**.rst'
+ - '**.md'
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4.1.1
+ - name: Install dependencies, build docs and coverage report
+ run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
+ - uses: actions/setup-python@v5.0.0
+ with:
+ python-version: '3.9'
+ cache: 'poetry'
+ - run: |
+ python3 -m pip install --upgrade pip && python3 -m pip install poetry
+ poetry env use '3.9'
+ source $(poetry env info --path)/bin/activate
+ poetry install --with docs,test
+ cd docs && rm -rf source/reference/api/_autosummary && make html
+ cd .. && coverage run -m pytest -m "not integration_test" && coverage xml && coverage report -m
+# - name: Upload coverage to Codecov
+# uses: Wandalen/wretry.action@v1.4.4
+# with:
+# action: codecov/codecov-action@v4.0.1
+# with: |
+# token: ${{ secrets.CODECOV_TOKEN }}
+# file: ./coverage.xml
+# name: codecov-umbrella
+# fail_ci_if_error: true
+# attempt_limit: 5
+# attempt_delay: 30000
diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml
new file mode 100644
index 0000000..37eabc9
--- /dev/null
+++ b/.github/workflows/docs_deploy.yml
@@ -0,0 +1,55 @@
+name: docs
+
+on:
+ push:
+ branches:
+ - main
+ paths:
+ - .pre-commit-config.yaml
+ - .github/workflows/static_code_checks.yml
+ - .github/workflows/docs_build.yml
+ - .github/workflows/docs_deploy.yml
+ - .github/workflows/tests.yml
+ - '**.py'
+ - '**.ipynb'
+ - poetry.lock
+ - pyproject.toml
+ - '**.rst'
+ - '**.md'
+
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4.1.1
+ with:
+ submodules: 'true'
+ - name: Install dependencies, build docs and coverage report
+ run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
+ - uses: actions/setup-python@v5.0.0
+ with:
+ python-version: '3.9'
+ cache: 'poetry'
+ - run: |
+ python3 -m pip install --upgrade pip && python3 -m pip install poetry
+ poetry env use '3.9'
+ source $(poetry env info --path)/bin/activate
+ poetry install --with docs,test
+ cd docs && rm -rf source/reference/api/_autosummary && make html
+ cd .. && coverage run -m pytest -m "not integration_test" && coverage xml && coverage report -m
+# - name: Upload coverage to Codecov
+# uses: Wandalen/wretry.action@v1.4.4
+# with:
+# action: codecov/codecov-action@v4.0.1
+# with: |
+# token: ${{ secrets.CODECOV_TOKEN }}
+# file: ./coverage.xml
+# name: codecov-umbrella
+# fail_ci_if_error: true
+# attempt_limit: 5
+# attempt_delay: 30000
+ - name: Deploy to Github pages
+ uses: JamesIves/github-pages-deploy-action@v4.5.0
+ with:
+ branch: github_pages
+ folder: docs/build/html
diff --git a/.github/workflows/integration_tests.yaml b/.github/workflows/integration_tests.yaml
new file mode 100644
index 0000000..7421d82
--- /dev/null
+++ b/.github/workflows/integration_tests.yaml
@@ -0,0 +1,61 @@
+name: tests
+
+on:
+ push:
+ branches:
+ - main
+ paths:
+ - .pre-commit-config.yaml
+ - .github/workflows/static_code_checks.yml
+ - .github/workflows/docs_build.yml
+ - .github/workflows/docs_deploy.yml
+ - .github/workflows/tests.yml
+ - '**.py'
+ - '**.ipynb'
+ - poetry.lock
+ - pyproject.toml
+ - '**.rst'
+ - '**.md'
+ pull_request:
+ branches:
+ - main
+ paths:
+ - .pre-commit-config.yaml
+ - .github/workflows/static_code_checks.yml
+ - .github/workflows/docs_build.yml
+ - .github/workflows/docs_deploy.yml
+ - .github/workflows/tests.yml
+ - '**.py'
+ - '**.ipynb'
+ - poetry.lock
+ - pyproject.toml
+ - '**.rst'
+ - '**.md'
+
+jobs:
+ python-tests:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4.1.1
+ - name: Install poetry
+ run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
+ - uses: actions/setup-python@v5.0.0
+ with:
+ python-version: '3.9'
+ - name: Install dependencies and check code
+ run: |
+ poetry env use '3.9'
+ source $(poetry env info --path)/bin/activate
+ poetry install --with docs,test
+ coverage run -m pytest florist/tests/integration && coverage xml && coverage report -m
+# - name: Upload coverage to Codecov
+# uses: Wandalen/wretry.action@v1.4.4
+# with:
+# action: codecov/codecov-action@v4.0.1
+# with: |
+# token: ${{ secrets.CODECOV_TOKEN }}
+# file: ./coverage.xml
+# name: codecov-umbrella
+# fail_ci_if_error: true
+# attempt_limit: 5
+# attempt_delay: 30000
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
new file mode 100644
index 0000000..da22deb
--- /dev/null
+++ b/.github/workflows/publish.yml
@@ -0,0 +1,27 @@
+name: publish package
+
+on:
+ release:
+ types: [published]
+
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Install apt dependencies
+ run: |
+ sudo apt-get update
+ sudo apt-get install libcurl4-openssl-dev libssl-dev
+ - uses: actions/checkout@v4.1.1
+ - name: Install poetry
+ run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
+ - uses: actions/setup-python@v5.0.0
+ with:
+ python-version: '3.9'
+ - name: Build package
+ run: poetry build
+ - name: Publish package
+ uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+ with:
+ user: __token__
+ password: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/.github/workflows/static_code_checks.yaml b/.github/workflows/static_code_checks.yaml
index 4ce815c..abcbdaa 100644
--- a/.github/workflows/static_code_checks.yaml
+++ b/.github/workflows/static_code_checks.yaml
@@ -1,26 +1,58 @@
-# only has to pass for python 3.9
-name: Static code checks
+name: code checks
on:
push:
branches:
- main
+ - main
+ paths:
+ - .pre-commit-config.yaml
+ - .github/workflows/code_checks.yml
+ - '**.py'
+ - poetry.lock
+ - pyproject.toml
+ - '**.ipynb'
pull_request:
branches:
- main
+ - main
+ paths:
+ - .pre-commit-config.yaml
+ - .github/workflows/code_checks.yml
+ - '**.py'
+ - poetry.lock
+ - pyproject.toml
+ - '**.ipynb'
jobs:
run-code-check:
runs-on: ubuntu-latest
steps:
-
- - name: Checkout code
- uses: actions/checkout@v3
-
- - name: Set up Python 3.9
- uses: actions/setup-python@v3
+ - uses: actions/checkout@v4.1.1
+ - name: Install and configure Poetry
+ uses: snok/install-poetry@v1
with:
- python-version: 3.9
-
- - name: precommit checker
- uses: pre-commit/action@v3.0.1
+ virtualenvs-create: true
+ virtualenvs-in-project: true
+ - uses: actions/setup-python@v5.0.0
+ with:
+ python-version: '3.9'
+ cache: 'poetry'
+ - name: Install dependencies and check code
+ run: |
+ poetry env use '3.9'
+ source .venv/bin/activate
+ poetry install --with test --all-extras
+ pre-commit run --all-files
+ - name: pip-audit (gh-action-pip-audit)
+ uses: pypa/gh-action-pip-audit@v1.0.8
+ with:
+ virtual-environment: .venv/
+ # Ignoring security vulnerabilities in Pillow because pycyclops cannot update it to the
+ # version that fixes them (>10.0.1).
+ # Remove those when the issue below is fixed and pycyclops changes its requirements:
+ # https://github.com/SeldonIO/alibi/issues/991
+ ignore-vulns: |
+ PYSEC-2023-175
+ PYSEC-2023-227
+ GHSA-j7hp-h8jx-5ppr
+ GHSA-56pw-mpj4-fxww
+ GHSA-3f63-hfp8-52jq
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
deleted file mode 100644
index 442c8b6..0000000
--- a/.github/workflows/tests.yaml
+++ /dev/null
@@ -1,42 +0,0 @@
-# only has to pass for python 3.9
-name: PyTest Unit Tests
-
-on:
- push:
- branches:
- main
- pull_request:
- branches:
- main
-
-jobs:
- test:
- runs-on: ubuntu-latest
- steps:
- - name: Checkout code
- uses: actions/checkout@v3
- - name: Set up Python 3.9
- uses: actions/setup-python@v3
- with:
- python-version: 3.9
- # Display the Python version being used
- - name: Display Python version
- run: python -c "import sys; print(sys.version)"
- - name: Install and configure Poetry
- uses: snok/install-poetry@v1
- with:
- virtualenvs-create: true
- virtualenvs-in-project: true
- - name: Set up cache
- uses: actions/cache@v2
- id: cached-poetry-dependencies
- with:
- path: .venv
- key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
- - name: Install dependencies
- run: poetry install --with "dev, test"
- if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
- - name: Run Tests
- run: |
- source .venv/bin/activate
- pytest florist/tests/*
diff --git a/.github/workflows/unit_tests.yaml b/.github/workflows/unit_tests.yaml
new file mode 100644
index 0000000..411861e
--- /dev/null
+++ b/.github/workflows/unit_tests.yaml
@@ -0,0 +1,61 @@
+name: tests
+
+on:
+ push:
+ branches:
+ - main
+ paths:
+ - .pre-commit-config.yaml
+ - .github/workflows/static_code_checks.yml
+ - .github/workflows/docs_build.yml
+ - .github/workflows/docs_deploy.yml
+ - .github/workflows/tests.yml
+ - '**.py'
+ - '**.ipynb'
+ - poetry.lock
+ - pyproject.toml
+ - '**.rst'
+ - '**.md'
+ pull_request:
+ branches:
+ - main
+ paths:
+ - .pre-commit-config.yaml
+ - .github/workflows/static_code_checks.yml
+ - .github/workflows/docs_build.yml
+ - .github/workflows/docs_deploy.yml
+ - .github/workflows/tests.yml
+ - '**.py'
+ - '**.ipynb'
+ - poetry.lock
+ - pyproject.toml
+ - '**.rst'
+ - '**.md'
+
+jobs:
+ python-tests:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4.1.1
+ - name: Install poetry
+ run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
+ - uses: actions/setup-python@v5.0.0
+ with:
+ python-version: '3.9'
+ - name: Install dependencies and check code
+ run: |
+ poetry env use '3.9'
+ source $(poetry env info --path)/bin/activate
+ poetry install --with docs,test
+ coverage run -m pytest florist/tests/unit && coverage xml && coverage report -m
+# - name: Upload coverage to Codecov
+# uses: Wandalen/wretry.action@v1.4.4
+# with:
+# action: codecov/codecov-action@v4.0.1
+# with: |
+# token: ${{ secrets.CODECOV_TOKEN }}
+# file: ./coverage.xml
+# name: codecov-umbrella
+# fail_ci_if_error: true
+# attempt_limit: 5
+# attempt_delay: 30000
diff --git a/.gitignore b/.gitignore
index a56e7ee..8ae2206 100644
--- a/.gitignore
+++ b/.gitignore
@@ -166,3 +166,5 @@ yarn-error.log*
*.tsbuildinfo
next-env.d.ts
/florist/tsconfig.json
+
+/metrics/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 88d095c..c577a37 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,45 +1,48 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
- rev: v4.5.0 # Use the ref you want to point at
+ rev: v4.4.0 # Use the ref you want to point at
hooks:
- - id: trailing-whitespace
- - id: check-ast
- - id: check-builtin-literals
- - id: check-docstring-first
- - id: check-executables-have-shebangs
- - id: debug-statements
- - id: end-of-file-fixer
- - id: mixed-line-ending
- args: [--fix=lf]
- - id: requirements-txt-fixer
- - id: trailing-whitespace
- - id: check-yaml
+ - id: trailing-whitespace
+ - id: check-ast
+ - id: check-builtin-literals
+ - id: check-docstring-first
+ - id: check-executables-have-shebangs
+ - id: debug-statements
+ - id: end-of-file-fixer
+ - id: mixed-line-ending
+ args: [--fix=lf]
+ - id: requirements-txt-fixer
+ - id: check-yaml
+ - id: check-toml
- - repo: https://github.com/PyCQA/flake8
- rev: 7.0.0
+ - repo: https://github.com/charliermarsh/ruff-pre-commit
+ rev: 'v0.2.2'
hooks:
- - id: flake8
-
- - repo: https://github.com/psf/black
- rev: 24.1.1
- hooks:
- - id: black
-
- - repo: https://github.com/PyCQA/isort
- rev: 5.13.2
- hooks:
- - id: isort
+ - id: ruff
+ args: [--fix, --exit-non-zero-on-fix]
+ types_or: [python, jupyter]
+ - id: ruff-format
+ types_or: [python, jupyter]
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.8.0
hooks:
- - id: mypy
+ - id: mypy
+ entry: python3 -m mypy --config-file pyproject.toml
+ language: system
+ types: [python]
+ exclude: "florist/tests/"
- repo: https://github.com/nbQA-dev/nbQA
rev: 1.7.1
hooks:
- - id: nbqa-black
- - id: nbqa-isort
- - id: nbqa-check-ast
- - id: nbqa-flake8
- - id: nbqa-mypy
+ - id: nbqa-ruff
+ args: [--fix, --exit-non-zero-on-fix]
+
+ - repo: local
+ hooks:
+ - id: doctest
+ name: doctest
+ entry: python3 -m doctest -o NORMALIZE_WHITESPACE
+ files: "(^florist/api/|florist/tests/api/)"
+ language: system
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..4f79bf3
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# 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, 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
+cyclops@vectorinstitute.ai.
+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.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7418b47..600941c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -27,7 +27,7 @@ We use [Poetry](https://python-poetry.org/) to manage back-end dependencies:
```shell
pip install --upgrade pip poetry
-poetry install --with dev
+poetry install --with test
```
We use [Yarn](https://yarnpkg.com/) to manage front-end dependencies. Install it on MacOS
@@ -44,17 +44,12 @@ yarn
## Coding guidelines
-For code style, we recommend the [google style guide](https://google.github.io/styleguide/pyguide.html).
-
-Pre-commit hooks apply the [black](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)
-code formatting.
+For code style, we recommend the [PEP 8 style guide](https://peps.python.org/pep-0008/).
For docstrings we use [numpy format](https://numpydoc.readthedocs.io/en/latest/format.html).
-We also use [flake8](https://flake8.pycqa.org/en/latest/) and [pylint](https://pylint.pycqa.org/en/stable/)
-for further static code analysis. The pre-commit hooks show errors which you need
-to fix before submitting a PR.
+We use [ruff](https://docs.astral.sh/ruff/) for code formatting and static code
+analysis. Ruff checks various rules including [flake8](https://docs.astral.sh/ruff/faq/#how-does-ruff-compare-to-flake8). The pre-commit hooks show errors which you need to fix before submitting a PR.
Last but not the least, we use type hints in our code which is then checked using
-[mypy](https://mypy.readthedocs.io/en/stable/). Currently, mypy checks are not
-strict, but will be enforced more as the API code becomes more stable.
+[mypy](https://mypy.readthedocs.io/en/stable/).
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index 9aea952..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Vector Institute
-
-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.
diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..766ba2e
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2024, Vector Institute
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..d0c3cbf
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = source
+BUILDDIR = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..dc1312a
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.https://www.sphinx-doc.org/
+ exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/source/_templates/page.html b/docs/source/_templates/page.html
new file mode 100644
index 0000000..b908ccd
--- /dev/null
+++ b/docs/source/_templates/page.html
@@ -0,0 +1,211 @@
+{% extends "base.html" %}
+
+{% block body -%}
+{{ super() }}
+{% include "partials/icons.html" %}
+
+
+
+
+
+
+{% if theme_announcement -%}
+