Skip to content
Snippets Groups Projects
Commit 112e1392 authored by Whitney Armstrong's avatar Whitney Armstrong
Browse files

Updated the readme with some getting stared information.

parent 9fae0340
No related branches found
No related tags found
1 merge request!72Resolve "README.md: instructions for compilation and testing"
Pipeline #9261 passed
......@@ -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 #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
--------------------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment