{"id":26694481,"url":"https://github.com/deeplearnphysics/larcv2","last_synced_at":"2026-04-05T23:04:08.330Z","repository":{"id":43810952,"uuid":"107551725","full_name":"DeepLearnPhysics/larcv2","owner":"DeepLearnPhysics","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-13T20:53:02.000Z","size":1841,"stargazers_count":13,"open_issues_count":20,"forks_count":16,"subscribers_count":8,"default_branch":"develop","last_synced_at":"2025-04-13T00:34:59.308Z","etag":null,"topics":["cpp","image-processing","larcv","open-source","python","travis-ci"],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","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":"LICENSE","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}},"created_at":"2017-10-19T13:42:39.000Z","updated_at":"2024-11-13T20:52:46.000Z","dependencies_parsed_at":"2023-01-22T00:49:51.722Z","dependency_job_id":"15d3a713-74db-44dc-b24c-bc6116b43fd5","html_url":"https://github.com/DeepLearnPhysics/larcv2","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%2Flarcv2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2Flarcv2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2Flarcv2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepLearnPhysics%2Flarcv2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DeepLearnPhysics","download_url":"https://codeload.github.com/DeepLearnPhysics/larcv2/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650462,"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":["cpp","image-processing","larcv","open-source","python","travis-ci"],"created_at":"2025-03-26T18:29:45.023Z","updated_at":"2026-04-05T23:04:08.317Z","avatar_url":"https://github.com/DeepLearnPhysics.png","language":"C++","readme":"[![Build and Test](https://github.com/DeepLearnPhysics/larcv2/actions/workflows/build-test.yml/badge.svg)](https://github.com/DeepLearnPhysics/larcv2/actions/workflows/build-test.yml) [![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://raw.githubusercontent.com/DeepLearnPhysics/larcv2/develop/LICENSE) [![Docker](https://ghcr-badge.egpl.dev/deeplearnphysics/larcv2/latest_tag?label=ghcr.io)](https://github.com/DeepLearnPhysics/larcv2/pkgs/container/larcv2)\n\n\n# LArCV\nSoftware framework for image(2D)/volumetric(3D) data processing with APIs to interface deep neural network open-source softwares, written in C++ with extensive Python supports.  Originally developed for analyzing data from [time-projection-chamber (TPC)](https://en.wikipedia.org/wiki/Time_projection_chamber). It is then converted to be a generic tool to handle 2D-projected images and 3D-voxelized data. \n\n***Note*** This repository is re-created from LArbys/LArCV repository, referred to as larbys version. The larbys version is still under active development for analysis purpose in MicroBooNE experiment. This repository is split for more generic technical R\u0026D work in October 2017.\n\n## Quick Start with Docker 🐳\n\nThe easiest way to use LArCV2 is via Docker containers, which come with all dependencies pre-installed:\n\n```bash\n# Pull the latest image\ndocker pull ghcr.io/deeplearnphysics/larcv2:latest\n\n# Run interactively\ndocker run --rm -it ghcr.io/deeplearnphysics/larcv2:latest\n\n# Or use the helper script\n./docker-run.sh\n```\n\nDocker images are automatically built and published for every version tag. Available tags:\n- `latest` - Latest stable release\n- `develop` - Latest development version\n- `X.Y.Z` - Specific version (e.g., `2.3.0`)\n\nFor more Docker options, see the [Docker Usage](#docker-usage) section below.\n\n## Installation\n\n### Dependencies\n\n* ROOT6\n* Python (optional)\n* OpenCV 3 (optional)\n* Numpy (optional)\n\n### Setup\n\n0. Dependencies to build with are determined automatically through the following conditions.\n\n  * ROOT: determined through the ability to run rootcling\n  * OpenCV: the presence of OPENCV_INCDIR and OPENCV_LIBDIR environment variables\n  * Numpy: being able to import `numpy`\n\n1. Clone \u0026 build\n```\ngit clone https://github.com/DeepLearnPhysics/larcv2.git\ncd larcv2\nsource configure.sh\nmake\n```\nThat's it. When you want to use the built larcv from a different process, you only need to repeat ```source configure.sh``` and no need to re-```make```.\n\n\n## Wiki\n\nCheckout the [Wiki](https://github.com/DeepLearnPhysics/larcv2/wiki) for notes on using this code.\n\n## Docker Usage\n\n### Using Pre-built Images\n\nPre-built Docker images are available from GitHub Container Registry:\n\n```bash\n# Pull the latest stable release (Ubuntu 24.04)\ndocker pull ghcr.io/deeplearnphysics/larcv2:latest\n\n# Pull a specific version\ndocker pull ghcr.io/deeplearnphysics/larcv2:2.3.0-ubuntu24.04\n\n# Pull the latest development version\ndocker pull ghcr.io/deeplearnphysics/larcv2:develop-ubuntu24.04\n\n# Pull Ubuntu 22.04 version (for MinkowskiEngine compatibility)\ndocker pull ghcr.io/deeplearnphysics/larcv2:ubuntu22.04\n```\n\n**Ubuntu Versions:**\n- **Ubuntu 24.04**: Default, latest ROOT version (6.34.00)\n- **Ubuntu 22.04**: For compatibility with MinkowskiEngine and older systems (ROOT 6.32.02)\n\n### Running the Container\n\n**Interactive session:**\n```bash\ndocker run --rm -it ghcr.io/deeplearnphysics/larcv2:latest\n```\n\n**Run a Python script:**\n```bash\ndocker run --rm -v $(pwd):/data ghcr.io/deeplearnphysics/larcv2:latest python /data/your_script.py\n```\n\n**Using the helper script:**\n```bash\n# Interactive bash\n./docker-run.sh\n\n# Run with mounted data directory\n./docker-run.sh --mount /path/to/data python script.py\n\n# Use specific version\n./docker-run.sh --version 2.3.0 bash\n\n# Use Ubuntu 22.04 version\n./docker-run.sh --ubuntu-version 22.04 bash\n\n# See all options\n./docker-run.sh --help\n```\n\n### Building Locally\n\nTo build the Docker image locally:\n\n```bash\n# Build for Ubuntu 24.04 (default)\ndocker build -t larcv2:local .\n\n# Build for Ubuntu 22.04\ndocker build --build-arg UBUNTU_VERSION=22.04 --build-arg ROOT_VERSION=6.32.02 -t larcv2:ubuntu22.04 .\n```\n\n### Available Tags\n\nImages are automatically built and published for both Ubuntu 22.04 and 24.04 when version tags are pushed:\n- Pushing `v2.3.0` creates tags: `2.3.0-ubuntu24.04`, `2.3.0-ubuntu22.04`, `2.3-ubuntu24.04`, `2.3-ubuntu22.04`, `latest` (24.04)\n- Pushing to `develop` creates: `develop-ubuntu24.04`, `develop-ubuntu22.04`\n- Pushing to `main` creates: `main-ubuntu24.04`, `main-ubuntu22.04`\n- Always available: `ubuntu24.04`, `ubuntu22.04`\n\n## Releases\n\nTo create a new release:\n\n1. Update the version in `python/larcv/version.py`\n2. Commit the change: `git commit -am \"Bump version to X.Y.Z\"`\n3. Create and push a tag: `git tag vX.Y.Z \u0026\u0026 git push origin vX.Y.Z`\n4. GitHub Actions will automatically build and publish the Docker image to `ghcr.io/deeplearnphysics/larcv2:X.Y.Z`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeeplearnphysics%2Flarcv2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeeplearnphysics%2Flarcv2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeeplearnphysics%2Flarcv2/lists"}