From 13fbf73da358bdd4ed1b20751854a7e35c8646a7 Mon Sep 17 00:00:00 2001 From: Whitney Armstrong <warmstrong@anl.gov> Date: Thu, 6 May 2021 20:27:47 +0000 Subject: [PATCH] Resolve "README.md: instructions for compilation and testing" --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b386cf70..10797095 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,46 @@ Overview The reference detector at IP6 for Electron-Ion Collider experiment. <a href="https://eicweb.phy.anl.gov/api/v4/projects/447/jobs/artifacts/master/raw/images/view01.pdf?job=report"> -<img src="https://eicweb.phy.anl.gov/api/v4/projects/447/jobs/artifacts/master/raw/images/view01.png?job=report" width="600px" /> +<img src="https://eicweb.phy.anl.gov/api/v4/projects/447/jobs/artifacts/master/raw/images/view01.png?job=report" width="400px" /> </a> <br /> <a href="https://eicweb.phy.anl.gov/api/v4/projects/447/jobs/artifacts/master/raw/images/view01_top.pdf?job=report"> -<img src="https://eicweb.phy.anl.gov/api/v4/projects/447/jobs/artifacts/master/raw/images/view01_top.png?job=report" width="600px" /> +<img src="https://eicweb.phy.anl.gov/api/v4/projects/447/jobs/artifacts/master/raw/images/view01_top.png?job=report" width="400px" /> </a> +Getting Started +--------------- + +### Adding/changing detector geometry + +Hint: **Use the CI/CD pipelines**. + +To avoid dealing with setting up all the software, we recommend using the CI/CD to make changes. +Any feedback to help this process is appreciated. + +Here is how to begin: + +1. Look at existing detector constructions and reuse if possible. Note that "compact detector descriptions" -> xml files, and "detector construction" -> cpp file. +2. Modify xml file or detector construction. +3. Create a WIP (or draft) merge request and look at the CI output for debugging. Then go to back to 2 if changes are needed. +4. Remove the WIP/Draft part of the merge request if you would like to see your changes merged into the master. + +### Compiling + +First, see if the use case above is best for you. It most likely is and can save a lot of time for newcomers. +To run the simulation locally, we suggest using the singularity image. +More details can be found at the links below: + +- https://eic.phy.anl.gov/tutorials/eic_tutorial/ +- https://eicweb.phy.anl.gov/containers/eic_container/ + + + + + + Related useful links -------------------- -- GitLab