Welcome to the Neutron TimeCube (NTC) analysis tools repository! This project is designed to provide researchers and data analysts with tools to interpret and visualize data from the NTC, a sophisticated device used in neutron detection and characterization.
The repository available at ultralytics/ntc houses a suite of MATLAB scripts and functions tailored for the analysis of neutron detection data. With these tools, users can process, analyze, and visualize NTC data, facilitating cutting-edge research in neutron science.
Before diving in, make sure you have the following prerequisites:
- MATLAB version 2018a or higher.
- Access to the 'functions-matlab' common functions repository:
Add the repository to the MATLAB path using:
$ git clone https://github.com/ultralytics/functions-matlab
>> addpath(genpath('/path/to/functions-matlab')) - The following MATLAB toolboxes should be installed:
- Statistics and Machine Learning Toolbox
- Signal Processing Toolbox
Ensure that all installations and configurations match these requirements to smoothly run the NTC analysis tools.
To begin analyzing your data:
- Open MATLAB
- Execute the command:
>> NTCviewer
Here is a glimpse of the kind of interface you can expect with our NTCviewer:
We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your input is invaluable. Take a look at our Contributing Guide to get started. Also, we'd love to hear about your experience with Ultralytics products. Please consider filling out our Survey. A huge 🙏 and thank you to all of our contributors!
Ultralytics is excited to offer two different licensing options to meet your needs:
- AGPL-3.0 License: Perfect for students and hobbyists, this OSI-approved open-source license encourages collaborative learning and knowledge sharing. Please refer to the LICENSE file for detailed terms.
- Enterprise License: Ideal for commercial use, this license allows for the integration of Ultralytics software and AI models into commercial products without the open-source requirements of AGPL-3.0. For use cases that involve commercial applications, please contact us via Ultralytics Licensing.
For bug reports, feature requests, and contributions, head to GitHub Issues. For questions and discussions about this project and other Ultralytics endeavors, join us on Discord!
