ctao-datamodel 1.0.0__tar.gz

ctao_datamodel-1.0.0/.gitignore

@@ -0,0 +1,136 @@
+# setuptools_scm generated version file
+_version.py
+
+# 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/
+pip-wheel-metadata/
+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/
+
+# 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/api
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+.virtual_documents
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+/src/ctao_datamodel/_dev_version/
+/docs/generated/

ctao_datamodel-1.0.0/.gitlab-ci.yml

@@ -0,0 +1,188 @@
+include:
+  - project: cta-computing/common/aiv-toolkit
+    ref: 4e2e12fe5bb637aa9a01c8dd3bd7680b36c70599
+    file: ci-publish-pypi.yml
+
+variables:
+    PYTHON_IMAGE: harbor.cta-observatory.org/proxy_cache/python:3.13
+
+workflow:
+  rules:
+    # build on merge request updates
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      # on merge-requests, don't upload the docker image, just test we can build it
+      variables:
+        DOCKER_EXTRA_ARGS: "--no-push"
+        DOCKER_TAG: "${CI_COMMIT_SHA}"
+
+    # pushes to main
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      variables:
+        # on main, update the "latest" version
+        DOCKER_TAG: "latest"
+
+    # and tags
+    - if: $CI_COMMIT_TAG
+      variables:
+        # on tags, create image tag using the same name
+        DOCKER_TAG: "${CI_COMMIT_TAG}"
+
+# jobs in the same stage run in parallel
+# later stages run after all jobs of previous stage were successful
+stages:
+  - static-checks
+  - test
+  - sonarqube
+  - build
+  - deploy
+  - publish
+
+static:
+  stage: static-checks
+  image: "harbor.cta-observatory.org/proxy_cache/python:3.12"
+
+  before_script:
+    - apt update && apt install -y --no-install-recommends git
+    - python --version
+    - pip install pre-commit
+
+  script:
+    - pre-commit run --all-files
+
+tests:
+  stage: test
+  parallel:
+    matrix:
+      - PYTHON_VERSION:
+        - "3.12"
+        - "3.13"
+        - "3.14"
+
+  image: "harbor.cta-observatory.org/proxy_cache/python:$PYTHON_VERSION"
+
+  before_script:
+    - python --version
+    - pip install -e .[test]
+    - apt update --yes && apt install --yes plantuml
+
+  script:
+    - pytest -v --color=yes --doctest-glob='docs/**/*.rst' --ignore-glob='src/ctao_datamodel/_dev_version/*'
+
+# Run the coverage on the oldest supported python version
+# no special reason, just to have no "gap" in the versions in the matrix above
+tests-with-cov:
+  stage: test
+  image: "harbor.cta-observatory.org/proxy_cache/python:3.13"
+
+  before_script:
+    - python --version
+    - pip install -e .[test]
+    - apt update --yes && apt install --yes plantuml
+
+  script:
+    - pytest -v --color=yes --doctest-glob='docs/**/*.rst' --ignore-glob='src/TEMPLATE_MODULE/_dev_version/*' --cov --cov-report=xml
+
+  artifacts:
+    paths:
+      - coverage.xml
+
+sonarqube:
+  stage: sonarqube
+  allow_failure: true
+  needs:
+    - job: tests-with-cov
+      artifacts: true
+  image:
+    name: "harbor.cta-observatory.org/proxy_cache/sonarsource/sonar-scanner-cli:11"
+    entrypoint: [""]
+
+  variables:
+    SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar"
+    GIT_DEPTH: "0"
+
+  before_script:
+    - python3 -m ensurepip
+    - python3 -m pip install setuptools_scm
+    - PROJECT_VERSION=$(python3 -m setuptools_scm)
+
+  script:
+    - sonar-scanner -Dsonar.projectVersion=${PROJECT_VERSION}
+
+build-docs:
+  stage: test
+  image: "harbor.cta-observatory.org/proxy_cache/python:3.13"
+
+  variables:
+    INDEX_PATH: "docs/build/html/index.html"
+
+  before_script:
+    - python --version
+    - pip install .[doc]
+    - apt update --yes && apt install --yes plantuml tree
+
+  script:
+    - make -C docs html
+
+  after_script:
+    - export BASE_GROUP=$(echo ${CI_PROJECT_PATH}  | cut -d/ -f1)
+    - export PROJECT_PATH=$(echo ${CI_PROJECT_PATH} | cut -d/ -f2-)
+    - "export URL_SCHEME=$(echo ${CI_PAGES_URL} | cut -d: -f1)"
+    - echo "ENVIRONMENT_URL=${URL_SCHEME}://${BASE_GROUP}.${CI_PAGES_DOMAIN}/-/${PROJECT_PATH}/-/jobs/${CI_JOB_ID}/artifacts/${INDEX_PATH}"  >> deploy.env
+    - cat deploy.env
+
+  artifacts:
+    paths:
+      - docs/build/html/
+    expose_as: "Rendered Documentation"
+    reports:
+      dotenv: deploy.env
+
+deploy_docs_env:
+  stage: deploy
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+  needs:
+    - job: build-docs
+      artifacts: true
+
+  script:
+    - echo "Using ${ENVIRONMENT_URL:?} to host documentation"
+
+  environment:
+    name: "review-docs/mr-${CI_MERGE_REQUEST_IID}"
+    url: ${ENVIRONMENT_URL}
+
+# actual deployment to gitlab pages, only on main
+pages:
+  stage: deploy
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+    - if: $CI_COMMIT_TAG
+  image: "harbor.cta-observatory.org/proxy_cache/python:3.13"
+  needs:
+    - job: build-docs
+      artifacts: true
+  before_script:
+    - pip install git+https://gitlab.cta-observatory.org/cta-computing/common/gitlab-multi-version-sphinx/
+  script:
+    - gitlab_multi_version_sphinx -v
+    - find public -maxdepth 1
+  artifacts:
+    paths:
+      - public
+  environment: production
+
+
+# build-docker-image:
+#   stage: deploy
+#   image:
+#     name: gcr.io/kaniko-project/executor:debug
+#     entrypoint: [""]
+
+#   script:
+#     - >-
+#       /kaniko/executor
+#       --context "${CI_PROJECT_DIR}"
+#       --dockerfile "${CI_PROJECT_DIR}/Dockerfile"
+#       --destination "${CI_REGISTRY_IMAGE}:${DOCKER_TAG}"
+#       ${DOCKER_EXTRA_ARGS}

ctao_datamodel-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0  # Use the ref you want to point at
+    hooks:
+    - id: trailing-whitespace
+      exclude: ".*\\.fits(\\.fz)?"
+    - id: check-added-large-files
+    - id: check-case-conflict
+    - id: check-merge-conflict
+      exclude: ".*\\.fits(\\.fz)?"
+    - id: end-of-file-fixer
+      exclude: ".*\\.fits(\\.fz)?"
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+    - id: codespell
+      additional_dependencies:
+        - tomli
+
+  # temporary until ruff-format supports long-string reformatting, we run this
+  # first and then ruff.
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 26.1.0
+    hooks:
+      - id: black
+        language_version: python3.12
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.1
+    hooks:
+      - id: ruff
+        args: [ --fix, --show-fixes ]
+      - id: ruff-format
+
+  - repo: https://github.com/scientific-python/cookie
+    rev: "2024.01.24"
+    hooks:
+      - id: sp-repo-review
+
+  - repo: https://github.com/srstevenson/nb-clean
+    rev: 4.0.1
+    hooks:
+      - id: nb-clean
+        args:
+          - --remove-empty-cells
+          - --remove-all-notebook-metadata
+          - --preserve-cell-metadata
+          - --

ctao_datamodel-1.0.0/CHANGES.rst

@@ -0,0 +1,4 @@
+ctao_datamodel 1.0.0
+--------------------
+
+First release, covering DataProducts data model document version A001

ctao_datamodel-1.0.0/Dockerfile

@@ -0,0 +1,33 @@
+# See https://testdriven.io/blog/docker-best-practices/ for recommendations
+# on writing dockerfiles for python projects.
+
+# We use a build stage to build a wheel which we then copy and install
+# in the second stage to minimize image size. This is mostly needed
+# because setuptools_scm needs the full version info from git and git
+# itself but including that in the final image would bloat its size.
+
+# we are using the official python image with just a version tag here
+# it comes with many tools needed to build and compile python packages
+# which increases it's size but is helpful for building
+FROM harbor.cta-observatory.org/proxy_cache/python:3.12 AS builder
+
+# Add full repository, needed for setuptools_scm to assign proper version
+COPY . /repo/
+
+# build the wheel
+RUN python -m pip install --no-cache-dir build \
+    && cd repo \
+    && python -m build --wheel
+
+
+# second stage, copy and install wheel
+# We are using the official python 3.11 image
+# as base image in the slim variant to reduce image size.
+FROM harbor.cta-observatory.org/proxy_cache/python:3.12-slim
+COPY --from=builder /repo/dist /tmp/dist
+
+RUN python -m pip install --no-cache-dir /tmp/dist/* \
+    && rm -r /tmp/dist \
+    && addgroup --system ctao && adduser --system --group ctao
+
+USER ctao

ctao_datamodel-1.0.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, Cherenkov Telescope Array Observatory
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder 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 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.

ctao_datamodel-1.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+prune src/ctao_datamodel/_dev_version
+prune .github

ctao_datamodel-1.0.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: ctao-datamodel
+Version: 1.0.0
+Summary: CTAO Data Model in pydantic and utilities for exporting it to latex and plantuml.
+Author-email: Karl Kosack <karl.kosack@cta-observatory.org>
+License-Expression: BSD-3-Clause
+Project-URL: repository, https://gitlab.cta-observatory.org/cta-computing/documentation/ctao-datamodel
+Project-URL: documentation, http://cta-computing.gitlab-pages.cta-observatory.org/documentation/ctao-datamodel
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pydantic
+Requires-Dist: email-validator
+Requires-Dist: pyyaml
+Requires-Dist: astropy>=7.1
+Requires-Dist: astropydantic
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Provides-Extra: doc
+Requires-Dist: sphinx~=8.2; extra == "doc"
+Requires-Dist: numpydoc; extra == "doc"
+Requires-Dist: ctao-sphinx-theme~=0.1.2; extra == "doc"
+Requires-Dist: sphinx-changelog; extra == "doc"
+Requires-Dist: myst-nb; extra == "doc"
+Requires-Dist: autodoc_pydantic; extra == "doc"
+Provides-Extra: dev
+Requires-Dist: setuptools_scm; extra == "dev"
+Requires-Dist: towncrier; extra == "dev"
+Provides-Extra: all
+Requires-Dist: ctao-datamodel[dev,doc,test]; extra == "all"
+Dynamic: license-file
+
+# ctao-datamodel
+
+Implementations of a subset of the CTAO data model as [pydantic](https://docs.pydantic.dev/latest/) schemas.
+
+* [Documentation](http://cta-computing.gitlab-pages.cta-observatory.org/common/ctao-datamodel/latest/)
+* [Repository](https://gitlab.cta-observatory.org/cta-computing/common/ctao-datamodel)
+
+## Scope
+
+The intention is to cover at least the metadata-aspects of the CTAO data model, i.e. the DataProducts model, and other models that will be serialized as JSON-like documents.  It does not cover the Science data models (DL3, etc), which are more complex.
+
+## Purpose
+
+This module can be used in other projects to help with validation of data against a machine-readable schema. The intention is to also auto-generate [JSONSchema](https://json-schema.org/) from the pydantic models in the CI, and export that as a separate package, to be used with projects that do not want to depend on pydantic, or python in general.

ctao_datamodel-1.0.0/README.md

@@ -0,0 +1,14 @@
+# ctao-datamodel
+
+Implementations of a subset of the CTAO data model as [pydantic](https://docs.pydantic.dev/latest/) schemas.
+
+* [Documentation](http://cta-computing.gitlab-pages.cta-observatory.org/common/ctao-datamodel/latest/)
+* [Repository](https://gitlab.cta-observatory.org/cta-computing/common/ctao-datamodel)
+
+## Scope
+
+The intention is to cover at least the metadata-aspects of the CTAO data model, i.e. the DataProducts model, and other models that will be serialized as JSON-like documents.  It does not cover the Science data models (DL3, etc), which are more complex.
+
+## Purpose
+
+This module can be used in other projects to help with validation of data against a machine-readable schema. The intention is to also auto-generate [JSONSchema](https://json-schema.org/) from the pydantic models in the CI, and export that as a separate package, to be used with projects that do not want to depend on pydantic, or python in general.

ctao_datamodel-1.0.0/docs/Makefile

@@ -0,0 +1,24 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= -W --keep-going -n --color
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+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 clean
+
+# 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)
+
+clean:
+	$(RM) -rf ./api
+	$(RM) -rf ./generated
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

ctao_datamodel-1.0.0/docs/changelog.rst

@@ -0,0 +1,7 @@
+Changes
+=======
+
+.. changelog::
+   :towncrier: ../
+   :towncrier-skip-if-empty:
+   :changelog_file: ../CHANGES.rst

ctao_datamodel-1.0.0/docs/changes/README.md

@@ -0,0 +1,22 @@
+# How to use towncrier
+
+An overview can be found [here](https://towncrier.readthedocs.io/en/stable/quickstart.html#).
+
+1. Create a new file for your changes `<MERGE REQUEST NUMBER>.<TYPE>.rst` in the corresponding folder.
+   The following types are available:
+    - feature: `New feature`
+    - bugfix: `Bugfix`
+    - api: `API Changes`
+    - optimization: `Refactoring and Optimization`
+    - maintenance: `Maintenance`
+
+2. Write a suitable message for the change:
+    ```
+    Fixed ``crazy_function`` to be consistent with ``not_so_crazy_function``
+    ```
+
+3. (For maintainers) How to generate a change log:
+    Execute the following command in the base directory of the project
+    ```
+    towncrier build --version=<VERSION NUMBER>
+    ```

ctao_datamodel-1.0.0/docs/changes/template.rst

@@ -0,0 +1,43 @@
+{% if render_title %}
+{% if versiondata.name %}
+{{ versiondata.name | lower }} {{ versiondata.version }} ({{ versiondata.date }})
+{{ top_underline * ((versiondata.name + versiondata.version + versiondata.date)|length + 4)}}
+{% else %}
+{{ versiondata.version }} ({{ versiondata.date }})
+{{ top_underline * ((versiondata.version + versiondata.date)|length + 3)}}
+{% endif %}
+{% endif %}
+
+{% for category, val in definitions.items() %}
+
+{% set underline = underlines[0] %}
+{{ definitions[category]['name'] }}
+{{ underline * definitions[category]['name']|length }}
+{% set underline = underlines[1] %}
+
+{% for section, _ in sections.items() %}
+{% if section and category in sections[section] %}
+{{section}}
+{{ underline * section|length }}
+
+{% endif %}
+{% if sections[section] and category in sections[section] %}
+{% if definitions[category]['showcontent'] %}
+{% for text, values in sections[section][category].items() %}
+- {{ text }} [{{ values|join(', ') }}]
+
+{% endfor %}
+{% else %}
+- {{ sections[section][category]['']|join(', ') }}
+
+{% endif %}
+{% if sections[section][category]|length == 0 %}
+No significant changes.
+
+{% else %}
+{% endif %}
+{% else %}
+{# No significant changes. #}
+{% endif %}
+{% endfor %}
+{% endfor %}

ctao_datamodel-1.0.0/docs/common.rst

@@ -0,0 +1,6 @@
+Common
+======
+
+.. currentmodule:: ctao_datamodel.models.common
+.. automodule:: ctao_datamodel.models.common
+   :members: