{"id":25020730,"url":"https://github.com/km3net/km3buu","last_synced_at":"2026-02-22T02:34:30.253Z","repository":{"id":187514851,"uuid":"677032490","full_name":"KM3NeT/km3buu","owner":"KM3NeT","description":"Python GiBUU wrapper for KM3NeT","archived":false,"fork":false,"pushed_at":"2025-03-16T17:54:48.000Z","size":504,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-13T04:41:33.585Z","etag":null,"topics":["buu","gibuu","km3net","neutrino","neutrino-generator","particle","physics","python","scattering"],"latest_commit_sha":null,"homepage":"","language":"Python","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/KM3NeT.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-08-10T15:21:23.000Z","updated_at":"2024-08-04T14:02:55.000Z","dependencies_parsed_at":"2023-11-26T02:22:00.101Z","dependency_job_id":"b5e3bdd3-0c0f-4d6d-94f8-9adc552efcce","html_url":"https://github.com/KM3NeT/km3buu","commit_stats":null,"previous_names":["km3net/km3buu"],"tags_count":60,"template":false,"template_full_name":null,"purl":"pkg:github/KM3NeT/km3buu","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KM3NeT%2Fkm3buu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KM3NeT%2Fkm3buu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KM3NeT%2Fkm3buu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KM3NeT%2Fkm3buu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KM3NeT","download_url":"https://codeload.github.com/KM3NeT/km3buu/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KM3NeT%2Fkm3buu/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29703777,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T23:35:04.139Z","status":"online","status_checked_at":"2026-02-22T02:00:08.193Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["buu","gibuu","km3net","neutrino","neutrino-generator","particle","physics","python","scattering"],"created_at":"2025-02-05T12:17:23.745Z","updated_at":"2026-02-22T02:34:30.233Z","avatar_url":"https://github.com/KM3NeT.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image:: https://git.km3net.de/simulation/km3buu/-/raw/master/doc/_static/km3buu_logo.svg\n    :width: 300em\n    :alt: KM3BUU Logo\n\nKM3BUU\n======\n\n.. image:: https://img.shields.io/badge/docs-stable-blue.svg\n    :target: https://simulation.pages.km3net.de/km3buu\n\n.. image:: https://git.km3net.de/simulation/km3buu/badges/master/pipeline.svg\n    :target: https://git.km3net.de/simulation/km3buu/pipelines\n\n.. image:: https://git.km3net.de/simulation/km3buu/badges/master/coverage.svg\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8243040.svg\n    :target: https://doi.org/10.5281/zenodo.8243040\n\n**This is NOT an official KM3NeT software package.**\n\nThe KM3BUU project is an integrated python framework for wrapping the GiBUU particle interaction simulation https://gibuu.hepforge.org/trac/wiki . It is specifically designed for studies within the KM3NeT experiment and focuses on the neutrino simulation functionality of GiBUU.\n\nThe main code repository can be found at: https://git.km3net.de/simulation/km3buu\n\nThe framework covers all parts of the GiBUU workflow, which includes setting up the simulation configuarion inside a so-called jobcarb, running GiBUU and parsing the output files.\n\nInstallation\n------------\n\nThe main `KM3BUU` project is a python based framework, which can be used with a\nlocal GiBUU installation or used within a docker container. In order to install the `km3buu` python module the repository has to be retreived from the Git server first.\n\nFrom KM3NeT GitLab:\n\n.. code-block:: console\n\n   git clone https://git.km3net.de/simulation/km3buu\n   cd km3buu\n\nFrom GitHub:\n\n.. code-block:: console\n\n   git clone https://github.com/KM3NeT/km3buu\n   cd km3buu\n\nAfter downloading the repository the package can be installed via:\n\n.. code-block:: console\n\n   pip install -e\n\n(Up to now `KM3BUU` is not provided via python package manager.)\n\nIf working inside a docker environment is recommended, the KM3BUU image can be copied\u0026run directly from the KM3NeT docker server:\n\n.. code-block:: console\n\n   docker run -it --rm docker.km3net.de/simulation/km3buu:latest /bin/bash\n\nor built locally:\n\n.. code-block:: console\n\n   cd km3buu\n   docker build .\n\nThe docker image contains the latest release of `km3buu` as well as the GiBUU 2021 Patch 4 (release from 2023-03-23) including RootTuple extension is installed (km3buu v1.0.0).\n\n\nGetting started\n---------------\nThe GiBUU workflow starts from a jobcard which contains the configuration which should be simulated. The jobcards are technically FORTRAN namelists and can be created using a `Jobcard` object. In the example this is done via loading an existing jobcard:\n\n.. code-block:: python3\n\n    \u003e\u003e\u003e from km3buu.jobcard import Jobcard, read_jobcard\n\n    \u003e\u003e\u003e jc = read_jobcard(\"jobcards/examples/example.job\")\n\nAlternatively a neutrino jobcard can be generated from scratch via\n\n.. code-block:: python3\n\n    \u003e\u003e\u003e from km3buu.jobcard import Jobcard, generate_neutrino_jobcard\n\n    \u003e\u003e\u003e generate_neutrino_jobcard(1000, 1, \"CC\", \"muon\", (1,10))\n\nThis jobcard is subsequently forwarded to GiBUU via the `run_jobcard` function. The second argument takes a directory which should be used to write out all the output files generated by GiBUU.\n\n.. code-block:: python3\n\n    \u003e\u003e\u003e from km3buu.ctrl import run_jobcard\n\n    \u003e\u003e\u003e run_jobcard(jc, \"./output\")\n    0\n\nFinally, the output can be parsed using a `GiBUUOutput` object:\n\n.. code-block:: python3\n\n    \u003e\u003e\u003e from km3buu.output import GiBUUOutput\n\n    \u003e\u003e\u003e data = GiBUUOutput(\"./output\")\n\nThe event data can further be converted to a pandas dataframe\n\n.. code-block:: python3\n\n    \u003e\u003e\u003e df = data.df\n\nor an awkward array\n\n.. code-block:: python3\n\n    \u003e\u003e\u003e arr = data.arrays\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkm3net%2Fkm3buu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkm3net%2Fkm3buu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkm3net%2Fkm3buu/lists"}