🌟 Neutron TimeCube (NTC)

Welcome to the Neutron TimeCube (NTC) analysis tools repository! This project provides researchers and data analysts with essential tools for interpreting and visualizing data generated by the NTC, a sophisticated device used in neutron detection and characterization.

📜 Project Overview

The repository, available at ultralytics/ntc, contains a suite of MATLAB scripts and functions specifically designed for analyzing neutron detection data. These tools empower users to process, analyze, and visualize NTC data, supporting advanced research in neutron science.

⚙️ Prerequisites

Before you begin, ensure you meet the following requirements:

• MATLAB: R2018a or newer.
• Common Functions: Access to this repository plus shared Ultralytics MATLAB dependencies. Clone them using:

  git clone https://github.com/ultralytics/functions-matlab
  git clone https://github.com/ultralytics/miniTimeCube
  

  Then, add this repository and the dependencies to your MATLAB path:

  addpath(genpath('/path/to/ntc')) % Replace with the actual path
  addpath(genpath('/path/to/functions-matlab')) % Replace with the actual path
  addpath(genpath('/path/to/miniTimeCube')) % Provides shared MTC mapping and calibration helpers
  

• MATLAB Toolboxes: The following toolboxes must be installed:
  • Statistics and Machine Learning Toolbox
  • Signal Processing Toolbox
  • DSP System Toolbox
  • Curve Fitting Toolbox

Verify that all installations and path configurations are correctly set up to ensure the NTC analysis tools run smoothly.

🚀 Getting Started

To start analyzing your NTC data:

1. Open MATLAB.
2. Navigate to the repository directory and confirm the paths above are active.
3. Execute the following command in the MATLAB Command Window:

   NTCviewer
   

Below is an example of the NTCviewer interface you will interact with:

💡 Contribute

Ultralytics thrives on community collaboration, and we deeply value your contributions! Whether it's reporting bugs, suggesting features, or submitting code changes, your involvement is crucial.

• Reporting Issues: Encounter a bug? Please report it on GitHub Issues.
• Feature Requests: Have an idea for improvement? Share it via GitHub Issues.
• Pull Requests: Want to contribute code? Please read our Contributing Guide first, then submit a Pull Request.
• Feedback: Share your thoughts and experiences by participating in our official Survey.

A heartfelt thank you 🙏 goes out to all our contributors! Your efforts help make Ultralytics tools better for everyone.

📄 License

Ultralytics offers two licensing options to accommodate diverse needs:

• AGPL-3.0 License: Ideal for students, researchers, and enthusiasts passionate about open collaboration and knowledge sharing. This OSI-approved open-source license promotes transparency and community involvement. See the LICENSE file for details.
• Enterprise License: Designed for commercial applications, this license permits the seamless integration of Ultralytics software and AI models into commercial products and services, bypassing the copyleft requirements of AGPL-3.0. For commercial use cases, please inquire about an Ultralytics Enterprise License.

📮 Contact

For bug reports or feature suggestions, please use GitHub Issues. For general questions, discussions, and community support, join our Discord server!