gammasimtools 0.5.1__tar.gz

gammasimtools-0.5.1/.github/dependabot.yml

@@ -0,0 +1,10 @@
+# Set update schedule for GitHub Actions
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"

gammasimtools-0.5.1/.github/workflows/CI-docs.yml

@@ -0,0 +1,44 @@
+---
+name: CI-docs
+# Build and deploy docs to gh-pages
+
+on:
+  pull_request:
+    branches: [main]
+    types: [opened, closed, synchronize]
+
+jobs:
+
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.10.4
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.10.4
+
+      - name: Python dependencies
+        run: |
+          python --version
+          pip install '.[doc]'
+
+      - name: Build docs
+        shell: bash -l {0}
+        run: |
+          make -C docs/ html
+          touch docs/build/html/.nojekyll
+
+      - name: Deploy to gihub pages
+        # only run when PR is merged
+        if: github.event.pull_request.merged
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: docs/build/html
+          CLEAN: true
+          SINGLE_COMMIT: true

gammasimtools-0.5.1/.github/workflows/CI-integrationtests.yml

@@ -0,0 +1,95 @@
+---
+name: CI-integrationtests
+# Execute integration tests for applications
+#
+env:
+  SIMTEL_PATH: ${{ github.workspace }}/
+  DB_SERVER: ${{ secrets.DB_SERVER }}
+  DB_API_USER: ${{ secrets.DB_API_USER }}
+  DB_API_PW: ${{ secrets.DB_API_PW }}
+  DB_API_PORT: ${{ secrets.DB_API_PORT }}
+
+on:
+  pull_request:
+    branches: [main]
+    types: [opened, synchronize]
+  push:
+    branches:
+      - main
+
+jobs:
+
+  integrationtests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            python-version: "3.9"
+            install-method: mamba
+
+          - os: ubuntu-latest
+            python-version: "3.9"
+            install-method: pip
+
+    defaults:
+      run:
+        shell: bash -leo pipefail {0}
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Prepare mamba installation
+        if: matrix.install-method == 'mamba'
+        env:
+          PYTHON_VERSION: ${{ matrix.python-version }}
+        run: |
+          # setup correct python version
+          sed -i -e "s/- python=.*/- python=$PYTHON_VERSION/g" environment.yml
+
+      - name: Install mamba dependencies
+        if: matrix.install-method == 'mamba'
+        uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-file: environment.yml
+          create-args: python=${{ matrix.python-version }}
+          init-shell: bash
+
+      - name: Python setup
+        if: matrix.install-method == 'pip'
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          check-latest: true
+
+      - name: Python dependencies
+        run: |
+          python --version
+          pip install '.[tests,dev,doc]'
+
+      - name: simteldependencies
+        run: |
+          sudo apt-get update -y -qq
+          sudo apt-get install -y -qq bash build-essential bzip2 csh gfortran gcc g++ git libgsl-dev make wget
+
+      - name: corsikasimtelpackage
+        run: |
+          wget --no-verbose https://syncandshare.desy.de/index.php/s/${{ secrets.CLOUD_SIMTEL }}/download
+          mv download corsika7.7_simtelarray.tar.gz
+          tar -xzf corsika7.7_simtelarray.tar.gz
+          ./build_all prod5 qgs2 gsl
+
+      - name: run sim_telarray
+        run: |
+          echo "${SIMTEL_PATH}"
+          ls "${SIMTEL_PATH}"
+
+      - name: Integration tests
+        shell: bash -l {0}
+        run: pytest --color=yes --durations=10 --no-cov tests/integration_tests/

gammasimtools-0.5.1/.github/workflows/CI-unittests.yml

@@ -0,0 +1,113 @@
+---
+name: CI-unittests
+# Execute unit tests - pyflakes and pytest
+#
+env:
+  DB_SERVER: ${{ secrets.DB_SERVER }}
+  DB_API_USER: ${{ secrets.DB_API_USER }}
+  DB_API_PW: ${{ secrets.DB_API_PW }}
+  DB_API_PORT: ${{ secrets.DB_API_PORT }}
+
+on:
+  pull_request:
+    branches: [main]
+    types: [opened, synchronize]
+  push:
+    branches:
+      - main
+
+jobs:
+
+  unittests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            python-version: "3.9"
+            install-method: mamba
+
+          - os: ubuntu-latest
+            python-version: "3.9"
+            install-method: pip
+
+          - os: macos-latest
+            python-version: "3.9"
+            install-method: mamba
+
+          - os: macos-latest
+            python-version: "3.9"
+            install-method: pip
+
+          - os: ubuntu-latest
+            python-version: "3.10"
+            install-method: mamba
+
+          - os: ubuntu-latest
+            python-version: "3.10"
+            install-method: pip
+
+          - os: ubuntu-latest
+            python-version: "3.11"
+            install-method: mamba
+
+          - os: ubuntu-latest
+            python-version: "3.11"
+            install-method: pip
+
+    defaults:
+      run:
+        shell: bash -leo pipefail {0}
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Prepare mamba installation
+        if: matrix.install-method == 'mamba'
+        env:
+          PYTHON_VERSION: ${{ matrix.python-version }}
+        run: |
+          # setup correct python version
+          sed -i -e "s/- python=.*/- python=$PYTHON_VERSION/g" environment.yml
+
+      - name: Install mamba dependencies
+        if: matrix.install-method == 'mamba'
+        uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-file: environment.yml
+          create-args: python=${{ matrix.python-version }}
+          init-shell: bash
+
+      - name: Python setup
+        if: matrix.install-method == 'pip'
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          check-latest: true
+
+      - if: ${{ matrix.install-method == 'pip' && runner.os == 'macOS' }}
+        name: Fix Python PATH on macOS
+        # from https://github.com/cta-observatory/ctapipe/blob/cfacbe1eeb2d9a4634980e5f1ef39b944bca6a7a/.github/workflows/ci.yml#L100
+        run: |
+          tee -a ~/.bash_profile <<<'export PATH="$pythonLocation/bin:$PATH"'
+
+      - name: Python dependencies
+        run: |
+          python --version
+          pip install '.[tests,dev,doc]'
+
+      - name: pyflakes liniting
+        run: |
+          pyflakes .
+
+      - name: Unit tests
+        shell: bash -l {0}
+        run: pytest --durations=10 --color=yes --cov --cov-report=xml
+
+      - uses: codecov/codecov-action@v3.1.4

gammasimtools-0.5.1/.github/workflows/build-docker-corsika-simtelarray-image.yml

@@ -0,0 +1,82 @@
+# https://docs.github.com/en/actions/publishing-packages/publishing-docker-images
+name: docker-corsika-simtelarray
+
+on:
+  workflow_dispatch:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+
+  corsikasimtelpackage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: download corsikasimtelpackage
+        run: |
+          wget --no-verbose https://syncandshare.desy.de/index.php/s/${{ secrets.CLOUD_SIMTEL }}/download
+          mv download corsika7.7_simtelarray.tar.gz
+
+      - name: Publish Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: corsika7.7_simtelarray.tar.gz
+          path: corsika7.7_simtelarray.tar.gz
+          retention-days: 1
+
+  build-simtools-container:
+    needs: corsikasimtelpackage
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        type: ['simtelarray']
+
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: corsika7.7_simtelarray.tar.gz
+          path: corsika7.7_simtelarray.tar.gz
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          tags: |
+            type=ref,event=pr
+            type=semver,pattern={{major}}.{{minor}}.{{patch}}
+            type=schedule,pattern={{date 'YYYYMMDD'}}
+            type=raw,value={{date 'YYYYMMDD-HHmmss'}}
+          images: ${{ env.REGISTRY }}/gammasim/simtools-${{ matrix.type }}
+          flavor: latest=true
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64/v8
+          push:
+            ${{ github.event_name == 'pull_request' || github.event_name == 'release' || github.event_name == 'workflow_dispatch' }}
+          file: ./docker/Dockerfile-${{ matrix.type }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}-${{ matrix.type }}

gammasimtools-0.5.1/.github/workflows/build-docker-images.yml

@@ -0,0 +1,71 @@
+# https://docs.github.com/en/actions/publishing-packages/publishing-docker-images
+name: docker-simtools
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+  pull_request:
+    branches: ["main"]
+  release:
+    types: [published]
+  schedule:
+    - cron: '0 0 * * 0'  # Every Sunday at 00:00 UTC
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+
+  build-simtools-container:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        type: ['dev', 'prod']
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          tags: |
+            type=ref,event=pr
+            type=semver,pattern={{major}}.{{minor}}.{{patch}}
+            type=schedule,pattern={{date 'YYYYMMDD'}}
+            type=raw,value={{date 'YYYYMMDD-HHmmss'}}
+          images: ${{ env.REGISTRY }}/gammasim/simtools-${{ matrix.type }}
+          flavor: latest=true
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64/v8
+          push:
+            ${{ github.event_name == 'pull_request' || github.event_name == 'release' || github.event_name == 'workflow_dispatch' }}
+          file: ./docker/Dockerfile-${{ matrix.type }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}-${{ matrix.type }}

gammasimtools-0.5.1/.github/workflows/pypi.yml

@@ -0,0 +1,33 @@
+# Derived from https://github.com/cta-observatory/project-template-python-pure/blob/main/.github/workflows/pypi.yml
+name: Deploy to PyPi
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      # make sure we have version info
+      - run: git fetch --tags
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install dependencies
+        run: |
+          python --version
+          pip install -U build
+          python -m build
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.pypi_token }}

gammasimtools-0.5.1/.gitignore

@@ -0,0 +1,33 @@
+# Compiled files
+*.py[co]
+*.a
+*.o
+*.so
+__pycache__
+
+# Sphinx
+docs/build
+
+# DB config gfile
+dbDetails.yml
+
+# set environment
+set_env_db.sh
+
+# Mac users
+.DS_Store
+
+telarray_rand.conf*
+
+# Distribution / packaging
+build/
+*.egg-info/
+.egg
+
+# Generic output path of
+# simtools data products
+simtools-output
+
+# Dynamic version file
+# generated by setuptools_scm
+simtools/_version.py

gammasimtools-0.5.1/.mailmap

@@ -0,0 +1,3 @@
+RaulRPrado <raul.prado@desy.de> RaulRPrado <raul.prado@usp.br>
+RaulRPrado <raul.prado@desy.de> RaulRPrado <raul.ribeiro.prado@gmail.com>
+RaulRPrado <raul.prado@desy.de> RaulRPrado <32486249+RaulRPrado@users.noreply.github.com>

gammasimtools-0.5.1/.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+  # https://pycqa.github.io/isort/docs/configuration/black_compatibility.html#integration-with-pre-commit
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ["--profile", "black", "--filter-files"]
+  - repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+      - id: black
+        args: ["--line-length=100"]
+  # https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html?highlight=other%20tools#flake8
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        args: ["--max-line-length=100", "--extend-ignore=E203,E712"]
+  # https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  # https://github.com/HunterMcGushion/docstr_coverage
+  - repo: https://github.com/HunterMcGushion/docstr_coverage
+    rev: v2.3.0 # most recent docstr-coverage release or commit sha
+    hooks:
+      - id: docstr-coverage
+        args: ["--verbose", "2", "--fail-under", "70.", "simtools"]

gammasimtools-0.5.1/CITATION.cff

@@ -0,0 +1,31 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: >-
+  simtools - a prototype implementation of
+  tools for the Simulation System of the CTA
+  Observatory
+message: Please cite this software using these metadata.
+type: software
+authors:
+  - orcid: 'https://orcid.org/0000-0001-9152-2995'
+    affiliation: DESY
+    given-names: Raul
+    name-particle: R.
+    family-names: Prado
+  - given-names: Orel
+    family-names: Gueta
+    orcid: 'https://orcid.org/0000-0002-9440-2398'
+    affiliation: DESY
+  - given-names: Victor
+    family-names: Barbosa Martins
+    orcid: 'https://orcid.org/0000-0002-5085-8828'
+    affiliation: DESY
+  - given-names: Gernot
+    family-names: Maier
+    affiliation: DESY
+    orcid: 'https://orcid.org/0000-0001-9868-4700'
+repository-code: 'https://github.com/gammasim/simtools'
+doi: 10.5281/zenodo.6346697
+license: BSD-3-Clause

gammasimtools-0.5.1/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, gammasim-tools, simtools developers
+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.