Welcome to the NUDAR (Nuclear Detection, Ranging, and Mapping) repository by Ultralytics! This project offers sophisticated simulation tools crafted for modeling the Earth's structure and simulating neutrino detector systems. Grounded in scientific research, our tools cater to both the academic community and applied sciences within geophysics and particle physics. Explore the fascinating intersection of earth modeling and neutrino detection with NUDAR! 🌍✨
NUDAR provides a comprehensive suite of MATLAB simulations designed to advance the theoretical study of 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 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 (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. You can find more insights into related fields on the Ultralytics Blog.
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:
- Clone the Common Functions repository for MATLAB:
git clone https://github.com/ultralytics/functions-matlab
- Add the cloned repository to your MATLAB path using the following command:
addpath(genpath('/path/to/functions-matlab')) % Replace /path/to/ with the actual path
Note: The following MATLAB toolboxes are also required:
Ensure you have the necessary licenses for these toolboxes, obtainable through official MathWorks channels.
To start the Interactive Detector Neutrino Direction and Ranging (iDND) tool, execute the following command in the MATLAB command window:
iDNDThis 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.
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 for details on how to get started. We also invite you to share your experiences with Ultralytics technologies by completing our Survey. A big thank you 🙏 to all our contributors!
Ultralytics offers two licensing options for NUDAR:
- AGPL-3.0 License: An OSI-approved open-source license ideal for students, researchers, and enthusiasts keen on collaboration and knowledge sharing. See the 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.
If you encounter bugs, have feature requests, or wish to contribute, please use GitHub Issues. For broader questions and discussions about NUDAR or other Ultralytics projects, join our vibrant community on Discord!
