Welcome to the official repository for the miniTimeCube (mTC) simulation and analysis code. This documentation is meant to guide you through the setup process, describe how to run simulations, and provide an overview of the analysis capabilities included in this project. Whether you are a physicist, a data scientist, or an enthusiast in the field of particle detection, you'll find the tools and information you need to work with the mTC.
The miniTimeCube (mTC) is an innovative, compact neutrino detector designed as a part of a larger scientific endeavor to study and understand neutrino interactions. This repository, available at https://github.com/ultralytics/mtc, contains all the necessary simulation and analysis code related to the mTC project.
The scientific paper associated with this project is titled "Invited Article: miniTimeCube" and was authored by a team of respected researchers. It presents a deep dive into the design, operation, and capabilities of the mTC. You can access the full article for a comprehensive understanding here.
To work with the miniTimeCube simulation and analysis code, you will need:
- MATLAB version 2018a or newer. MATLAB is a high-level language and interactive environment for numerical computation, visualization, and programming. If you do not have MATLAB installed, please visit the official MATLAB website.
In addition, please make sure to clone the common functions repository and add it to your MATLAB path:
% Clone the functions-matlab repository
$ git clone https://github.com/ultralytics/functions-matlab
% Add the repository to the MATLAB path
>> addpath(genpath('/functions-matlab'))Ensure that the following toolboxes are installed in your MATLAB environment:
- Statistics and Machine Learning Toolbox: Provides functions and apps to describe, analyze, and model data using statistics and machine learning.
- Signal Processing Toolbox: Offers a variety of tools and algorithms for signal processing tasks.
To execute the mTC simulation and analysis code within MATLAB, simply enter the following command in your MATLAB terminal:
% Launch the nView interface
>> nViewThis command starts the nView interface, where you can interact with the simulation and analysis tools provided for the miniTimeCube.
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!
