isaac-toolkit 0.5.6__tar.gz

isaac_toolkit-0.5.6/.github/workflows/docs.yml

@@ -0,0 +1,47 @@
+---
+name: Build Documentation
+on:
+  push:
+    branches: [main]
+    tags: [v*]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Initialize Virtualenv
+        run: |
+          python -m pip install --upgrade pip virtualenv
+          python -m venv .venv
+      - name: Install package into virtualenv
+        run: |
+          source .venv/bin/activate
+          pip install -e ".[dev]"
+          pip install -e ".[memgraph]"
+          pip install -r docs/requirements.txt
+      - name: Build docs
+        run: |
+          source .venv/bin/activate
+          cd docs
+          make html
+      - name: Store docs as an artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-docs
+          path: docs/_build/html
+      - name: Deploy docs
+        uses: peaceiris/actions-gh-pages@v4
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build/html

isaac_toolkit-0.5.6/.github/workflows/mlonmcu_examples.yml

@@ -0,0 +1,90 @@
+##
+## Copyright (c) 2024 TUM Department of Electrical and Computer Engineering.
+##
+## This file is part of ISAAC Toolkit.
+## See https://github.com/tum-ei-eda/isaac-toolkit.git for further info.
+##
+## 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.
+##
+name: MLonMCU Examples
+on:
+  workflow_dispatch:
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-22.04
+    # runs-on: self-hosted
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+        mlonmcu-ref: ["main"]
+        mlonmcu-template: ["default"]
+        prog: ["toycar"]
+        toolchain: ["gcc"]
+        simulator: ["etiss"]
+        backend: ["tvmaotplus"]
+        # full: ["1"]
+    env:
+      INSTALL_DIR: ${{ github.workspace }}/examples/standalone/install
+      VENV_DIR: ${{ github.workspace }}/venv
+      PYTHONPATH: ${{ github.workspace }}
+      MLONMCU_HOME: ${{ github.workspace }}/workspace
+      PROG: ${{ matrix.prog }}
+      SIMULATOR: ${{ matrix.simulator }}
+      TOOLCHAIN: ${{ matrix.toolchain }}
+      BACKEND: ${{ matrix.backend }}
+      # FULL: ${{ matrix.full }}
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    # TODO: caching
+    - name: Install APT packages
+      run: |
+        sudo apt -qq install -y build-essential git cmake libboost-system-dev libboost-filesystem-dev libboost-program-options-dev libboost-regex-dev kcachegrind graphviz-dev device-tree-compiler
+    - name: Initialize Virtualenv
+      run: |
+        python -m pip install --upgrade pip
+        python -m venv $VENV_DIR
+    - name: Install dependencies
+      run: |
+        source $VENV_DIR/bin/activate
+        pip install -r requirements.txt
+        pip install git+https://github.com/tum-ei-eda/mlonmcu.git@${{ matrix.mlonmcu-ref }}
+    - name: Setup MLonMCU
+      run: |
+        source $VENV_DIR/bin/activate
+        mlonmcu init $MLONMCU_HOME -t ${{ matrix.mlonmcu-template}} --non-interactive --clone-models --allow-exists
+        mlonmcu setup -g
+        pip install -r $MLONMCU_HOME/requirements_addition.txt
+        mlonmcu setup -v --progress
+    - name: Run MLonMCU example
+      working-directory: examples/mlonmcu
+      run: |
+        source $VENV_DIR/bin/activate
+        export SESS=$(pwd)/sess
+        ./mlonmcu_example.sh $SESS $PROG $TOOLCHAIN $SIMULATOR $BACKEND
+    - name: Archive reports
+      uses: actions/upload-artifact@v4
+      with:
+        name: results-${{ matrix.mlonmcu-ref }}-${{ matrix.mlonmcu-template }}-${{ matrix.program }}-${{ matrix.toolchain }}-${{ matrix.simulator }}-${{ matrix.backend }}
+        path: |
+          examples/mlonmcu/sess/
+          examples/mlonmcu/*.pdf
+          examples/mlonmcu/*.out
+          !examples/mlonmcu/sess/elf
+          !examples/mlonmcu/sess/instr_trace/

isaac_toolkit-0.5.6/.github/workflows/release.yml

@@ -0,0 +1,51 @@
+---
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - \d+.\d+.\d+  # Push events for 0.1.0, 20.15.10 but not 0.1.0dev0
+name: Create Release
+jobs:
+  build:
+    name: Create Release
+    runs-on: ubuntu-latest
+    if: ${{ github.repository == 'tum-ei-eda/isaac-toolkit' }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      # - name: Generate changelog
+      #   id: changelog
+      #   uses: metcalfc/changelog-generator@v4.3.1
+      #   with:
+      #     myToken: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          # body: |
+          #   Changes in this Release:
+          #   ${{ steps.changelog.outputs.changelog }}
+          draft: true
+          prerelease: false
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    if: ${{ github.repository == 'tum-ei-eda/isaac-toolkit' }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install deps
+        run: |
+          sudo apt install libgraphviz-dev
+      - name: Build package
+        run: |
+          python -m pip install -e ".[dev]"
+          python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

isaac_toolkit-0.5.6/.github/workflows/standalone_examples.yml

@@ -0,0 +1,208 @@
+##
+## Copyright (c) 2024 TUM Department of Electrical and Computer Engineering.
+##
+## This file is part of ISAAC Toolkit.
+## See https://github.com/tum-ei-eda/isaac-toolkit.git for further info.
+##
+## 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.
+##
+name: Standalone Examples
+on:
+  workflow_dispatch:
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-22.04
+    # runs-on: self-hosted
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+        toolchain: ["gcc"]
+        # simulator: ["etiss", "spike"]
+        simulator: ["etiss"]
+        full: ["0", "1"]
+    env:
+      INSTALL_DIR: ${{ github.workspace }}/examples/standalone/install
+      VENV_DIR: ${{ github.workspace }}/venv
+      PYTHONPATH: ${{ github.workspace }}
+      RISCV_NAME: "riscv32-unknown-elf"
+      RISCV_ARCH: "rv32im_zicsr_zifencei"
+      RISCV_ABI: "ilp32"
+      SIMULATOR: ${{ matrix.simulator }}
+      TOOLCHAIN: ${{ matrix.toolchain }}
+      FULL: ${{ matrix.full }}
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    # TODO: caching
+    - name: Install APT packages
+      run: |
+        sudo apt -qq install -y build-essential git cmake libboost-system-dev libboost-filesystem-dev libboost-program-options-dev kcachegrind graphviz-dev
+    - name: Initialize Virtualenv
+      run: |
+        python -m pip install --upgrade pip
+        python -m venv $VENV_DIR
+    - name: Install dependencies
+      run: |
+        source $VENV_DIR/bin/activate
+        pip install -r requirements.txt
+    - name: Setup dependencies
+      working-directory: examples/standalone
+      run: |
+        ./scripts/download_helper.sh $INSTALL_DIR/rv32im_ilp32/ gnu 2024.09.03 rv32im_zicsr_zifencei_ilp32
+
+        if [[ "$TOOLCHAIN" == "llvm" ]]
+        then
+            ./scripts/download_helper.sh $INSTALL_DIR/llvm/ llvm 19.1.1
+        fi
+
+        if [[ "$SIMULATOR" == "etiss" ]]
+        then
+            ./scripts/setup_etiss.sh $INSTALL_DIR/etiss
+        fi
+    - name: Run Coremark example
+      working-directory: examples/standalone/coremark
+      run: |
+        source $VENV_DIR/bin/activate
+
+        export SESS=$(pwd)/sess
+        export BUILD_DIR=$(pwd)/build
+
+        export RISCV_PREFIX=$INSTALL_DIR/rv32im_ilp32
+        export SYSROOT=$RISCV_PREFIX/$RISCV_NAME
+        export CC=$RISCV_PREFIX/bin/$RISCV_NAME-gcc
+        export OBJDUMP=$RISCV_PREFIX/bin/$RISCV_NAME-objdump
+
+        if [[ "$SIMULATOR" == "etiss" ]]
+        then
+            export ETISS=$INSTALL_DIR/etiss/install/bin/run_helper.sh
+            export ETISS_INI=$INSTALL_DIR/etiss/install/custom.ini
+            export ETISS_CRT=$INSTALL_DIR/etiss/etiss_riscv_examples/riscv_crt0
+            export ETISS_LDSCRIPT=$INSTALL_DIR/etiss/install/etiss.ld
+        elif [[ "$SIMULATOR" == "spike" ]]
+        then
+            export SIMULATOR=spike
+            export SPIKE=$INSTALL_DIR/spike/spike
+            export PK=$INSTALL_DIR/spike/pk_rv32gc
+        else
+            echo "Unsupported SIMULATOR=$SIMULATOR"
+            exit 1
+        fi
+
+        python3 -m isaac_toolkit.session.create --session $SESS
+
+        mkdir -p $BUILD_DIR
+        if [[ "$SIMULATOR" == "etiss" ]]
+        then
+            $CC -march=$RISCV_ARCH -mabi=$RISCV_ABI src/*.c $ETISS_CRT/crt0.S $ETISS_CRT/trap_handler.c -T $ETISS_LDSCRIPT -nostdlib -lc -lgcc -lsemihost -o $BUILD_DIR/coremark.elf -Iinc/ -DITERATIONS=100 -DFLAGS_STR='"testing"' -DPERFORMANCE_RUN -DHAS_STDIO -g -O3 -Xlinker -Map=build/coremark.map
+        elif [[ "$SIMULATOR" == "spike" ]]
+        then
+            $CC -march=$RISCV_ARCH -mabi=$RISCV_ABI src/*.c -o $BUILD_DIR/coremark.elf -Iinc/ -DITERATIONS=100 -DFLAGS_STR='"testing"' -DPERFORMANCE_RUN -DHAS_STDIO -g -O3 -Xlinker -Map=build/coremark.map
+        else
+            echo "Unsupported SIMULATOR=$SIMULATOR"
+            exit 1
+        fi
+        if [[ "$FULL" == "1" ]]
+        then
+            $OBJDUMP -d $BUILD_DIR/coremark.elf > $BUILD_DIR/coremark.dump
+        fi
+
+        python3 -m isaac_toolkit.frontend.elf.riscv --session $SESS $BUILD_DIR/coremark.elf
+
+        if [[ "$FULL" == "1" ]]
+        then
+            python3 -m isaac_toolkit.frontend.linker_map --session $SESS $BUILD_DIR/coremark.map
+            python3 -m isaac_toolkit.frontend.disass.objdump --session $SESS $BUILD_DIR/coremark.dump
+        fi
+
+        python3 -m isaac_toolkit.analysis.static.dwarf --session $SESS
+        python3 -m isaac_toolkit.analysis.static.mem_footprint --session $SESS
+
+        if [[ "$FULL" == "1" ]]
+        then
+            python3 -m isaac_toolkit.analysis.static.linker_map --session $SESS
+            python3 -m isaac_toolkit.analysis.static.histogram.disass_instr --session $SESS
+            python3 -m isaac_toolkit.analysis.static.histogram.disass_opcode --session $SESS
+        fi
+
+        python3 -m isaac_toolkit.visualize.pie.mem_footprint --session $SESS --legend
+
+        if [[ "$FULL" == "1" ]]
+        then
+            python3 -m isaac_toolkit.visualize.pie.disass_counts --session $SESS --legend
+        fi
+
+        if [[ "$SIMULATOR" == "etiss" ]]
+        then
+            $ETISS build/coremark.elf -i$ETISS_INI -pPrintInstruction | grep "^0x00000000" > etiss_instrs.log
+        elif [[ "$SIMULATOR" == "spike" ]]
+        then
+            $SPIKE --isa=${ARCH}_zicntr -l --log=spike_instrs.log $PK $BUILD_DIR/coremark.elf -s
+        else
+            echo "Unsupported SIMULATOR=$SIMULATOR"
+            exit 1
+        fi
+
+        # if [[ "$FULL" == "1" && "$SIMULATOR" == "etiss" ]]
+        if [[ "$FULL" == "1" && "$SIMULATOR" == "etiss" && "1" == "0" ]]  # disabled due to RAM issues
+        then
+            python3 -m isaac_toolkit.frontend.instr_trace.${SIMULATOR} ${SIMULATOR}_instrs.log --session $SESS --operands
+        else
+            python3 -m isaac_toolkit.frontend.instr_trace.${SIMULATOR} ${SIMULATOR}_instrs.log --session $SESS
+        fi
+
+        python3 -m isaac_toolkit.analysis.dynamic.histogram.opcode --session $SESS
+        python3 -m isaac_toolkit.analysis.dynamic.histogram.instr --session $SESS
+        python3 -m isaac_toolkit.analysis.dynamic.trace.basic_blocks --session $SESS
+
+        if [[ "$FULL" == "1" ]]
+        then
+            python3 -m isaac_toolkit.analysis.dynamic.trace.track_used_functions --session $SESS
+            # if [[ "$SIMULATOR" == "etiss" ]]
+            if [[ "$SIMULATOR" == "etiss" && "1" == "0" ]]  # disabled due to RAM issues
+            then
+                python3 -m isaac_toolkit.analysis.dynamic.trace.instr_operands --session $SESS --imm-only
+            fi
+        fi
+
+        python3 -m isaac_toolkit.visualize.pie.runtime --session $SESS --legend
+
+        if [[ "$FULL" == "1" ]]
+        then
+            python3 -m isaac_toolkit.visualize.pie.mem_footprint --session $SESS --legend --force
+        fi
+
+        python3 -m isaac_toolkit.backend.profile.callgrind --session $SESS --dump-pos --output callgrind_pos.out
+        python3 -m isaac_toolkit.backend.profile.callgrind --session $SESS --dump-pc --output callgrind_pc.out
+
+        # Callgraph
+        gprof2dot --format=callgrind --output=callgraph.dot callgrind_pos.out -n 0.1 -e 0.1 --color-nodes-by-selftime
+        dot -Tpdf callgraph.dot > callgraph.pdf
+
+        # Annotate source code (ASCII)
+        callgrind_annotate callgrind_pos.out src/*.c
+    - name: Archive reports
+      uses: actions/upload-artifact@v4
+      with:
+        name: results-${{ matrix.toolchain }}-${{ matrix.simulator }}-${{ matrix.full }}
+        path: |
+          examples/standalone/coremark/sess/
+          examples/standalone/coremark/*.pdf
+          examples/standalone/coremark/*.out
+          !examples/standalone/coremark/sess/elf
+          !examples/standalone/coremark/sess/instr_trace/

isaac_toolkit-0.5.6/.github/workflows/style.yml

@@ -0,0 +1,52 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  run-linters:
+    name: Run linters
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install Python dependencies
+        run: pip install black flake8
+
+      - name: Run linters
+        uses: wearerequired/lint-action@v2
+        with:
+          black: true
+          flake8: true
+
+  check-license:
+    name: Check for License headers
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Install Python dependencies
+        run: pip install licenseheaders
+
+      - name: Download template file
+        run: wget https://raw.githubusercontent.com/johann-petrak/licenseheaders/master/templates/apache-2.tmpl
+
+      - name: Run check
+        run: |
+          licenseheaders -t apache-2.tmpl -y "${YEARS}" -o "${OWNER}" -n "${PROJECT}" -u "${URL}" -d isaac_toolkit/ -E "${EXTENSIONS}"
+          licenseheaders -t apache-2.tmpl -y "${YEARS}" -o "${OWNER}" -n "${PROJECT}" -u "${URL}" -d tests/ -E "${EXTENSIONS}"
+          test -z "$(git status --untracked-files=no --porcelain)" || (echo "Please check your license headers!" ; git status --untracked-files=no --porcelain ; false) && echo "License check was successful."
+        env:
+          OWNER: "TUM Department of Electrical and Computer Engineering"
+          PROJECT: "ISAAC Toolkit"
+          YEARS: "2025"
+          URL: "https://github.com/tum-ei-eda/isaac-toolkit.git"
+          EXTENSIONS: "py"

isaac_toolkit-0.5.6/.github/workflows/test.yml

@@ -0,0 +1,81 @@
+##
+## Copyright (c) 2024 TUM Department of Electrical and Computer Engineering.
+##
+## This file is part of ISAAC Toolkit.
+## See https://github.com/tum-ei-eda/isaac-toolkit.git for further info.
+##
+## 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.
+##
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  unit-test:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+    env:
+      VENV_DIR: ${{ github.workspace }}/venv
+      PYTHONPATH: ${{ github.workspace }}
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Install APT packages
+      run: |
+        sudo apt -qq install -y graphviz-dev
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Initialize Virtualenv
+      run: |
+        python -m pip install --upgrade pip
+        python -m venv $VENV_DIR
+    - name: Install dependencies
+      run: |
+        source $VENV_DIR/bin/activate
+        pip install -r requirements_dev.txt
+    - name: Run Pytest (via coverage)
+      run: |
+        source $VENV_DIR/bin/activate
+
+        # Without coverage:
+        # python3 -m pytest tests/ -rs -s
+
+        # With coverage:
+        coverage run --source isaac_toolkit -m pytest tests/
+        coverage report -m
+        coverage html
+    - name: Archive code coverage html report
+      uses: actions/upload-artifact@v4
+      with:
+        name: code-coverage-report
+        path: htmlcov
+    - name: Get coverage percentage
+      id: report
+      run: |
+        source $VENV_DIR/bin/activate
+        echo "name=percent::$(coverage report | awk '$1 == \"TOTAL\" {print $NF+0 \"%\"}')" >> $GITHUB_OUTPUT
+    - name: Test coverage Text
+      run: echo "|${{ steps.report.outputs.percent }}|"
+    - name: Create coverage badge
+      uses: RubbaBoy/BYOB@v1.2.1
+      with:
+        NAME: coverage
+        LABEL: 'Coverage'
+        STATUS: "${{ steps.report.outputs.percent }}"
+        COLOR: blue
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

isaac_toolkit-0.5.6/.gitignore

@@ -0,0 +1,167 @@
+# 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/
+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/
+cover/
+
+# 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/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# ISAAC specifc
+*.elf
+sess*/
+!session/