{"id":26694473,"url":"https://github.com/deeplearnphysics/superaatomic","last_synced_at":"2025-04-13T00:35:10.392Z","repository":{"id":116515429,"uuid":"454908014","full_name":"DeepLearnPhysics/SuperaAtomic","owner":"DeepLearnPhysics","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-29T08:29:07.000Z","size":429,"stargazers_count":0,"open_issues_count":4,"forks_count":5,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-04-13T00:34:48.801Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DeepLearnPhysics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-02T19:31:16.000Z","updated_at":"2024-08-29T04:09:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"c63084db-1ca2-45c8-b68e-2ab66ce467df","html_url":"https://github.com/DeepLearnPhysics/SuperaAtomic","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2FSuperaAtomic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2FSuperaAtomic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2FSuperaAtomic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2FSuperaAtomic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DeepLearnPhysics","download_url":"https://codeload.github.com/DeepLearnPhysics/SuperaAtomic/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650461,"owners_count":21139670,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-26T18:29:40.457Z","updated_at":"2025-04-13T00:35:10.362Z","avatar_url":"https://github.com/DeepLearnPhysics.png","language":"C++","readme":"# SuperaAtomic\n\nC++ software to generate true labels for `lartpc_mlreco3d` ([repository](https://github.com/DeepLearnPhysics/lartpc_mlreco3d)), a full data reconstruction chain of modular machine learning (ML) algorithms for 3D particle images. The repository provides Python binding via [`pybind11`](https://pybind11.readthedocs.io/en/stable/), 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](https://github.com/ClarkMcGrew/edep-sim) framework and to produce [larcv](https://github.com/DeepLearnPhysics/larcv3), please see [edep2supera](https://github.com/DeepLearnPhysics/edep2supera).\n\n## How to build\n1. Use [this docker image](https://hub.docker.com/layers/deeplearnphysics/dune-nd-sim/ub20.04-cpubase-edep2supera/images/sha256-a9f01459ec3f67c85e2bea813d14d1069ca41a5d8f4b8f301336b992de238ca2?context=repo) (or any other container image derived from it) to get the _most_ of required softwares. Only additional item you would need is [scikit-build](https://scikit-build.readthedocs.io/en/latest/skbuild.html) which you can install with `pip`. \n  - If you know how to use `cmake` for building a software, you can actually skip `scikit-build` and run `cmake` from `src` directory.\n2. Clone this repository (below) or fork-and-clone.\n```\n\u003e git clone https://github.com/DeepLearnPhysics/SuperaAtomic\n```\n3. Pull pybind subpackage https://github.com/pybind/pybind11.\n```\n\u003e git submodule update --init\n```\n4. Build + Install (the example below installs under your `$HOME/.local` path)\n```\n\u003e pip install .\n```\n\n\n## ~~Software validation (unit test)~~\n~~Simply try:~~\n```\npytest test\n```\n~~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).~~\n\n** Currently unit test is disabled. TODO: revive the unit test after lots of changes in the source code. **\n\n## How to contribute\n1. Fork this repository to your personal github account.\n2. Clone the repository to your local machine. Follow the build/install instruction above and make sure you can set up.\n3. Create your branch to contain your own development.  Code code code.\n4. When it's ready to be shared, ~~make sure the unit test passes. Then~~ request to merge by sending a pull request.\n\n**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.\n\n## Communication for development\n* Feel free to use github issues! We try to be attentive as much as possible.\n* Join our weekly ND Technical Software Meeting (noon PST every Wednesday, here's [indico category](https://indico.slac.stanford.edu/category/23/)).\n* Join our mailing list dunend-simreco-technical@listserv.slac.stanford.edu\n  - 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 the `FIRST` and `LAST` with your first and last names respectively.\n* Join our slack channel (contact [Kazu](mailto:kterao@slac.stanford.edu)).\n\n## Status\n\nMore documentation to come.\nThis repository is an attempt to decouple input file format dependency of the original toolkit `Supera` ([repository](https://github.com/DeepLearnPhysics/Supera)) and currently under development.\n\nMilestones\n\n- [x] Working cmake build with python binding\n\n- [x] Migrate [SuperaMCParticleClusterData](https://github.com/DeepLearnPhysics/Supera/blob/icarus/SuperaMCParticleClusterData.h)\n\n- [x] Migrate [SuperaBBoxInteraction](https://github.com/DeepLearnPhysics/Supera/blob/icarus/SuperaBBoxInteraction.h)\n\n- [ ] Migrate [SuperaMCParticleCluster](https://github.com/DeepLearnPhysics/Supera/blob/icarus/SuperaMCParticleCluster.h)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeeplearnphysics%2Fsuperaatomic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeeplearnphysics%2Fsuperaatomic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeeplearnphysics%2Fsuperaatomic/lists"}