Merge pull request #39 from catalystneuro/feature/use-vame-0.4.0

feat: use new vame version

.github/workflows/build-and-release-linux.yml

@@ -38,12 +38,7 @@ jobs:
       - name: Install dependencies
         run: npm install
 
-      - name: Build
+      - name: Build and deploy on Linux(Debian)
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm run build:linux
-
-      - name: Deploy Linux
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm run publish -- --publish=always
+        run: npm run build:linux --publish=always

.github/workflows/build-and-release-mac.yml

@@ -43,12 +43,7 @@ jobs:
           p12-file-base64: ${{ secrets.MACOS_CERTIFICATE }}
           p12-password: ${{ secrets.MACOS_CERTIFICATE_PWD }}
 
-      - name: Build Mac
+      - name: Build and deploy on MacOS
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm run build:mac
-
-      - name: Deploy Mac
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm run publish -- --publish=always
+        run: npm run build:mac -- --publish=always

.github/workflows/build-and-release-win.yml

@@ -41,9 +41,4 @@ jobs:
       - name: Build and deploy on Windows
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm run build:win
-
-      - name: Deploy Windows
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm run publish -- --publish=always
+        run: npm run build:win -- --publish=always

.github/workflows/test-build-linux.yml

@@ -33,4 +33,4 @@ jobs:
         run: npm install
 
       - name: Build
-        run: npm run build:linux
+        run: npm run build:linux -- --publish=never

.github/workflows/test-build-mac.yml

@@ -33,4 +33,4 @@ jobs:
         run: npm install
 
       - name: Build and deploy on Mac
-        run: npm run build:mac
+        run: npm run build:mac -- --publish=never

.github/workflows/test-build-win.yml

@@ -33,4 +33,4 @@ jobs:
         run: npm install
 
       - name: Build and deploy on Windows
-        run: npm run build:win
+        run: npm run build:win -- --publish=never

README.md

@@ -5,6 +5,13 @@ A desktop application for the Variational Animal Motion Encoding (VAME) project.
 VAME Desktop has been designed to run each step of a VAME project **only once**. This is to ensure that the project is reproducible and that the data is not accidentally overwritten.
 
 ## Installation
+
+### Download builded versions:
+
+You can find the builed versions of VAME Desktop on the [release page](https://github.com/catalystneuro/vame-desktop/releases).
+
+## Development mode
+
 ### Python
 You will need to have [miniconda](https://docs.conda.io/en/latest/miniconda.html) installed on your machine OR [pyenv](https://github.com/pyenv/pyenv).
 

main.spec

@@ -9,7 +9,7 @@ datas += tmp_ret[0]; binaries += tmp_ret[1]; hiddenimports += tmp_ret[2]
 
 
 a = Analysis(
-    ['src/services/main.py'],
+    ['src/services/vameApi/main.py'],
     pathex=[],
     binaries=binaries,
     datas=datas,

package.json

@@ -1,7 +1,7 @@
 {
   "name": "vame-desktop",
   "main": "./out/main/index.js",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "An open-source machine learning tool for behavioral segmentation and analyses.",
   "license": "GPL-3.0-only",
   "author": "Catalyst Neuro <hello@catalystneuro.com>, Nathan Vieira <nathan.v.marcelino@gmail.com>, Garrett Flynn <garrettmflynn@gmail.com>",

requirements.txt

@@ -4,4 +4,4 @@ flask-restx==1.3.0
 numpy==1.26.4
 pyinstaller==6.8.0
 pyinstaller-hooks-contrib==2024.6
-vame-py==0.3.1
+vame-py==0.4.0

src/main/index.ts

@@ -48,7 +48,7 @@ app.whenReady().then(() => {
   folderHandler()
 
   if (is.dev) {
-    backend = runChildProcess("python", [join(__dirname, "..", "..", "src", "services", "main.py")])
+    backend = runChildProcess("python", [join(__dirname, "..", "..", "src", "services", "vameApi", "main.py")])
 
     backend?.stdout.on("data", (data) => {
       if (data?.toString().includes("Flask server started at")) {
@@ -89,10 +89,6 @@ app.on("window-all-closed", () => {
 app.on("before-quit", (event) => {
   if (backend && backend.exitCode === null) {
     event.preventDefault(); // Prevent the default behavior of quitting immediately
-    backend.once("exit", (code) => {
-      console.log(`[electron]: Process exited with code ${code}`)
-      app.exit(code ?? 0); // Quit the app after the child process exits
-    });
     backend.kill("SIGTERM"); // Send SIGTERM to the child process
   } else if (backend && backend.exitCode !== null) {
     console.log(`[electron]: Process exited with code ${backend.exitCode}`)

src/main/process/runChildProcess.ts

@@ -1,3 +1,4 @@
+import { app } from "electron";
 
 export function runChildProcess(exec: string, path?: string[]) {
   let stdoutChunks = [], stderrChunks = [];
@@ -9,9 +10,10 @@ export function runChildProcess(exec: string, path?: string[]) {
     }
   });
 
-  child.on('exit', (code) =>
+  child.on('exit', (code) => {
     console.log(`[${exec}]: Process exited with code ${code}`)
-  );
+    app.exit(code ?? -1)
+  });
 
   child.stdout.on('data', (data) => {
     console.log(`[${exec}]:`, data.toString());

src/renderer/src/@types/index.d.ts

@@ -137,11 +137,20 @@ declare global {
     assets: {
       images: {
         evaluation: string[];
-        visualization: Record<string,string[]>;
+        visualization: {
+          hmm: Record<string,string[]>,
+          kmeans: Record<string,string[]>
+        };
       };
       videos: {
-        community: Record<string,string[]>;
-        motif: Record<string,string[]>;
+        community: {
+          hmm: Record<string,string[]>,
+          kmeans: Record<string,string[]>
+        };
+        motif: {
+          hmm: Record<string,string[]>,
+          kmeans: Record<string,string[]>
+        };
       };
     };
     created_at: string;
@@ -227,6 +236,7 @@ declare global {
   export type EnumProperty = DefaultPropertyAttrs &  {
     type: "string";
     enum: string[];
+    multiple?: boolean;
     default?: string;
   };
 

src/renderer/src/components/DynamicForm/DynamicInput.tsx

@@ -41,9 +41,11 @@ const DynamicInput: React.FC<DynamicInputProps> = ({
 
   // Handle select fields
   if (type === "enum") {
+    const enumProperty = property as EnumProperty
     return (
       <select
         {...register(itemKey, { required, disabled: readOnly })}
+        multiple={enumProperty.multiple}
       >
         {(property as EnumProperty)!.enum.map((option) => (
           <option key={option} value={option}>

src/renderer/src/components/DynamicForm/index.tsx

@@ -21,7 +21,11 @@ const DynamicForm: React.FC<DynamicFormProps> = ({
   initialValues,
   submitText = "Submit",
 }) => {
-  const defaultValues = initialValues && !isEmpty(initialValues) ? initialValues : extractDefaultValues(schema)
+
+  const defaultValues = {
+    ...extractDefaultValues(schema),
+    ...initialValues
+  }
 
   const methods = useForm({
     disabled: blockSubmission,
@@ -31,6 +35,11 @@ const DynamicForm: React.FC<DynamicFormProps> = ({
   const properties = Object.entries(schema.properties)
   const readOnly = !properties.some(([_,p])=> !p.readOnly)
 
+  // const handleSubmit = (data) => {
+  //   console.log(data)
+  //   onFormSubmit(data)
+  // }
+
   return (
     <FormProvider {...methods}>
 

src/renderer/src/components/DynamicForm/styles.ts

@@ -149,4 +149,4 @@ export const FileListItem = styled.li`
   align-items: center;
   padding: 5px 0;
   overflow: auto;
-`;
+`;

src/renderer/src/pages/Project/Tabs/CommunityAnalysis.tsx

@@ -3,6 +3,7 @@ import { useState } from "react"
 import DynamicForm from "../../../components/DynamicForm"
 
 import communitySchema from '../../../../../schema/community.schema.json'
+
 import { TabProps } from "./types"
 import TerminalModal from "../../../components/TerminalModal"
 import { ControlButton } from "@renderer/pages/Home/styles"
@@ -19,7 +20,7 @@ export const CommunityAnalysis = ({
 }: TabProps) => {
   const [terminal, setTerminal] = useState(false)
 
-  const schema = structuredClone(communitySchema) as Schema
+  const schema = structuredClone(communitySchema) as unknown as Schema
 
   const communitiesCreated = project.workflow.communities_created
   const states = project.states?.["community"]
@@ -47,7 +48,7 @@ export const CommunityAnalysis = ({
         content={blockTooltip}
         placement="bottom"
         hideOnClick={false}
-        onShow={() => !blockSubmission as false}
+        disabled={!blockSubmission || !blockTooltip}
       >
         <>
           <DynamicForm

src/renderer/src/pages/Project/Tabs/CommunityVideos.tsx

@@ -9,6 +9,9 @@ import { ControlButton } from "@renderer/pages/Home/styles"
 import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"
 import { faTerminal } from "@fortawesome/free-solid-svg-icons"
 
+import CommunityVideosSchema from "../../../../../schema/community-videos.schema.json"
+import DynamicForm from "@renderer/components/DynamicForm"
+
 const CommunityVideos = ({
   project,
   onFormSubmit,
@@ -17,52 +20,20 @@ const CommunityVideos = ({
 }: TabProps) => {
   const [terminal, setTerminal] = useState(false)
 
-  const hasCommunityVideos = project.workflow.community_videos_created
-
-  if (!hasCommunityVideos) return (
-    <PaddedTab>
-      <span>
-        Open logs:{" "}
-        <ControlButton onClick={() => setTerminal(true)}>
-          <FontAwesomeIcon icon={faTerminal} />
-        </ControlButton>
-      </span>
-
-      <TerminalModal
-        projectPath={project.config.project_path}
-        logName={["community_videos"]}
-        isOpen={terminal}
-        onClose={() => setTerminal(false)}
-      />
-
-      <Tippy
-        content={blockTooltip}
-        placement="bottom"
-        hideOnClick={false}
-        disabled={!blockSubmission}
-      >
-        <span>
-          <Button
-            disabled={blockSubmission}
-            onClick={onFormSubmit}
-          >
-            Create Community Videos
-          </Button>
-        </span>
-      </Tippy>
-    </PaddedTab>
-  )
-
+  const schema = structuredClone(CommunityVideosSchema) as unknown as Schema
 
   const { videos } = project.assets
 
   const communityVideos = videos?.community ?? {}
 
-  const organizedVideos = Object.entries(communityVideos).reduce((acc, [label, videos]) => {
-    acc[label] = videos.map((videoPath: string) => {
-      const number = videoPath.split('-').pop()?.split('_').pop()?.split('.')[0]
-      return { path: videoPath, label: `Community ${number}`, idx: Number(number) }
-    }).sort((a, b) => a.idx - b.idx)
+  const organizedVideos = Object.entries(communityVideos).reduce((acc, [label, videosObj]) => {
+    Object.entries(videosObj).forEach(([parametrization, videos]) => {
+
+      acc[`${label}-${parametrization}`] = videos.map((videoPath: string) => {
+        const number = videoPath.split('-').pop()?.split('_').pop()?.split('.')[0]
+        return { path: videoPath, label: `Community ${number}`, idx: Number(number) }
+      }).sort((a, b) => a.idx - b.idx)
+    })
 
     return acc
   }, {} as Record<string, VideoType[]>)
@@ -76,6 +47,21 @@ const CommunityVideos = ({
       </ControlButton>
     </span>
 
+    <Tippy
+      content={blockTooltip}
+      placement="bottom"
+      hideOnClick={false}
+      disabled={!blockSubmission}
+    >
+      <span>
+        <DynamicForm
+          schema={schema}
+          blockSubmission={blockSubmission}
+          submitText={"Create Community Videos"}
+          onFormSubmit={onFormSubmit}
+        />
+      </span>
+    </Tippy>
 
     <TerminalModal
       projectPath={project.config.project_path}

src/renderer/src/pages/Project/Tabs/Model.tsx

@@ -65,7 +65,7 @@ const Model = ({
           content={blockTooltip}
           placement="bottom"
           hideOnClick={false}
-          onShow={() => !blockSubmission as false}
+          disabled={!blockSubmission || !blockTooltip}
         >
           <span>
 
@@ -102,7 +102,7 @@ const Model = ({
         content={blockTooltip}
         placement="bottom"
         hideOnClick={false}
-        onShow={() => !blockSubmission as false}
+        disabled={!blockSubmission || !blockTooltip}
       >
         <span>