Welcome to the NUDAR (Nuclear Detection, Ranging, and Mapping) repository! Here, we provide advanced simulation tools designed for modeling the Earth's structure and simulating neutrino detector systems. Our work is built upon a foundation of scientific research and is geared towards both the academic community and applied sciences in the field of geophysics and particle physics.
Enjoy the journey into the fascinating world of earth modeling and neutrino detection with NUDAR! 🌍✨
The NUDAR project is a comprehensive suite of MATLAB simulations aimed at facilitating the theoretical study of antineutrino interactions and detections. This software plays a crucial role in enhancing our understanding of antineutrino properties and their applications in probing the Earth's interior and nuclear detection.
Our work is inspired and informed by the seminal paper by G. Jocher et al., titled "Theoretical Antineutrino Detection, Direction and Ranging at Long Distances," published in Physics Reports (Volume 527, Issue 3, 2013). For a deep dive into the scientific and theoretical backgrounds that underpin these simulations, please refer to the publication at: http://dx.doi.org/10.1016/j.physrep.2013.01.005.
To get started with the NUDAR simulations, ensure that you have MATLAB (version 2018a or later) set up on your machine. Additionally, the simulations depend on a repository of common functions which should be included in your MATLAB environment.
Please follow these steps to prepare your work environment:
- Clone the Common Functions repository for MATLAB:
$ git clone https://github.com/ultralytics/functions-matlab
- Add the repository to your MATLAB path by running:
>> addpath(genpath('/functions-matlab'))
Note: You should also have the following toolboxes installed in your MATLAB environment:
Statistics and Machine Learning ToolboxSignal Processing ToolboxMapping Toolbox
Required licenses for these toolboxes should be acquired through official MATLAB channels.
To launch the Interactive Detector Neutrino Direction and Ranging (iDND) tool, simply navigate to the MATLAB command window and enter:
>> iDNDThis command will initiate the simulation interface, allowing you to explore various neutrino detection scenarios and earth model configurations.
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!
