# nudar
**Repository Path**: mirrors_ultralytics/nudar
## Basic Information
- **Project Name**: nudar
- **Description**: NeUtrino Detection and Ranging (NUDAR): earth modeling and neutrino detection simulation software
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-22
- **Last Updated**: 2026-02-15
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
## đ Introduction
Welcome to the NUDAR (Nuclear Detection, Ranging, and Mapping) repository by [Ultralytics](https://www.ultralytics.com/)! This project offers sophisticated simulation tools crafted for modeling the Earth's structure and simulating [neutrino](https://en.wikipedia.org/wiki/Neutrino) detector systems. Grounded in scientific research, our tools cater to both the academic community and applied sciences within [geophysics](https://en.wikipedia.org/wiki/Geophysics) and [particle physics](https://home.cern/science/physics/particle-physics). Explore the fascinating intersection of earth modeling and neutrino detection with NUDAR! đâ¨
[](https://github.com/ultralytics/nudar/actions/workflows/format.yml)
[](https://discord.com/invite/ultralytics)
[](https://community.ultralytics.com/)
[](https://reddit.com/r/ultralytics)
## đ Description
NUDAR provides a comprehensive suite of [MATLAB](https://www.mathworks.com/products/matlab.html) simulations designed to advance the theoretical study of [antineutrino](https://en.wikipedia.org/wiki/Antineutrino) interactions and detection. This software is instrumental in deepening our understanding of antineutrino properties and their potential applications, such as probing the [Earth's interior](https://education.nationalgeographic.org/resource/encyclopedia/earths-interior/) and enhancing nuclear detection capabilities.
Our development is inspired by the foundational paper by G. Jocher et al., "Theoretical Antineutrino Detection, Direction and Ranging at Long Distances," published in [Physics Reports](https://www.sciencedirect.com/journal/physics-reports) (Volume 527, Issue 3, 2013). For an in-depth look at the scientific principles underpinning these simulations, please consult the publication via its DOI: [http://dx.doi.org/10.1016/j.physrep.2013.01.005](http://dx.doi.org/10.1016/j.physrep.2013.01.005). You can find more insights into related fields on the [Ultralytics Blog](https://www.ultralytics.com/blog).
## 𧰠Requirements
To utilize the NUDAR simulations, ensure you have MATLAB (version 2018a or later) installed. The simulations also rely on a common functions repository, which must be accessible within your MATLAB environment.
Follow these steps to set up your environment:
1. Clone the Common Functions repository for MATLAB:
```shell
git clone https://github.com/ultralytics/functions-matlab
```
2. Add the cloned repository to your MATLAB path using the following command:
```matlab
addpath(genpath('/path/to/functions-matlab')) % Replace /path/to/ with the actual path
```
**Note:** The following MATLAB toolboxes are also required:
- [Statistics and Machine Learning Toolbox](https://www.mathworks.com/products/statistics.html)
- [Signal Processing Toolbox](https://www.mathworks.com/products/signal.html)
- [Mapping Toolbox](https://www.mathworks.com/products/mapping.html)
Ensure you have the necessary licenses for these toolboxes, obtainable through official [MathWorks](https://www.mathworks.com/) channels.
## đ Running the Simulation
To start the Interactive Detector Neutrino Direction and Ranging (iDND) tool, execute the following command in the MATLAB command window:
```matlab
iDND
```
This command launches the simulation interface, enabling exploration of various neutrino detection scenarios and earth model configurations. For more on simulation techniques, check resources on [computational modeling](https://en.wikipedia.org/wiki/Computational_model).
## đ¤ Contribute
Contributions from the community are highly encouraged! Whether it's fixing bugs, proposing new features, or enhancing documentation, your input is valuable. Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for details on how to get started. We also invite you to share your experiences with Ultralytics technologies by completing our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A big thank you đ to all our contributors!
[](https://github.com/ultralytics/nudar/graphs/contributors)
## Šī¸ License
Ultralytics offers two licensing options for NUDAR:
- **AGPL-3.0 License**: An [OSI-approved](https://opensource.org/license/agpl-3.0/) open-source license ideal for students, researchers, and enthusiasts keen on collaboration and knowledge sharing. See the [LICENSE](https://github.com/ultralytics/nudar/blob/main/LICENSE) file for full details.
- **Enterprise License**: Designed for commercial applications, this license permits the integration of NUDAR into commercial products and services without the open-source obligations of AGPL-3.0. For commercial use, please contact us through [Ultralytics Licensing](https://www.ultralytics.com/license).
## đŦ Contact Us
If you encounter bugs, have feature requests, or wish to contribute, please use [GitHub Issues](https://github.com/ultralytics/nudar/issues). For broader questions and discussions about NUDAR or other Ultralytics projects, join our vibrant community on [Discord](https://discord.com/invite/ultralytics)!
