Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ultralytics/ntc
Neutron TimeCube (NTC) neutron detector simulation and analysis
https://github.com/ultralytics/ntc
gamma neutron particle-physics picosecond scatter-camera scintillator
Last synced: 6 days ago
JSON representation
Neutron TimeCube (NTC) neutron detector simulation and analysis
- Host: GitHub
- URL: https://github.com/ultralytics/ntc
- Owner: ultralytics
- License: agpl-3.0
- Created: 2018-05-19T05:27:23.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T18:48:21.000Z (3 months ago)
- Last Synced: 2024-08-14T19:44:49.834Z (3 months ago)
- Topics: gamma, neutron, particle-physics, picosecond, scatter-camera, scintillator
- Language: MATLAB
- Homepage: https://ultralytics.com
- Size: 650 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# đ Introduction
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.
[![Ultralytics Actions](https://github.com/ultralytics/ntc/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/ntc/actions/workflows/format.yml)
## đ Description
The repository available at [ultralytics/ntc](https://github.com/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.
## âī¸ Requirements
Before diving in, make sure you have the following prerequisites:
- [MATLAB](https://www.mathworks.com/products/matlab.html) version 2018a or higher.
- Access to the 'functions-matlab' common functions repository:
```bash
$ git clone https://github.com/ultralytics/functions-matlab
```
Add the repository to the MATLAB path using:
```matlab
>> addpath(genpath('/path/to/functions-matlab'))
```
- The following MATLAB toolboxes should be installed:
- Statistics and Machine Learning Toolbox
- Signal Processing ToolboxEnsure that all installations and configurations match these requirements to smoothly run the NTC analysis tools.
## đ Running the Tools
To begin analyzing your data:
1. Open MATLAB
2. Execute the command:
```matlab
>> NTCviewer
```Here is a glimpse of the kind of interface you can expect with our `NTCviewer`:
![mtcView Interface](https://github.com/ultralytics/ntc/assets/26833433/32d0b7b9-4626-43c8-9ae1-85930414ea70)
## đ¤ Contribute
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](https://docs.ultralytics.com/help/contributing/) to get started. Also, we'd love to hear about your experience with Ultralytics products. Please consider filling out our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge đ and thank you to all of our contributors!
## Šī¸ License
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](https://opensource.org/license) open-source license encourages collaborative learning and knowledge sharing. Please refer to the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/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](https://www.ultralytics.com/license).## đŦ Contact Us
For bug reports, feature requests, and contributions, head to [GitHub Issues](https://github.com/ultralytics/velocity/issues). For questions and discussions about this project and other Ultralytics endeavors, join us on [Discord](https://discord.com/invite/ultralytics)!