Merge latest main to cpp_msglib

Signed-off-by: Xu, He <[email protected]>

.github/ISSUE_TEMPLATE.md

@@ -17,19 +17,19 @@ Objective of issue:
 
 **Lava version:**
 <!-- remove versions not chosen below -->
-- [ ] **0.6.0** (feature release)
-- [ ] **0.5.1** (bug fixes)
-- [x] **0.5.0** (current version)
-- [ ] **0.4.1**
-- [ ] **0.4.0**
-- [ ] **0.3.0**
-- [ ] **0.1.2**
+-   [ ] **0.6.0** (feature release)
+-   [ ] **0.5.1** (bug fixes)
+-   [x] **0.5.0** (current version)
+-   [ ] **0.4.1**
+-   [ ] **0.4.0**
+-   [ ] **0.3.0**
+-   [ ] **0.1.2**
 
 **I'm submitting a ...** 
 <!--  (Mark one with "x") remove not chosen below -->
-- [ ] bug report
-- [ ] feature request
-- [ ] documentation request
+-   [ ] bug report
+-   [ ] feature request
+-   [ ] documentation request
 
 <!-- Please do not submit support requests or "How to" questions here, use discussions Q&A https://github.com/lava-nc/lava/discussions/categories/q-a -->
 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -22,12 +22,12 @@ A clear and concise description of what the bug is.
 
 **To reproduce current behavior**
 Steps to reproduce the behavior:
-1. When I run this code (add code or minimum test case) ...
+1.  When I run this code (add code or minimum test case) ...
 ```python
 def my_code():
     pass
 ```
-2. I get this error ...
+2.  I get this error ...
 ```
 Error...
 ```
@@ -39,9 +39,9 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem. Remove section otherwise.
 
 **Environment (please complete the following information):**
- - Device: [e.g. Laptop, Intel cloud]
- - OS: [e.g. Linux]
- - Lava version [e.g. 0.6.1]
+-   Device: [e.g. Laptop, Intel cloud]
+-   OS: [e.g. Linux]
+-   Lava version [e.g. 0.6.1]
 
 **Additional context**
 Add any other context about the problem here. Remove section otherwise.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -11,8 +11,8 @@ assignees: ''
 As a user, I want to [capability] to [benefit].
 
 ### Conditions of satisfaction
-- An optional list of conditions that have to be fulfilled for this feature to be complete.
-- For example: "Users can add both individual items and lists as parameters."
+-   An optional list of conditions that have to be fulfilled for this feature to be complete.
+-   For example: "Users can add both individual items and lists as parameters."
 
 ### Acceptance tests
-- An optional list of tests that should be written to automatically test the new feature.
+-   An optional list of tests that should be written to automatically test the new feature.

.github/PULL_REQUEST_TEMPLATE.md

@@ -12,13 +12,13 @@ Objective of pull request:
 ## Pull request checklist
 <!--  (Mark with "x") -->
 Your PR fulfills the following requirements:
-- [ ] [Issue](https://github.com/lava-nc/lava/issues) created that explains the change and why it's needed
-- [ ] Tests are part of the PR (for bug fixes / features)
-- [ ] [Docs](https://github.com/lava-nc/docs) reviewed and added / updated if needed (for bug fixes / features)
-- [ ] PR conforms to [Coding Conventions](https://lava-nc.org/developer_guide.html#coding-conventions)
-- [ ] [PR applys BSD 3-clause or LGPL2.1+ Licenses](https://lava-nc.org/developer_guide.html#add-a-license) to all code files
-- [ ] Lint (`flakeheaven lint src/lava tests/`) and (`bandit -r src/lava/.`) pass locally
-- [ ] Build tests (`pytest`) passes locally
+-   [ ] [Issue](https://github.com/lava-nc/lava/issues) created that explains the change and why it's needed
+-   [ ] Tests are part of the PR (for bug fixes / features)
+-   [ ] [Docs](https://github.com/lava-nc/docs) reviewed and added / updated if needed (for bug fixes / features)
+-   [ ] PR conforms to [Coding Conventions](https://lava-nc.org/developer_guide.html#coding-conventions)
+-   [ ] [PR applys BSD 3-clause or LGPL2.1+ Licenses](https://lava-nc.org/developer_guide.html#add-a-license) to all code files
+-   [ ] Lint (`flakeheaven lint src/lava tests/`) and (`bandit -r src/lava/.`) pass locally
+-   [ ] Build tests (`pytest`) passes locally
 
 
 ## Pull request type
@@ -30,13 +30,13 @@ Your PR fulfills the following requirements:
 Please check your PR type:
 <!--  (Mark one with "x") remove not chosen below -->
 
-- [ ] Bugfix
-- [ ] Feature
-- [ ] Code style update (formatting, renaming)
-- [ ] Refactoring (no functional changes, no api changes)
-- [ ] Build related changes
-- [ ] Documentation changes
-- [ ] Other (please describe): 
+-   [ ] Bugfix
+-   [ ] Feature
+-   [ ] Code style update (formatting, renaming)
+-   [ ] Refactoring (no functional changes, no api changes)
+-   [ ] Build related changes
+-   [ ] Documentation changes
+-   [ ] Other (please describe): 
 
 
 ## What is the current behavior?
@@ -50,8 +50,8 @@ Please check your PR type:
 ## Does this introduce a breaking change?
 <!--  (Mark one with "x") remove not chosen below -->
 
-- [ ] Yes
-- [ ] No
+-   [ ] Yes
+-   [ ] No
 
 <!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->
 

.github/workflows/cd.yml

@@ -99,7 +99,7 @@ jobs:
           python3.9 -m venv artifact-unittest
           source artifact-unittest/bin/activate
           pip install -U pip
-          pip install nbconvert>=7.2.2 pytest>=7.2.0 matplotlib>=3.5.1 ipykernel>=6.15.0 nbformat>=5.3.0 nbconvert>=7.2.2
+          pip install "nbconvert>=7.2.10,<7.3" pytest>=7.2.0 matplotlib>=3.5.1 ipykernel>=6.15.0 nbformat>=5.3.0
           artifact=$(ls | grep lava | grep tar)
           pip install --no-input $artifact          
           tar -xvf $artifact
@@ -118,7 +118,7 @@ jobs:
           python3.9 -m venv artifact-unittest
           source artifact-unittest/bin/activate
           pip install -U pip
-          pip install nbconvert>=7.2.2 pytest>=7.2.0 matplotlib>=3.5.1 ipykernel>=6.15.0 nbformat>=5.3.0 nbconvert>=7.2.2
+          pip install "nbconvert>=7.2.10,<7.3" pytest>=7.2.0 matplotlib>=3.5.1 ipykernel>=6.15.0 nbformat>=5.3.0
           artifact=$(ls | grep lava | grep whl)
           pip install --no-input $artifact
           # Change $artifact to tar.gz

.github/workflows/ci.yml

@@ -81,8 +81,19 @@ jobs:
       run: |
         poetry run git lfs fetch
         poetry run git lfs pull
-        # poetry run pytest
-        poetry run python -m unittest discover -s tests/ -t . -vv
+        poetry run coverage run -m unittest discover -s tests/ -t . -vv
+        
+    - name: Generate coverage report
+      if: runner.os == 'Linux'
+      run: poetry run coverage xml
+
+    - name: Archive coverage report
+      if: runner.os == 'Linux'
+      uses: actions/upload-artifact@v3
+      with:
+        name: coverage
+        path: coverage.xml
+        retention-days: 30
 
   msg-infr-unit-tests:
     name: Message Infrastructure Unit Test

.github/workflows/codacy_coverage_reporter.yml

@@ -0,0 +1,29 @@
+name: Codacy Coverage Reporter
+
+on:
+  workflow_run:
+     workflows: ["Run CI"]
+     types: [completed]
+     branches: [main]
+  workflow_dispatch:
+
+jobs:
+  codacy-coverage-reporter:
+     runs-on: ubuntu-latest
+     if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+     name: codacy-coverage-reporter
+     steps:
+       - name: Download artifact
+         uses: dawidd6/action-download-artifact@v2
+         with:
+           workflow: ci.yml
+           workflow_conclusion: "success"
+           branch: main
+           event: push
+           name: coverage
+
+       - name: Run codacy-coverage-reporter
+         uses: codacy/codacy-coverage-reporter-action@v1
+         with:
+           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+           coverage-reports: coverage.xml

README.md

@@ -3,6 +3,11 @@
   A Software Framework for Neuromorphic Computing
 </b></p>
 
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/40792fa7db054279bdf7532e36f0cfab)](https://app.codacy.com/gh/lava-nc/lava/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/40792fa7db054279bdf7532e36f0cfab)](https://app.codacy.com/gh/lava-nc/lava/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
+
+If you like lava and want to support it, the easiest way is to star our repo (click star in the upper right corner).
+
 # Overview
 
 Lava is an open source SW framework to develop applications for
@@ -35,22 +40,13 @@ supporting architectures like Intel Loihi may remain proprietary
 to Intel and will be shared as extensions to eligible users.
 
 >### Lava extension for Intel's Loihi
->The Lava extension for Loihi is available for members of the Intel
-Neuromorphic Research Community (INRC). The extension enables execution of
-Lava on Intel's Loihi hardware platform.
+>The Lava extension for Loihi is available for members of the Intel Neuromorphic Research Community (INRC). The extension enables execution of Lava on Intel's Loihi hardware platform.
 >
->Developers interested in using Lava with Loihi systems need to join the
-INRC. Loihi 1 and 2 research systems are currently not available
-commercially. Once a member of the INRC, developers will gain access to
-cloud-hosted Loihi systems or may be able to obtain physical Loihi systems on a
-loan basis.
+>Developers interested in using Lava with Loihi systems need to join the INRC. Loihi 1 and 2 research systems are currently not available commercially. Once a member of the INRC, developers will gain access to cloud-hosted Loihi systems or may be able to obtain physical Loihi systems on a loan basis.
 >
->To join the INRC, visit [http://neuromorphic.intel.com](http://neuromorphic.intel.com)
-or email at [[email protected]](mailto:[email protected]).
+>To join the INRC, visit [http://neuromorphic.intel.com](http://neuromorphic.intel.com) or email at [[email protected]](mailto:[email protected]).
 >
-> If you are already a member of the INRC, please read how to [get
-  started with the Lava extension for Loihi.](https://intel-ncl.atlassian.net/wiki/spaces/NAP/pages/1785856001/Get+started+with+the+Lava+extension+for+Loihi)
-> This page is **only** accessible to members of the INRC.
+> If you are already a member of the INRC, please read how to [get started with the Lava extension for Loihi](https://intel-ncl.atlassian.net/wiki/spaces/NAP/pages/1785856001/Get+started+with+the+Lava+extension+for+Loihi). This page is **only** accessible to members of the INRC.
 
 
 # Getting started
@@ -70,7 +66,7 @@ will need to install the `poetry` Python package.
 
 Open a **python 3** terminal and run based on the OS you are on:
 
-### [Linux/MacOS]
+### Linux/MacOS
 
 ```bash
 cd $HOME
@@ -87,7 +83,7 @@ pytest
 ## See FAQ for more info: https://github.com/lava-nc/lava/wiki/Frequently-Asked-Questions-(FAQ)#install
 ```
 
-### [Windows]
+### Windows
 
 ```powershell
 # Commands using PowerShell
@@ -140,7 +136,7 @@ Required test coverage of 85.0% reached. Total coverage: 88.81%
 
 ```
 
-## [Alternative] Installing Lava via Conda
+## Alternative: Installing Lava via Conda
 
 If you use the Conda package manager, you can simply install the Lava package
 via:
@@ -158,7 +154,7 @@ conda install -n lava -c intel numpy scipy
 conda install -n lava -c conda-forge lava --freeze-installed
 ```
 
-## [Alternative] Installing Lava from binaries
+## Alternative: Installing Lava from binaries
 
 If you only need to install Lava as a user in your python environment, we will
 publish Lava releases via
@@ -167,7 +163,7 @@ the package and install it.
 
 Open a Python terminal and run:
 
-### [Windows/MacOS/Linux]
+### Windows/MacOS/Linux
 
 ```bash
 python -m venv .venv
@@ -203,7 +199,7 @@ bandit -r src/lava/.
 bandit -r src/lava/. --format custom --msg-template '{abspath}:{line}: {test_id}[bandit]: {severity}: {msg}'
 ```
 ##
-> Refer to the tutorials directory for in-depth as well as end-to-end tutorials on how to write Lava Processes, connect them, and execute the code.
+>Refer to the tutorials directory for in-depth as well as end-to-end tutorials on how to write Lava Processes, connect them, and execute the code.
 
 # Stay in touch