Initial release of lava-dnf v0.1.0

.github/workflows/ci-build.yml

@@ -18,11 +18,9 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pybuilder
-
     - name: Run pybuilder w/o unit tests
       run: |
         pyb analyze
-
   security-lint:
     name: Security Lint with bandit
     runs-on: ubuntu-latest
@@ -39,17 +37,15 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pybuilder
-
     - name: Run pybuilder to lint security w/ bandit
       run: |
         pyb bandit
-
   unit-tests:
     name: Run unit tests
     runs-on: ${{ matrix.operating-system }}
     strategy:
       matrix:
-        operating-system: [ubuntu-latest, windows-latest, macos-latest]
+        operating-system: [ubuntu-latest, macos-latest]
 
     steps:
     - uses: actions/checkout@v2
@@ -63,7 +59,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
-
+        pip install pybuilder
     - name: Run unit tests
       run: |
-        python -m unittest discover -s tests -p "test_*.py" -vvv
+        pyb -E unit

.gitignore

@@ -113,6 +113,9 @@ venv.bak/
 .spyderproject
 .spyproject
 
+# vscode project settings
+.vscode/
+
 # Rope project settings
 .ropeproject
 

README.md

@@ -41,29 +41,21 @@ Examples demonstrating basic DNF regimes and instabilities
 - Detection of input
 - Selection of input
 - Working memory of input
-- Neural oscillator
-
-Infrastructure
-- Sensor and data input/output
-- Plotting
 
 ## Example
 
 ```python
-from lava.lib.dnf.populations import Population
-from lava.lib.dnf.kernels import SelectiveKernel
-from lava.lib.dnf.connect import connect
-from lava.lib.dnf.operations import Instar, OneToOne
+from lava.proc.lif.process import LIF
+from lava.lib.dnf.kernels.kernels import SelectiveKernel
+from lava.lib.dnf.connect.connect import connect
+from lava.lib.dnf.operations.operations import Convolution
 
 # create population of 20x20 spiking neurons
-dnf = Population(shape=(20, 20))
+dnf = LIF(shape=(20, 20))
 
 # create a selective kernel
 kernel = SelectiveKernel(amp_exc=18, width_exc=[4, 4], global_inh=-15)
 
 # apply the kernel to the population to create a DNF with a selective regime
-connect(dnf, dnf, [Instar(kernel)])
+connect(dnf.s_out, dnf.a_in, [Convolution(kernel)])
 ```
-
-
-

build.py

@@ -7,22 +7,22 @@
 # use_plugin("python.coverage")
 use_plugin("python.distutils")
 use_plugin("python.sphinx")
-use_plugin('python.install_dependencies')
+use_plugin("python.install_dependencies")
 use_plugin("python.pycharm")
-use_plugin('pypi:pybuilder_bandit')
+use_plugin("pypi:pybuilder_bandit")
 
-name = "lava-nc/lava-dnf"
+name = "lava-dnf"
 default_task = ["analyze", "publish"]
 version = "0.1.0"
-summary = "A library that provides processes and other software infrastructure to build architectures composed of Dynamic Neural Fields (DNF). This library also provides tools to direct sensory input to neural architectures and to read output, for instance for motor control. Lava-DNF is part of Lava Framework "
+summary = "A library that provides processes and other software infrastructure to build architectures composed of Dynamic Neural Fields (DNF)."
 url = "https://lava-nc.org"
 license = ["BSD-3-Clause"]
 
 
 @init
 def set_properties(project):
-    project.set_property("dir_source_main_python", "src/lava")
-    project.set_property("dir_source_unittest_python", "tests")
+    project.set_property("dir_source_main_python", "src")
+    project.set_property("dir_source_unittest_python", "tests/lava")
     project.set_property("dir_source_main_scripts", "scripts")
     project.set_property("dir_docs", "docs")
 
@@ -53,20 +53,21 @@ def set_properties(project):
         "target/*,.svn,CVS,.bzr,.hg,.git,__pycache__,.pybuilder/*",
     )
 
-    project.get_property('distutils_commands').append('build')
-    project.get_property('distutils_commands').append('sdist')
-    project.get_property('distutils_commands').append('bdist_dumb')
+    project.get_property("distutils_commands").append("build")
+    project.get_property("distutils_commands").append("sdist")
+    project.get_property("distutils_commands").append("bdist_dumb")
 
-    project.set_property('bandit_break_build', True)
-    project.set_property('bandit_include_testsources', False)
+    project.set_property("bandit_break_build", True)
+    project.set_property("bandit_include_testsources", False)
 
 
 @init(environments="unit")
 def set_properties_unit(project):
-    project.set_property("dir_source_main_python", "src/lava")
-    project.set_property("dir_source_unittest_python", "tests")
+    project.set_property("dir_source_main_python", "src")
+    project.set_property("dir_source_unittest_python", "tests/lava")
     project.set_property("dir_source_main_scripts", "scripts")
     project.set_property("dir_docs", "docs")
+    project.build_depends_on("lava", url="git+https://github.com/lava-nc/lava.git")
 
     project.set_property("sphinx_config_path", "docs")
     project.set_property("sphinx_source_dir", "docs")
@@ -82,7 +83,7 @@ def set_properties_unit(project):
     project.plugin_depends_on("sphinx_tabs")
 
     project.set_property("verbose", True)
-    
+
     project.set_property("coverage_threshold_warn", 0)
     project.set_property("coverage_break_build", False)
 
@@ -96,5 +97,5 @@ def set_properties_unit(project):
 
     project.set_property("unittest_module_glob", "test_*")
 
-    project.set_property('bandit_break_build', True)
-    project.set_property('bandit_include_testsources', False)
+    project.set_property("bandit_break_build", True)
+    project.set_property("bandit_include_testsources", False)

requirements.txt

@@ -0,0 +1,3 @@
+lava-nc@git+https://github.com/lava-nc/lava.git
+numpy
+scipy>=1.7.2

setup.py

@@ -33,6 +33,7 @@
 import shutil
 
 from sys import version_info
+
 py3 = version_info[0] == 3
 py2 = not py3
 if py2:
@@ -41,7 +42,9 @@
 
 def install_pyb():
     try:
-        subprocess.check_call([sys.executable, "-m", "pip", "install", "pybuilder"])
+        subprocess.check_call(
+            [sys.executable, "-m", "pip", "install", "pybuilder"]
+        )
     except subprocess.CalledProcessError as e:
         sys.exit(e.returncode)
 
@@ -64,11 +67,13 @@ def install_pyb():
 
 try:
     from pybuilder.cli import main
+
     # verbose, debug, skip all optional...
     if main("-v", "-X", "-o", "--reset-plugins", "clean", "package"):
         raise RuntimeError("PyBuilder build failed")
 
     from pybuilder.reactor import Reactor
+
     reactor = Reactor.current_instance()
     project = reactor.project
     dist_dir = project.expand_path("$dir_dist")
@@ -83,7 +88,9 @@ def install_pyb():
                 os.remove(target_file_name)
         shutil.move(src_file, script_dir)
     setup_args = sys.argv[1:]
-    subprocess.check_call([sys.executable, "setup.py"] + setup_args, cwd=script_dir)
+    subprocess.check_call(
+        [sys.executable, "setup.py"] + setup_args, cwd=script_dir
+    )
 except subprocess.CalledProcessError as e:
     exit_code = e.returncode
 sys.exit(exit_code)