Skip to content

KEDRI-AUT/NeuroGeMS

Repository files navigation

NeuroGeMS: Neuro-Genetic Multimodal System

License

A comprehensive software platform for multimodal learning and biomedical research, developed by the Knowledge Engineering and Discovery Research Institute (KEDRI) at Auckland University of Technology (AUT), New Zealand.

NeuroGeMS Screenshot

🌟 Features

  • Multimodal learning capabilities
  • Reproducibility and experiment tracking with MLflow integration
  • Extensible architecture for easy integration of new techniques and models

🛠️ Setup

Option 1: Executable Installer

Download the latest executable installer from the releases page. Run the installer and follow the on-screen instructions to install NeuroGeMS on your system.

Option 2: Manual Setup

Ensure you have Node v16.2.0 and Python 3.9 installed, then clone this repository. After it's cloned, navigate to the project's root directory on your computer and run the following scripts in a terminal application (e.g., Git Bash):

Install Python dependencies:

pip3 install -r requirements.txt

Install Node dependencies:

yarn install

⚙️ Config

Electron: Electron's main.js, preload.js, and renderer.js files can be found in the project's root directory.

React: React files can be found in the ./src/ folder, the custom toolbar is in ./src/components/toolbar.

Python: Python scripts can be created in the ./app.py file and used on events via REST calls.

📜 Scripts

Below are the scripts you can run to package the application. The complete list of scripts that are available can be found in the package.json file of the project's root directory, in the scripts section.

⚠️  When packaging, you must install PyInstaller and add its path in your environment variables.

Start Developer Mode:

yarn run start

Package Windows:

yarn run build:package:windows

Package macOS:

yarn run build:package:mac

Package Linux:

yarn run build:package:linux

🙏 Acknowledgements

NeuroGeMS leverages the following open-source projects:

🦟 Bugs

Report any bugs on the project's issues page. Be sure to include steps to reproduce so they can be spotted easily.

🏷️ License

GNU Affero General Public License v3.0 © KEDRI-AUT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published