Create release 1.0.0

.github/workflows/build_and_test.yaml

@@ -0,0 +1,38 @@
+# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+name: Build and Test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - '**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+          cache: 'pip'
+          cache-dependency-path: 'requirements.txt'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install pytest
+
+      - name: Run unit tests
+        run: |
+          python -m pytest tests

.github/workflows/static_checks.yaml

@@ -0,0 +1,77 @@
+# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+name: Static code checks
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - '**'
+
+env:
+  LICENSE: AGPL-3.0-or-later
+  FETCH_DEPTH: 1
+  FULL_HISTORY: 0
+  SKIP_WORD_PRESENCE_CHECK: 0
+
+jobs:
+  static-code-check:
+    if: endsWith(github.event.repository.name, 'private')
+
+    name: Run static code checks
+    # See https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu1804-Readme.md for list of packages
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+    - name: Setup history
+      if: github.ref == 'refs/heads/oss'
+      run: |
+        echo "FETCH_DEPTH=0" >> $GITHUB_ENV
+        echo "FULL_HISTORY=1" >> $GITHUB_ENV
+
+    - name: Setup version
+      if: github.ref == 'refs/heads/melco'
+      run: |
+        echo "SKIP_WORD_PRESENCE_CHECK=1" >> $GITHUB_ENV
+
+    - name: Check out code
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: ${{ env.FETCH_DEPTH }} # '0' to check full history
+
+    - name: Set up environment
+      run: git config user.email github-bot@merl.com
+
+    - name: Set up python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+        cache: 'pip'
+        cache-dependency-path: 'requirements-dev.txt'
+
+    - name: Install python packages
+      run: pip install -r requirements-dev.txt
+
+    - name: Ensure lint and pre-commit steps have been run
+      uses: pre-commit/action@v3.0.0
+
+    - name: Check files
+      uses: merl-oss-private/merl-file-check-action@v1
+      with:
+        license: ${{ env.LICENSE }}
+        full-history: ${{ env.FULL_HISTORY }} # If true, use fetch-depth 0 above
+        skip-word-presence-check: ${{ env.SKIP_WORD_PRESENCE_CHECK }}
+
+    - name: Check license compatibility
+      if: github.ref != 'refs/heads/melco'
+      uses: merl-oss-private/merl_license_compatibility_checker@v1
+      with:
+        input-filename: requirements.txt
+        license: ${{ env.LICENSE }}

.gitignore

@@ -1,3 +1,7 @@
+# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -158,3 +162,11 @@ cython_debug/
 #  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/
+
+# Experiment
+lightning_logs/
+log/
+exp/
+*.ckpt
+*.png
+*.wav

.pre-commit-config.yaml

@@ -0,0 +1,63 @@
+# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+#
+# Pre-commit configuration. See https://pre-commit.com
+
+default_language_version:
+  python: python3.10
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-added-large-files
+        args: ['--maxkb=1000']
+
+  - repo: https://gitlab.com/bmares/check-json5
+    rev: v1.0.0
+    hooks:
+      - id: check-json5
+
+  - repo: https://github.com/homebysix/pre-commit-macadmin
+    rev: v1.12.3
+    hooks:
+      - id: check-git-config-email
+        args: ['--domains', 'merl.com']
+
+  - repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+      - id: black
+        args:
+          - --line-length=120
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ["--profile", "black", "--filter-files", "--line-length", "120", "--skip-gitignore"]
+
+  # Uncomment to use pyupgrade (https://github.com/asottile/pyupgrade) to automatically upgrade syntax for newer python
+  # -   repo: https://github.com/asottile/pyupgrade
+  #     rev: v3.3.1
+  #     hooks:
+  #     -   id: pyupgrade
+
+  # To stop flake8 error from causing a failure, use --exit-zero. By default, pre-commit will not show the warnings,
+  # so use verbose: true to see them.
+  - repo: https://github.com/pycqa/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+        # Black compatibility, Eradicate options
+        args: ["--max-line-length=119", "--extend-ignore=E203", "--eradicate-whitelist-extend", "eradicate:\\s*no",
+               "--exit-zero"]
+        verbose: true
+        additional_dependencies: [
+          # https://github.com/myint/eradicate, https://github.com/wemake-services/flake8-eradicate
+          "flake8-eradicate"
+        ]

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+<!--
+Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
+
+SPDX-License-Identifier: AGPL-3.0-or-later
+-->
+# Contributing
+
+Sorry, but we do not currently accept contributions in the form of pull requests to this repository.
+However, you are welcome to post issues (bug reports, feature requests, questions, etc).