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 months 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 7 years ago)
• Default Branch: main
• Last Pushed: 2025-03-28T01:20:58.000Z (6 months ago)
• Last Synced: 2025-03-28T02:28:09.030Z (6 months ago)
• Topics: gamma, neutron, particle-physics, picosecond, scatter-camera, scintillator
• Language: MATLAB
• Homepage: https://ultralytics.com
• Size: 665 KB
• Stars: 3
• Watchers: 1
• 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 provides researchers and data analysts with essential tools for interpreting and visualizing data generated by the NTC, a sophisticated device used in [neutron detection](https://en.wikipedia.org/wiki/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)

[![Ultralytics Discord](https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue)](https://discord.com/invite/ultralytics)

[![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com/)

[![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue)](https://reddit.com/r/ultralytics)

## 📜 Project Overview

The repository, available at [ultralytics/ntc](https://github.com/ultralytics/ntc), contains a suite of [MATLAB](https://www.mathworks.com/products/matlab.html) 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](https://en.wikipedia.org/wiki/Neutron_science).

## ⚙️ Prerequisites

Before you begin, ensure you meet the following requirements:

- **MATLAB:** Version 2018a or newer.

- **Common Functions:** Access to the `functions-matlab` common functions repository. Clone it using:

  ```bash

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

  ```

  Then, add the repository to your MATLAB path:

  ```matlab

  addpath(genpath('/path/to/functions-matlab')) % Replace with the actual path

  ```

- **MATLAB Toolboxes:** The following toolboxes must be installed:

  - [Statistics and Machine Learning Toolbox](https://www.mathworks.com/products/statistics.html)

  - [Signal Processing Toolbox](https://www.mathworks.com/products/signal.html)

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.

3.  Execute the following command in the [MATLAB Command Window](https://www.mathworks.com/help/matlab/learn_matlab/command-window.html):

    ```matlab

    NTCviewer

    ```

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

![mtcView Interface](https://github.com/ultralytics/ntc/assets/26833433/32d0b7b9-4626-43c8-9ae1-85930414ea70)

## 🤝 Contributing

Contributions from the [GitHub](https://github.com/) community are highly encouraged! Whether it involves fixing bugs, adding new features, or enhancing documentation, your input is valuable. Please review our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for detailed instructions on how to participate. We also invite you to share your experiences with [Ultralytics](https://www.ultralytics.com/) products by completing our brief [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A big thank you 🙏 to all our contributors!

[![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)](https://github.com/ultralytics/ultralytics/graphs/contributors)

## ©️ Licensing

Ultralytics offers two licensing options to accommodate different usage scenarios:

- **AGPL-3.0 License:** This [OSI-approved](https://opensource.org/license) open-source license is ideal for students and enthusiasts interested in open collaboration and knowledge sharing. See the [LICENSE](https://github.com/ultralytics/ntc/blob/main/LICENSE) file for specifics.

- **Enterprise License:** Designed for commercial applications, this license permits the integration of Ultralytics software and AI models into commercial products and services without the open-source requirements of AGPL-3.0. If your project involves commercial use, please inquire about an [Enterprise License](https://www.ultralytics.com/license).

## 📬 Get in Touch

For bug reports, feature suggestions, and contributions, please use the [GitHub Issues](https://github.com/ultralytics/ntc/issues) section of the repository. For broader questions and discussions about this project or other Ultralytics initiatives, join the [Ultralytics community](https://community.ultralytics.com/) or connect with us on [Discord](https://discord.com/invite/ultralytics)!