arrakis-backend-frames 0.1.0__tar.gz

arrakis_backend_frames-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+*~
+
+# artifacts
+*.egg-info
+build/
+dist/
+site/
+__pycache__
+*/_version.py
+.coverage
+
+# patches
+*.patch

arrakis_backend_frames-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,97 @@
+
+include:
+  # -- python -----------------
+  - component: git.ligo.org/computing/gitlab/components/python/sdist@1
+  - component: git.ligo.org/computing/gitlab/components/python/wheel@1
+  - component: git.ligo.org/computing/gitlab/components/python/code-quality@1
+    inputs:
+      analyzer: "ruff"
+      requirements: "-r requirements-lint.txt"
+  - component: git.ligo.org/computing/gitlab/components/python/dependency-scanning@1
+  - component: git.ligo.org/computing/gitlab/components/python/type-checking@1
+  - component: git.ligo.org/computing/gitlab/components/python/test@1
+    inputs:
+      job_name: "python_test_latest"
+      install_extra: test
+      python_versions:
+        - "3.11"
+        - "3.12"
+        - "3.13"
+  - component: git.ligo.org/computing/gitlab/components/python/test@1
+    inputs:
+      install_extra: test
+      python_versions:
+        - "3.11"
+        - "3.12"
+        - "3.13"
+  # -- docker -----------------
+  - component: git.ligo.org/computing/gitlab/components/docker/build@1
+    inputs:
+      image_tag: $CI_COMMIT_SHA
+  - component: git.ligo.org/computing/gitlab/components/docker/push@1
+    inputs:
+      pull_image_tag: $CI_COMMIT_SHA
+      push_image_tag: $CI_COMMIT_REF_NAME
+      push_when: "all"
+      tag_latest: false
+    rules:
+      - if: $CI_COMMIT_BRANCH
+      - if: $CI_COMMIT_TAG !~ /^(\d+\.)?(\d+\.)?(\*|\d+)$/
+  - component: git.ligo.org/computing/gitlab/components/docker/push@1
+    inputs:
+      pull_image_tag: $CI_COMMIT_SHA
+      push_image_tag: $CI_COMMIT_TAG
+      push_when: "tags"
+      tag_latest: true
+    rules:
+      # tag latest only on new versions
+      - if: $CI_COMMIT_TAG =~ /^(\d+\.)?(\d+\.)?(\*|\d+)$/
+  # -- docs -------------------
+  - component: git.ligo.org/computing/gitlab/components/mkdocs/build@1
+    inputs:
+      requirements: "-r requirements-docs.txt"
+  - component: git.ligo.org/computing/gitlab/components/mkdocs/pages@1
+    inputs:
+      pages_when: "default"
+
+# -- customisations
+
+# install latest arrakis client and server from git (main)
+python_test_latest:
+  before_script:
+    - pip install git+https://git.ligo.org/ngdd/arrakis-python.git
+    - pip install git+https://git.ligo.org/ngdd/arrakis-server.git
+
+# have Docker build depend on wheel
+build:
+  needs:
+    - wheel
+
+docker_push_gitlab:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: never
+    - when: always
+
+ruff:
+  needs:
+    - requirements
+
+mkdocs:
+  needs:
+    - requirements
+
+# -- requirements
+requirements:
+  stage: build
+  image: python:3.13
+  script:
+    - python -m pip install pipx
+    - pipx ensurepath
+    - source ~/.bashrc
+    - pipx install hatch
+    - hatch dep show requirements --feature docs > requirements-docs.txt
+    - hatch dep show requirements --feature lint > requirements-lint.txt
+  artifacts:
+    paths:
+      - requirements-*.txt

arrakis_backend_frames-0.1.0/CLAUDE.md

@@ -0,0 +1,78 @@
+# arrakis-backend-frames
+This is the frame backend for the arrakis server.  It is a component of the LIGO NGDD (next generation data delivery)
+project.  The point of this server is to be able to serve back historical scientific data that is stored in a
+multi-year archive of gwf files.
+
+The frame backend acts is a modular component of the arrakis-server package.  During development the arrkis-server code
+is often stored in a neighboring directory (../arrakis-server).  Both the server and the backend use a common arrakis-python
+library (again often stored in ../arrakis-python).
+
+The frame files (gwf) contain a large set of "channels".  The channels have a name, data type, data rate, and associated time series data.
+
+The frames have a frame type, typically denoted in the file name.
+ * The file name format is <frame type>-<gps start>-<duration>.gwf
+ * So L-L1_R-1000000000-64.gwf is a L-L1_R frame from gps 1000000000 that holds 64s of data
+ * In general the list of channels in a particular frame type does not dramatically change from frame to frame, although
+  the list of channels does change.
+
+The system maps channel names to scopes, rooted at interferometers.  A set of sample channels might be:
+ 1. X1:SUS-ABC_INP
+ 2. X1:SEI-DEF_OUT
+ 3. X1:FEC-CPU_TIME_MAX
+These would all be part of the 'X1' interferometer, but in three different subsystems, 'SUS', 'SEI', 'FEC'.
+A scope mapping would be created that tells that the X1 interferometer has 'SUS', 'SEI', 'FEC' subsystems.  This gives
+the server a high level way to say which channels it might serve. 
+
+## Details
+
+ * Implementation language: Python
+ * Frameworks:
+   - Apache arrow flight - defines the IPC/request/response mechanisms
+   - Apache arrow - defines the core data structures
+   - gwframes - gwf frame file library
+   - numpy - use by gwframes and the arrow code
+
+## High level architecture
+
+This server typically does not run alone.  It needs two other components:
+ 1. A metadata server - this tracks channel existance and maps channels to frame types over time
+ 2. A 'diskcache' server that tracks where and when frames exist
+
+Our metadata server does the interfacing with the diskcache server so that we never directly talk to it.
+
+These are needed to work on a large deployment.  It keeps this system from needing to know where all the frames are and
+from needing to directly index all the frames.
+
+## Software components
+
+ arrakis_backend_frames
+  * backend.py - the main backend server definition
+  * cache_adaptor.py - a generic wrapper of a key/value cache (often memcached)
+  * frame_io.py - the io routines that call gwframe functions
+  * helpers.py - misc helpers
+  * memory_cache.py - a interface to a caching layer (typically memcached)
+  * metadata.py - our interface to the metadata server
+  * planner.py - the query planner.  This is in charge of taking channel and availability information and creating a read plan, what frames to open, which channels to read from, ... in order to satisfy user requests.
+  * signal_units.py - encodes auxiliary information that can be attached to channels.
+  * sock_io.py - a wrapper around socket io
+  * tests - test code
+    * integration_samples - contains code used to create a directory of test frames
+
+## Workflow
+
+ * Work on features in a branch.
+ * When done tests must pass
+ * Formatting is done automatically by an edit hook
+ * After a feature is approved it should be commited and merged into the main branch
+
+## Technical notes
+
+ * When returning sets of tuples, arrays, dictionaries that contain multiple fields we should instead create DataClasses or named tuples so that we not only have the data but we have symantic information about what it means.
+ * Prefer to use context managers when dealing with things we need to clean up.
+
+## Interaction instructions
+
+ * When presenting the user with questions number each question.  This makes it easier to tie the reply to the question.  Do not re-use numbers in a session.
+
+## Supplementary instruction files
+ * consult plan.md for our current plan and progress.

arrakis_backend_frames-0.1.0/Dockerfile

@@ -0,0 +1,58 @@
+# build stage: build wheel + extract dependencies
+FROM python:3.13 as build
+
+ENV PIP_DEFAULT_TIMEOUT=100
+ENV PIP_DISABLE_PIP_VERSION_CHECK=1
+ENV PIP_NO_CACHE_DIR=1
+
+WORKDIR /app
+
+COPY . ./
+
+# install git for versioning
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+        git && \
+	rm -rf /var/lib/apt /var/lib/dpkg /var/lib/cache /var/lib/log
+
+RUN pip install --upgrade pip
+RUN pip install hatch
+
+RUN hatch build --clean
+
+# install stage: install package + dependencies
+FROM python:3.13 as install
+
+ENV PIP_DEFAULT_TIMEOUT=100
+ENV PIP_DISABLE_PIP_VERSION_CHECK=1
+ENV PIP_NO_CACHE_DIR=1
+
+WORKDIR /app
+
+COPY --from=build /app/dist/*.whl /app
+
+# create virtualenv
+RUN python -m venv /opt/venv
+
+# ensure virtualenv python is preferred
+ENV PATH="/opt/venv/bin:$PATH"
+
+run pip install --upgrade pip
+RUN pip install *.whl
+
+# final stage: installed app
+FROM python:3.13-slim as app
+
+COPY --from=install /opt/venv /opt/venv
+
+# create app user
+RUN groupadd --gid 1000 arrakis && \
+    useradd --uid 1000 --gid 1000 -m arrakis
+
+USER arrakis
+
+# ensure virtualenv python is preferred
+ENV PATH="/opt/venv/bin:$PATH"
+
+ENTRYPOINT ["arrakis-server"]
+CMD ["frame"]

arrakis_backend_frames-0.1.0/LICENSE

@@ -0,0 +1,195 @@
+Copyright (c) 2022, California Institute of Technology and contributors
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 3 of the License, or (at your option) any later version.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Neither the name of the California Institute of Technology (Caltech),
+Massachusetts Institute of Technology (M.I.T.), nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+This software is distributed under the GNU Lesser General Public
+License Version 3. A copy is included below, and can also be obtained
+at http://www.gnu.org/licenses
+
+-----------------------------------------------------------------------
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

arrakis_backend_frames-0.1.0/Makefile

@@ -0,0 +1,29 @@
+.PHONY: help
+help :
+	@echo
+	@echo 'Commands:'
+	@echo
+	@echo '  make test                  run tests'
+	@echo '  make lint                  run linter'
+	@echo '  make format                run code formatter'
+	@echo '  make check                 run static type checker'
+	@echo
+
+.PHONY: test
+test :
+	pytest -v --cov=arrakis_backend_frames --cov-report=term-missing .
+
+.PHONY: lint
+lint :
+	ruff check
+
+.PHONY: format
+format :
+	ruff format
+
+.PHONY: check
+check :
+	mypy .
+
+.PHONY: all
+all : format lint check test

arrakis_backend_frames-0.1.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: arrakis-backend-frames
+Version: 0.1.0
+Summary: Frame backend for the Arrakis server
+Project-URL: Homepage, https://git.ligo.org/ngdd/backends/arrakis-backend-frames
+Project-URL: Documentation, https://docs.ligo.org/ngdd/backends/arrakis-backend-frames
+Project-URL: Issue Tracker, https://git.ligo.org/ngdd/backends/arrakis-backend-frames/issues
+Project-URL: Source Code, https://git.ligo.org/ngdd/backends/arrakis-backend-frames.git
+Author-email: Patrick Godwin <patrick.godwin@ligo.org>
+Maintainer-email: Patrick Godwin <patrick.godwin@ligo.org>
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.11
+Requires-Dist: arrakis-server>=0.9
+Requires-Dist: arrakis>=0.11
+Requires-Dist: gwframe>=0.3.1
+Requires-Dist: numpy
+Requires-Dist: python-memcached
+Requires-Dist: requests
+Provides-Extra: dev
+Requires-Dist: markdown-callouts>=0.2; extra == 'dev'
+Requires-Dist: markdown-exec>=0.5; extra == 'dev'
+Requires-Dist: mkdocs-coverage>=0.2; extra == 'dev'
+Requires-Dist: mkdocs-gen-files>=0.3; extra == 'dev'
+Requires-Dist: mkdocs-literate-nav>=0.4; extra == 'dev'
+Requires-Dist: mkdocs-material-igwn; extra == 'dev'
+Requires-Dist: mkdocs-section-index>=0.3; extra == 'dev'
+Requires-Dist: mkdocs>=1.3; extra == 'dev'
+Requires-Dist: mkdocstrings[python]; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: mypy-extensions; extra == 'dev'
+Requires-Dist: pip; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: toml>=0.10; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: markdown-callouts>=0.2; extra == 'docs'
+Requires-Dist: markdown-exec>=0.5; extra == 'docs'
+Requires-Dist: mkdocs-coverage>=0.2; extra == 'docs'
+Requires-Dist: mkdocs-gen-files>=0.3; extra == 'docs'
+Requires-Dist: mkdocs-literate-nav>=0.4; extra == 'docs'
+Requires-Dist: mkdocs-material-igwn; extra == 'docs'
+Requires-Dist: mkdocs-section-index>=0.3; extra == 'docs'
+Requires-Dist: mkdocs>=1.3; extra == 'docs'
+Requires-Dist: mkdocstrings[python]; extra == 'docs'
+Requires-Dist: toml>=0.10; extra == 'docs'
+Provides-Extra: lint
+Requires-Dist: mypy; extra == 'lint'
+Requires-Dist: mypy-extensions; extra == 'lint'
+Requires-Dist: pip; extra == 'lint'
+Requires-Dist: ruff; extra == 'lint'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+<h1 align="center">arrakis-backend-frames</h1>
+
+<p align="center">Arrakis server frame backend</p>
+
+<p align="center">
+  <a href="https://git.ligo.org/ngdd/backends/arrakis-backend-frames/-/pipelines/latest">
+    <img alt="ci" src="https://git.ligo.org/ngdd/backends/arrakis-backend-frames/badges/main/pipeline.svg" />
+  </a>
+  <a href="https://ngdd.docs.ligo.org/backends/arrakis-backend-frames/">
+    <img alt="documentation" src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" />
+  </a>
+</p>
+
+---
+
+## Installation
+
+```
+pip install git+https://git.ligo.org/ngdd/backends/arrakis-backend-frames.git
+```
+
+## Docker
+
+```
+docker run --net=host -it docker://containers.ligo.org/ngdd/backends/arrakis-backend-frames:main
+```

arrakis_backend_frames-0.1.0/README.md

@@ -0,0 +1,26 @@
+<h1 align="center">arrakis-backend-frames</h1>
+
+<p align="center">Arrakis server frame backend</p>
+
+<p align="center">
+  <a href="https://git.ligo.org/ngdd/backends/arrakis-backend-frames/-/pipelines/latest">
+    <img alt="ci" src="https://git.ligo.org/ngdd/backends/arrakis-backend-frames/badges/main/pipeline.svg" />
+  </a>
+  <a href="https://ngdd.docs.ligo.org/backends/arrakis-backend-frames/">
+    <img alt="documentation" src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" />
+  </a>
+</p>
+
+---
+
+## Installation
+
+```
+pip install git+https://git.ligo.org/ngdd/backends/arrakis-backend-frames.git
+```
+
+## Docker
+
+```
+docker run --net=host -it docker://containers.ligo.org/ngdd/backends/arrakis-backend-frames:main
+```

arrakis_backend_frames-0.1.0/arrakis_backend_frames/__init__.py

@@ -0,0 +1,13 @@
+# Copyright (c) 2025, California Institute of Technology and contributors
+#
+# You should have received a copy of the licensing terms for this
+# software included in the file "LICENSE" located in the top-level
+# directory of this package. If you did not, you can view a copy at
+# https://git.ligo.org/ngdd/arrakis-server/-/raw/main/LICENSE
+
+try:
+    from ._version import version as __version__
+except ModuleNotFoundError:
+    import setuptools_scm
+
+    __version__ = setuptools_scm.get_version(fallback_version="?.?.?")

arrakis_backend_frames-0.1.0/arrakis_backend_frames/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = None