Merge pull request #276 from neuromore/master

Version 1.7.1
neuromore · May 12, 2023 · 58c28bd · 58c28bd
2 parents 354f784 + 8f6b610
commit 58c28bd
Show file tree

Hide file tree

Showing 188 changed files with 88,825 additions and 121 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -5,6 +5,7 @@
 
 /visualizations/**/*.resS                  filter=lfs diff=lfs merge=lfs -text
 /visualizations/**/*.assets                filter=lfs diff=lfs merge=lfs -text
+/visualizations/**/*.resource              filter=lfs diff=lfs merge=lfs -text
 /visualizations/**/UnityPlayer.dylib       filter=lfs diff=lfs merge=lfs -text
 /visualizations/**/UnityPlayer.dll         filter=lfs diff=lfs merge=lfs -text
 /visualizations/**/UnityPlayer.so          filter=lfs diff=lfs merge=lfs -text
@@ -13,3 +14,10 @@
 /visualizations/**/UnityCrashHandler32.exe filter=lfs diff=lfs merge=lfs -text
 /visualizations/**/level0                  filter=lfs diff=lfs merge=lfs -text
 /visualizations/**/level1                  filter=lfs diff=lfs merge=lfs -text
+
+# Old Unity 5.6 has large binaries instead of large lib
+
+/visualizations/**/CartoonTown             filter=lfs diff=lfs merge=lfs -text
+/visualizations/**/CartoonTown.exe         filter=lfs diff=lfs merge=lfs -text
+/visualizations/**/TropicalIsland          filter=lfs diff=lfs merge=lfs -text
+/visualizations/**/TropicalIsland.exe      filter=lfs diff=lfs merge=lfs -text
diff --git a/.github/workflows/build-android.yml b/.github/workflows/build-android.yml
@@ -5,7 +5,8 @@ on:
   push:
     branches:
       - 'master'
-      - 'release'
+    tags:
+      - '*'
 jobs:
   build:
     runs-on: ${{ matrix.os }}
@@ -84,20 +85,13 @@ jobs:
     - name: Build QtBase
       run: make QtBase -j${{ env.JOBS }}
 
-    # Upload EngineLIB
-    - name: Upload EngineLIB
+    # Upload Engine
+    - name: Upload Engine
       uses: actions/upload-artifact@v3
       with:
-        name: EngineLIB-${{ matrix.arch }}-${{ matrix.branding }} (${{ matrix.os }})
+        name: Engine-${{ matrix.arch }}-${{ matrix.branding }} (${{ matrix.os }})
         path: |
           ./src/Engine/neuromoreEngine.h
           ./build/make/lib/android-${{ matrix.arch }}/EngineLIB.so
-
-    # Upload EngineJNI
-    - name: Upload EngineJNI
-      uses: actions/upload-artifact@v3
-      with:
-        name: EngineJNI-${{ matrix.arch }}-${{ matrix.branding }} (${{ matrix.os }})
-        path: |
           ./build/make/lib/android-${{ matrix.arch }}/EngineJNI.jar
           ./build/make/lib/android-${{ matrix.arch }}/EngineJNI.so
diff --git a/.github/workflows/build-ios.yml b/.github/workflows/build-ios.yml
@@ -5,7 +5,8 @@ on:
   push:
     branches:
       - 'master'
-      - 'release'
+    tags:
+      - '*'
 jobs:
   build:
     runs-on: ${{ matrix.os }}
@@ -66,11 +67,11 @@ jobs:
     - name: Build QtBase
       run: make QtBase -j${{ env.JOBS }}
 
-    # Upload EngineLIB
-    - name: Upload EngineLIB
+    # Upload Engine
+    - name: Upload Engine
       uses: actions/upload-artifact@v3
       with:
-        name: EngineLIB-${{ matrix.arch }}-${{ matrix.branding }} (${{ matrix.os }})
+        name: Engine-${{ matrix.arch }}-${{ matrix.branding }} (${{ matrix.os }})
         path: |
           ./src/Engine/neuromoreEngine.h
           ./build/make/lib/ios-${{ matrix.arch }}/EngineLIB.dylib
diff --git a/.github/workflows/build-linux.yml b/.github/workflows/build-linux.yml
@@ -5,7 +5,8 @@ on:
   push:
     branches:
       - 'master'
-      - 'release'
+    tags:
+      - '*'
 jobs:
 ###########################################################################
   prepare:
@@ -235,27 +236,28 @@ jobs:
     - name: Make (dist)
       run: make dist
 
-    # Upload
-    - name: Upload
+    # Upload Studio
+    - name: Upload Studio
       uses: actions/upload-artifact@v3
       with:
         name: Packages (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
         path: ./dist/${{ matrix.os }}/*.deb
 
-    # Upload EngineLIB
-    - name: Upload EngineLIB
+    # Upload Engine
+    - name: Upload Engine
       uses: actions/upload-artifact@v3
       with:
-        name: EngineLIB (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
+        name: Engine (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
         path: |
           ./src/Engine/neuromoreEngine.h
           ./build/make/lib/linux-${{ env.TARGET_ARCH }}/EngineLIB.so
-
-    # Upload EngineJNI
-    - name: Upload EngineJNI
-      uses: actions/upload-artifact@v3
-      with:
-        name: EngineJNI (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
-        path: |
           ./build/make/lib/linux-${{ env.TARGET_ARCH }}/EngineJNI.so
           ./build/make/lib/linux-${{ env.TARGET_ARCH }}/EngineJNI.jar
+
+    # Upload to Github Release
+    - name: Upload to Github Release
+      uses: softprops/action-gh-release@v1
+      if: startsWith(github.ref, 'refs/tags/') && (matrix.branding == 'neuromore')
+      with:
+        token: ${{ secrets.PAT_GITHUB_ACTIONS }}
+        files: ./dist/${{ matrix.os }}/*.deb
diff --git a/.github/workflows/build-osx.yml b/.github/workflows/build-osx.yml
@@ -5,7 +5,8 @@ on:
   push:
     branches:
       - 'master'
-      - 'release'
+    tags:
+      - '*'
 jobs:
 ###########################################################################
 
@@ -99,21 +100,14 @@ jobs:
         name: lto.o (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
         path: ./build/make/obj/osx-${{ matrix.arch }}-release/**/lto.o
 
-    # Upload EngineLIB
-    - name: Upload EngineLIB
+    # Upload Engine
+    - name: Upload Engine
       uses: actions/upload-artifact@v3
       with:
-        name: EngineLIB (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
+        name: Engine (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
         path: |
           ./src/Engine/neuromoreEngine.h
           ./build/make/lib/osx-${{ matrix.arch }}/EngineLIB.dylib
-
-    # Upload EngineJNI
-    - name: Upload EngineJNI
-      uses: actions/upload-artifact@v3
-      with:
-        name: EngineJNI (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
-        path: |
           ./build/make/lib/osx-${{ matrix.arch }}/EngineJNI.dylib
           ./build/make/lib/osx-${{ matrix.arch }}/EngineJNI.jar
 
@@ -195,6 +189,14 @@ jobs:
         name: Packages (${{ matrix.os }}-${{ matrix.branding }})
         path: ./dist/osx-10.15/*.pkg
 
+    # Upload to Github Release
+    - name: Upload to Github Release
+      uses: softprops/action-gh-release@v1
+      if: startsWith(github.ref, 'refs/tags/') && (matrix.branding == 'neuromore')
+      with:
+        token: ${{ secrets.PAT_GITHUB_ACTIONS }}
+        files: ./dist/osx-10.15/*-universal.pkg
+
 ###########################################################################
 
   dist-store:
@@ -265,6 +267,7 @@ jobs:
         APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
         APPLE_APPSPEC_PASS: ${{ secrets.APPLE_APPSPEC_PASS }}
         APPLE_DIST_STORE: true
+        APPLE_UPLOAD_STORE: startsWith(github.ref, 'refs/tags/1.') || startsWith(github.ref, 'refs/tags/2.')
       run: make dist
 
     # Upload

diff --git a/.github/workflows/build-win.yml b/.github/workflows/build-win.yml
@@ -5,7 +5,8 @@ on:
   push:
     branches:
       - 'master'
-      - 'release'
+    tags:
+      - '*'
 jobs:
   build:
     runs-on: ${{ matrix.os }}
@@ -24,7 +25,7 @@ jobs:
         arch: [x64,x86,arm64]
         branding: [neuromore,supermind,natus]
     steps:
-    
+
     # Checkout
     - name: Checkout
       uses: actions/checkout@v3
@@ -104,8 +105,8 @@ jobs:
     - name: PDB Info
       run: llvm-pdbutil dump --summary ./build/make/bin/win-${{ env.TARGET_ARCH }}/Studio.pdb
 
-    # Upload
-    - name: Upload
+    # Upload Studio
+    - name: Upload Studio
       uses: actions/upload-artifact@v3
       with:
         name: Binaries (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
@@ -114,23 +115,16 @@ jobs:
           ./build/make/bin/win-${{ matrix.arch }}/*.dll
           ./build/make/bin/win-${{ matrix.arch }}/*.pdb
 
-    # Upload EngineLIB
-    - name: Upload EngineLIB
+    # Upload Engine
+    - name: Upload Engine
       uses: actions/upload-artifact@v3
       with:
-        name: EngineLIB (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
+        name: Engine (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
         path: |
           ./src/Engine/neuromoreEngine.h
           ./build/make/lib/win-${{ matrix.arch }}/EngineLIB.dll
           ./build/make/lib/win-${{ matrix.arch }}/EngineLIB.lib
           ./build/make/lib/win-${{ matrix.arch }}/EngineLIB.pdb
-
-    # Upload EngineJNI
-    - name: Upload EngineJNI
-      uses: actions/upload-artifact@v3
-      with:
-        name: EngineJNI (${{ matrix.os }}-${{ matrix.arch }}-${{ matrix.branding }})
-        path: |
           ./build/make/lib/win-${{ matrix.arch }}/EngineJNI.dll
           ./build/make/lib/win-${{ matrix.arch }}/EngineJNI.pdb
           ./build/make/lib/win-${{ matrix.arch }}/EngineJNI.jar
@@ -148,7 +142,7 @@ jobs:
     env:
       BRANDING: ${{ matrix.branding }}
     steps:
-      
+
     # Checkout
     - name: Checkout
       uses: actions/checkout@v3
@@ -178,6 +172,17 @@ jobs:
         name: Binaries (${{ matrix.os }}-arm64-${{ matrix.branding }})
         path: ./build/make/bin/win-arm64/
 
+    # Free Disk Space
+    - name: Free Disk Space
+      shell: cmd
+      run: |
+        rmdir ${{ github.workspace }}\.git /s /q
+        rmdir ${{ github.workspace }}\visualizations\ForestScene\linux-x64 /s /q
+        rmdir ${{ github.workspace }}\visualizations\ForestScene\osx-all /s /q
+        rmdir ${{ github.workspace }}\visualizations\InfiniteTunnel\linux-x64 /s /q
+        rmdir ${{ github.workspace }}\visualizations\InfiniteTunnel\osx-all /s /q              
+        fsutil volume diskfree d:
+
     # Developer Console (X64)
     - name: MSVC Developer Console (X64)
       uses: ilammy/msvc-dev-cmd@v1
@@ -201,6 +206,12 @@ jobs:
         PUBLISHERCN: Neuromore Co
         PUBLISHER: CN=Neuromore Co, O=Neuromore Co, S=Florida, C=US
       run: make dist
+
+    # Remaining Free Disk Space
+    - name: Remaining Free Disk Space
+      shell: cmd
+      run: |
+        fsutil volume diskfree d:
     
     # Upload ZIP
     - name: Upload ZIP
@@ -216,6 +227,13 @@ jobs:
       with:
         name: Packages App (${{ matrix.os }}-${{ matrix.branding }})
         path: |
-          ./dist/win-10/*.appx
           ./dist/win-10/*.appxbundle
           ./dist/win-10/*.appxupload
+
+    # Upload to Github Release
+    - name: Upload to Github Release
+      uses: softprops/action-gh-release@v1
+      if: startsWith(github.ref, 'refs/tags/') && (matrix.branding == 'neuromore')
+      with:
+        token: ${{ secrets.PAT_GITHUB_ACTIONS }}
+        files: ./dist/win-10/*.zip
diff --git a/README.md b/README.md
@@ -55,29 +55,35 @@ Analyze your own sessions or sessions of your patients in the cloud under accoun
 
 ## Getting started (all platforms)
 
-1. Create a neuromore Cloud account at [https://account.neuromore.com/#/purchase?state=start&productId=community](https://account.neuromore.com/#/purchase?state=start&productId=community)
-2. Download the latest neuromore studio from our github [releases](https://github.com/neuromore/studio/releases) (or build it yourself).
-3. Start neuromore studio, sign-in with the created community account, accept the license and you're ready to go.
-4. Check out the wiki for specific device information or on examples on how to get started https://github.com/neuromore/studio/wiki
-5. Watch the tutorials for more info [https://www.youtube.com/channel/UCAOU6SsvwCwC30hJaFLhWgw](https://www.youtube.com/channel/UCAOU6SsvwCwC30hJaFLhWgw)
+1. [Create a free neuromore community cloud account.](https://account.neuromore.com/#/purchase?state=start&productId=community)
+2. Download the latest neuromore Studio from our github [releases](https://github.com/neuromore/studio/releases), Mac App Store or build it yourself.
+3. Start neuromore Studio, sign-in with the created community account from step 1, accept the license and you're ready to go.
+4. Check out the [wiki](https://github.com/neuromore/studio/wiki) for specific device information or examples on how to get started 
+5. [Watch the tutorials on YouTube for more info](https://www.youtube.com/channel/UCAOU6SsvwCwC30hJaFLhWgw)
 
 ## Minimum System Requirements
 
-| What     | Minimum                                               | Recommended |
-| -------- | ----------------------------------------------------- | ----------- |
-| OS       | Windows 10, Ubuntu 20.04, OSX 10.15                   | TODO        |
-| CPU      | Dual-Core released past ~2010 (with SSE4.2, AVX, ...) | TODO        |
-| RAM      | 4GB                                                   | TODO        |
-| GPU      | OpenGL 2.x compatible                                 | TODO        |
-| Display  | 1920x1080                                             | TODO        |
+| What     | Minimum                                               |
+| -------- | ----------------------------------------------------- |
+| OS       | Windows 10, Ubuntu 20.04, macOS 10.15                 |
+| CPU      | Intel* or ARM**, 32 or 64 Bit, Dual-Core, ~2Ghz         |
+| RAM      | 4GB                                                   |
+| GPU      | OpenGL 2.x compatible                                 |
+| Display  | 1920x1080                                             |
+
+\* Intel 64-Bit Build requires CPU released past ~2010 with SSE4.2, AVX and other modern instructions</br>
+\** Supports ARMv7-a (32-Bit) and ARMv8-a (64-Bit)
 
 ## Configuration/Cache Folders
 
+* You can delete this folder to fully reset your installation
+* The logfile is stored there
+
 | Platform | Folder                                           |
 | -------- | ------------------------------------------------ |
 | WIN      | %LOCALAPPDATA%\neuromore\NMStudio                |
 | LINUX    | ~/.local/share/neuromore/NMStudio                |
-| OSX      | ~/Library/Containers/com.neuromore.studio/Data/Library/Application Support/neuromore/NMStudio |
+| MACOS    | ~/Library/Containers/com.neuromore.studio/Data/Library/Application Support/neuromore/NMStudio |
 
 ## Building
 
@@ -87,17 +93,22 @@ See [this](https://github.com/neuromore/studio/blob/master/BUILDING.md) for more
 
 See [this](https://github.com/neuromore/studio/blob/master/deps/README.md) for more information about the third party software included in this repository.
 
+## Community 
+
+Have a look at our [Github Discussions](https://github.com/neuromore/studio/discussions) forum to ask questions, brainstorm about future ideas, and connect to other community members.
+
+
 ## FAQ
 
 ### Technical
 
-_Q:_ Can I build an offline version of neurmore studio (one that does not require your backend)?
+_Q:_ Can I build an offline version of neurmore studio (one that does not require your backend)?</br>
 _A_: This is a work in progress. We don't provide an option for that. For now, access to our backend is mandatory.
 
-_Q:_ Is the backend code included or available so that I can host it myself?
+_Q:_ Is the backend code included or available so that I can host it myself?</br>
 _A_: No. The backend code and database design is not included in this repository.
 
-_Q:_ How do I reset my password?
+_Q:_ How do I reset my password?</br>
 _A:_ https://account.neuromore.com/#/login
 
 ## Related Projects