{"id":26694465,"url":"https://github.com/deeplearnphysics/edep2supera","last_synced_at":"2025-04-13T00:35:12.871Z","repository":{"id":43670341,"uuid":"457831813","full_name":"DeepLearnPhysics/edep2supera","owner":"DeepLearnPhysics","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-22T19:22:13.000Z","size":84,"stargazers_count":0,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-13T00:34:49.637Z","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-10T15:16:30.000Z","updated_at":"2024-08-22T19:22:16.000Z","dependencies_parsed_at":"2024-02-27T23:24:15.847Z","dependency_job_id":"ff21ac92-9d85-4f3a-accb-bdc9792b0b99","html_url":"https://github.com/DeepLearnPhysics/edep2supera","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2Fedep2supera","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2Fedep2supera/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2Fedep2supera/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2Fedep2supera/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DeepLearnPhysics","download_url":"https://codeload.github.com/DeepLearnPhysics/edep2supera/tar.gz/refs/heads/master","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:37.798Z","updated_at":"2025-04-13T00:35:12.854Z","avatar_url":"https://github.com/DeepLearnPhysics.png","language":"C++","readme":"# edep2supera\n\nC++/Python software to run `Supera` ([repository](https://github.com/DeepLearnPhysics/SuperaAtomic)), a library that can generate true labels for a ML based data reconstruction chain called `lartpc_mlreco3d` ([repository](https://github.com/DeepLearnPhysics/lartpc_mlreco3d)). This repository is dedicated to interface [EDepSim](https://github.com/ClarkMcGrew/edep-sim) and [larcv](https://github.com/DeepLearnPhysics/larcv2) frameworks that input and output information in data files respectively. \n\n## Python binding\n\nExecutable scripts are in Python and C++ classes and functions are bound to Python via [PyROOT](https://root.cern/manual/python/) following a pattern used by EDepSim (as opposed to Supera which uses [pybind11](https://pybind11.readthedocs.io/en/stable/)). This allows both edep2supera and EDepSim methods to access C++ objects within Python in a common manner.\n\n## How to build and install\n\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`. \n2. Clone this repository (below) or fork-and-clone.\n```\n\u003e git clone https://github.com/DeepLearnPhysics/edep2supera\n```\n3. Build+Install (the example below installs under your `$HOME/.local` path)\n```\n\u003e pip install . --user\n```\n\n## Software validation (unit test)\nSimply try:\n```\npytest\n```\nat the top-level directory. \n\n## How to contribute\n\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 a 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\nMilestones\n\n- [x] Fill Supera datatypes from EDepSim datatypes (i.e. TG4Event attributes)\n- [x] Implement particle hierarchy tracking algorithm from [old Supera](https://github.com/DeepLearnPhysics/Supera)\n- [x] Implement a python run script to fill input data and run Supera\n- [x] Implement a python run script to drive larcv to create an output file and store information from Supera\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeeplearnphysics%2Fedep2supera","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeeplearnphysics%2Fedep2supera","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeeplearnphysics%2Fedep2supera/lists"}