REDVID Software README

dr. ir. Uraz Odyurt

Description

REDuced VIrtual Detector (REDVID) is a simulation framework and a synthetic data generator written in Python. The generator simulates the propagation of subatomic particles, inspired by the detectors installed at the Large Hadron Collider (LHC). The simulation model is complexity-reduced and is intended for generating source data for Machine Learning (ML) algorithms.

For further information, refer to REDVID website.

Installation

There are no prerequisites or dependencies besides Python packages imported within the code. Python package dependencies are minimal and can be observed in the requirements.txt file.

Documentation

To be generated …

Usage and citation

The main script to be executed is scripts/digital_detector.py. All necessary configuration are to be provided through a configuration file, residing in the config/ folder. An example file has been included with the default filename. The default filename, REDVID_config.ini, can be changed from within the code. Alternatively, a configuration file residing in a different folder can be provided. The path to this folder can be given as an argument.

When it comes to the configuration file, the most important parameter affecting REDVID’s execution is the anchor_path. This path will be the root of the data set hierarchy to be generated by REDVID.

If you use this software in your research or any publication, we kindly request you to cite the following paper:

@misc{Odyurt:2023:REDVID,
  author = {Odyurt, Uraz and Swatman, Stephen Nicholas and Varbanescu, Ana-Lucia and 
    Caron, Sascha},
  title = {Reduced Simulations for High-Energy Physics, a Middle Ground for Data-Driven 
    Physics Research}, 
  year = {2023},
  eprint = {2309.03780},
  archivePrefix = {arXiv},
  doi = {10.48550/arXiv.2309.03780}
}

We put significant effort into composing this software and proper citation helps acknowledge and support the continued development of this resource.

Support

Note that this open-source software is being shared on an “as is” basis, without any explicit or implicit warranties or obligations of support. While we have made efforts to ensure the functionality and quality of the software, we cannot guarantee its fitness for any particular purpose or provide any form of ongoing support.

As the creators and sharers of this software, we are unable to offer any dedicated assistance or guidance for utilising or troubleshooting the software. We do not commit to addressing inquiries, resolving issues, or providing additional documentation or support material related to this software. Should you encounter any challenges or have questions, we recommend referring to the existing documentation.

Roadmap

Confidential

Authors and acknowledgement

The REDVID simulation framework and the generated data sets are authored by:

The collaborating team includes:

Previous collaborating members:

Licence

REDVID is distributed under BSD-3-Clause Licence. Refer to the provided LICENCE file. The authors would appreciate the proper citation of the original work upon use, as shown above.

If you have any questions regarding the licence or usage of the software, please contact the authors.

Note: The licence applies only to the software itself and not to any third-party content or documentation that may be included with the software. Please review any licences or terms of use associated with those components separately.

Project status

As of January 2024, the project is under active development.