C++ software to generate true labels for lartpc_mlreco3d
(repository), a full data reconstruction chain of modular machine learning (ML) algorithms for 3D particle images. The repository provides Python binding via pybind11
, which can be optionally turned off. This software does not implement a process executable to run Supera. An implementation to run this software with EDepSim framework and to produce larcv, please see edep2supera.
- Use this docker image (or any other container image derived from it) to get the most of required softwares. Only additional item you would need is scikit-build which you can install with
pip
.
- If you know how to use
cmake
for building a software, you can actually skipscikit-build
and runcmake
fromsrc
directory.
- Clone this repository (below) or fork-and-clone.
> git clone https://github.com/DeepLearnPhysics/SuperaAtomic
- Build
> python3 setup.py build
- Install (the example below installs under your
$HOME/.local
path)
> python3 setup.py install --user
Simply try:
pytest test
at the top-level directory. Note you do need to specify test
to avoid running pytest
on pybind11
(which is under src
directory and automatically searched by pytest
unless you specify test
directory target).
- Fork this repository to your personal github account.
- Clone the repository to your local machine. Follow the build/install instruction above and make sure you can set up.
- Create your branch to contain your own development. Code code code.
- When it's ready to be shared, make sure the unit test passes. Then request to merge by sending a pull request.
Optional but strongly recommended: implement a unit test for the added component of your code so that we can reduce chance of someone else breaking in future development.
- Feel free to use github issues! We try to be attentive as much as possible.
- Join our weekly ND Technical Software Meeting (noon PST every Wednesday, here's indico category).
- Join our mailing list dunend-simreco-technical@listserv.slac.stanford.edu
- Send an email to listserv@listserv.slac.stanford.edu with an empty title. The body should include this text:
SUBSCRIBE DUNEND-SIMRECO-TECHNICAL FIRST LAST
where you should replace theFIRST
andLAST
with your first and last names respectively.
- Send an email to listserv@listserv.slac.stanford.edu with an empty title. The body should include this text:
- Join our slack channel (contact Kazu).
More documentation to come.
This repository is an attempt to decouple input file format dependency of the original toolkit Supera
(repository) and currently under development.
Milestones
-
Working cmake build with python binding
-
Migrate SuperaMCParticleClusterData
-
Migrate SuperaBBoxInteraction
-
Migrate SuperaMCParticleCluster