Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 1.85 KB

CONTRIBUTIONS.md

File metadata and controls

63 lines (42 loc) · 1.85 KB

Contributing to NeuroPAL_ID

🎉 Thank you for your interest in contributing to NeuroPAL_ID! Whether you're here to fix a bug, add a feature, or improve documentation, your contributions are highly appreciated. This guide will help you get started with setting up the project and submitting your contributions. Getting Started User Mode

To use NeuroPAL_ID as a standalone tool:

Download the Latest Release Grab the latest compiled release here.

Extract the Files Unzip the downloaded file and place it in a directory of your choice.

Developer Mode

If you want to actively develop or extend NeuroPAL_ID, please follow these steps:

Prerequisites

Ensure you have:

  • Python 3.9+
  • MATLAB 2020b+

Dependencies

Install the following dependencies:

MATLAB Toolboxes:

  • Mlapptools
  • Bioformats Toolbox
  • Image Processing Toolbox
  • Statistics and Machine Learning Toolbox

Python Dependencies: pip install -r requirements.txt, for macOS, use: pip install -r requirements-macos.txt

Clone the Repository Open Git Bash and navigate to your preferred directory, then run:

git clone https://github.com/Yemini-Lab/NeuroPAL_ID.git

Open in MATLAB Open visualize_light.mlapp in MATLAB’s AppDesigner to begin development.

How to Contribute

  1. Fork the Repository Fork the NeuroPAL_ID repository to your GitHub account.

  2. Create a Branch Create a new branch for your changes:

git checkout -b feature/your-feature-name

  1. Commit Your Changes Write a clear, concise commit message describing your changes.

  2. Push and Submit a Pull Request Push your changes to GitHub and open a pull request (PR) with a detailed description.

  3. Feedback and Review Maintainers will review your PR and may provide feedback. Thank you for your patience during this process!

Thank you for helping make NeuroPAL_ID a better tool! 👏