Merge pull request #36 from eic/iss35

I approved the changes to the landing page.

_documentation/faq.md

@@ -7,55 +7,89 @@ layout: default
 
 {% include layouts/title.md %}
 
-#### How to get help
-* Use the [Helpdesk](https://eic.cloud.mattermost.com/main/channels/helpdesk) on Mattermost.
-* Submit new questions to the FAQ by emailing us at: [email protected] 
+Welcome to the **Frequently Asked Questions** page!
+Please use the [Helpdesk](https://eic.cloud.mattermost.com/main/channels/helpdesk) on Mattermost
 
-#### ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Submit new questions and comments by email: [![emailicon](../assets/images/site/icons/email.png){: width="3%" }](mailto:[email protected])
 
-###### Working with simulation files on S3:
+------------------------
 
-* [How can we access simulation files on S3 storage?](https://doc.athena-eic.org/en/latest/howto/s3_file_storage.html)
-* How can we work with trees in S3 storage without downloading files?
-* How can we locate specific files in S3 and better understand their directory structure?
-* How can we determine the properties of simulated files, such as parameters, particles, and energies?
+**Q: How can we access simulation files on S3 storage?**
 
-##### Tracking
+A: See [https://doc.athena-eic.org/en/latest/howto/s3_file_storage.html](https://doc.athena-eic.org/en/latest/howto/s3_file_storage.html)
 
-* How can we effectively use the information stored in EICRecon rootfile outputs, such as matching reconstructed particles to their MC particles?
+**Q: How can we locate specific files in S3 and better understand their directory structure?**
 
-##### Far Forward/Far Backward detectors
+A: **TODO:** Ask Prod for 1-2 lines on the directory structure; tutorials cover how to navigate (one can use a web interface as well)
 
-* How can we apply beam effects, including adjusting the ion beam when using a particle gun?
-* How do we check and change beam magnet settings for both simulation and reconstruction?
+**Q: How can we determine the properties of simulated files, such as parameters, particles, and energies?**
 
+A: **TODO:** Production knows best, but more or less by the file name.
 
-##### Inclusive physics
+**Q: How can we effectively use the information stored in EICRecon rootfile outputs, such as matching reconstructed particles to their MC particles?**
 
-* What are the commands for browsing files on S3 and copying them to local directories?
-* How can we load files into ROOT directly from S3?
-* What is the best practice for analyzing EICrecon output, especially regarding hadron PID likelihoods?
+A: To an extent, this is covered in the [dRICH tutorials](https://github.com/eic/drich-dev/blob/tutorial/doc/tutorials/3-running-reconstruction.md), starting at session 3 and partly covered in existing [recorded tutorials](https://indico.bnl.gov/event/18373/). **TODO:** Probably needs to be supplemented with example codes. 
 
+**Q: How can we apply beam effects, including adjusting the ion beam when using a particle gun?**
 
-##### Exclusive, diffractive and tagging phyiscs
+A: Beam effects are handled by the [afterburner](https://github.com/eic/afterburner), which expects HepMC3 input. They cannot be simply turned on in just the npsim particle gun. 
 
-* How can we develop a benchmark for an analysis code to pass on to the validation software team?
+**Q: How do we check and change beam magnet settings for both simulation and reconstruction?**
 
-##### Semi-inclusive physics
+A: **TODO:**Changing magnet configuration in reconstruction makes little sense. Checking and changing it for simulation should be answered by the prod group.
 
-* What is included in the campaign, and what are the major changes compared to before?
-* How can we access various (SI)DIS variables through different reconstruction methods?
-* How do we match tracks and clusters from the calorimeters?
-* How can we access hadron and electron PID data?
-* How do we navigate from reconstructed to truth information?
+**Q: What are the commands for browsing files on S3 and copying them to local directories?**
 
+**Q: How can we load files into ROOT directly from S3?**
 
-##### Jets and Heavy Flavor physics
+A: Recommended way currently is using the XrootD mirror because it doesn't need a password. See:
+```
+    auto f = TFile::Open("root://dtn-eic.jlab.org//work/eic2/EPIC/RECO/23.09.1/epic_craterlake/DIS/NC/18x275/minQ2=1000/pythia8NCDIS_18x275_minQ2=1000_beamEffects_xAngle=-0.025_hiDiv_1.0000.eicrecon.tree.edm4eic.root")
+```
+or, for browsing:
+```
+    xrdfs root://dtn-eic.jlab.org   
+    ls /work/eic2/EPIC/RECO/23.09.1/epic_craterlake/DIS/NC/18x275/minQ2=1000
+```
+To use S3, you need the minimal step:
+```
+    export S3_ACCESS_KEY=[ask in mattermost]
+    export S3_SECRET_KEY=[ask in mattermost]
+    mc config host add S3 https://eics3.sdcc.bnl.gov:9000 $S3_ACCESS_KEY $S3_SECRET_KEY
+    auto f = TFile::Open("s3https://eics3.sdcc.bnl.gov:9000/eictest/EPIC/RECO/23.09.1/epic_craterlake/DIS/NC/18x275/minQ2=1000/pythia8NCDIS_18x275_minQ2=1000_beamEffects_xAngle=-0.025_hiDiv_1.0000.eicrecon.tree.edm4eic.root")
+```
 
-* Is there an organized repository or wiki that guides newcomers to the right tutorials and slides?
-* Are there quick starter-code examples (Analyzer macros) for accessing branch information and creating physics plots?
+**Q: What is the best practice for analyzing EICrecon output, especially regarding hadron PID likelihoods?**
 
-##### Beyond the Standard Model and precision electroweak phyiscs
+A: **TODO:** Needs an updated analysis tutorial. I don't believe at this point we have a simple unified PID likelihood approach.
 
-* Can you provide an example of analyzing EICrecon data using basic methods?
+**Q: How can we develop a benchmark for an analysis code to pass on to the validation software team?**
+
+A: **TODO:** We originally planned a dedicated "Tutorial: Writing physics benchmarks that run automatically and reproducibly" - this needs to be revisited. Otherwise, Dmitry K, Wouter, Sylvester may be able to write up something short. This is a good FAQ candidate really, if we can get this answered.
+
+**Q: What is included in the campaign, and what are the major changes compared to before?**
+
+**Q: How can we access various (SI)DIS variables through different reconstruction methods?**
+
+A: **TODO:** Things like ``InclusiveKinematicsDA.cc`` are part of EicRecon, but I don't know how to use it. I don't believe it's calculated by default during campaigns, so one would still need an analysis level version. Would be good example analysis code, and I'm sure it exists in many forms on various people's laptops.
+
+**Q: How do we match tracks and clusters from the calorimeters?**
+
+**Q: How can we access hadron and electron PID data?**
+
+**Q: How do we navigate from reconstructed to truth information?**
+
+A: Needs a refreshed tutorial; needs example code
+
+**Q: Is there an organized repository or wiki that guides newcomers to the right tutorials and slides?**
+
+A: Yes, but the dRICH one is closest, plus the tutorials indico. **TODO:** Should be combined and front and center of the landing page.
+
+**Q: Are there quick starter-code examples (Analyzer macros) for accessing branch information and creating physics plots?**
+
+A: **TODO:** Yes, but not well organized and more is better.
+
+**Q: Can you provide an example of analyzing EICrecon data using basic methods?**
+
+A: [https://indico.bnl.gov/event/18373/](https://indico.bnl.gov/event/18373/) has some, so does the dRICH tutorial. **TODO:** Needs more example code.
 

_documentation/getstarted.md

@@ -7,8 +7,23 @@ layout: default
 
 {% include layouts/title.md %}
 
-##### Get Started:
+Welcome to the **Get Started** section. This page will guide you through the steps to get setup for contributing and working in our software framework. 
 
-* Join GitHub: [https://gitlab.com/eic](https://gitlab.com/eic)
-* Join Mattermost: [https://chat.epic-eic.org/](https://chat.epic-eic.org/)
-* Link to ePIC Software Tutorials
+1. Join GitHub: [https://gitlab.com/eic](https://gitlab.com/eic)
+* We use GitHub to maintain our code under the eic organization
+* Contact for read access: [![emailicon](../assets/images/site/icons/email.png){: width="3%" }](mailto:[email protected]) **[email protected]** from your institutional email address. In your email, please state your GitHub username and whether you or your sponsor/advisor is a member of the EICUG.
+* For write access to select repositories, you may request to join variou GitHub teams.
+
+1. Join Mattermost: [https://chat.epic-eic.org/](https://chat.epic-eic.org/)
+* We use Mattermost for our main communication channel.
+* You can join by emailing any group member to be added.
+1. Sign up for our mailing lists:
+* Collaboration mailing list ([subscribe here](https://lists.bnl.gov/mailman/listinfo/eic-projdet-collab-l)): [![emailicon](../assets/images/site/icons/email.png){: width="3%" }](mailto:[email protected]) **[email protected]** 
+* Software mailing list ([subscribe here](https://lists.bnl.gov/mailman/listinfo/eic-projdet-compsw-l)): [![emailicon](../assets/images/site/icons/email.png){: width="3%" }](mailto:[email protected]) **[email protected]** 
+
+1. Join a project! Checkout the [ePIC wiki](https://wiki.bnl.gov/EPIC/index.php?title=Collaboration) to get involved:
+* [Physics Working Group](https://wiki.bnl.gov/EPIC/index.php?title=Collaboration)
+* [Detector Subsystems](https://wiki.bnl.gov/EPIC/index.php?title=Collaboration)
+* [Software Working Group](https://wiki.bnl.gov/EPIC/index.php?title=Collaboration)
+
+1. Refer back to the [landing page](./landpage.html) to checkout [HEP Software](https://hepsoftwarefoundation.org/training/center.html) and [ePIC tutorials](./tutorials.html)

_documentation/landingpage.md

@@ -7,11 +7,14 @@ layout: default
 
 {% include layouts/title.md %}
 
-Welcome to the **ePIC Landing Page**! 
+[![Get Started](../assets/images/support/GetStartedClick.png){: width="48%" }](./getstarted.html)
+[![ePIC Tutorials](../assets/images/support/TutorialClick.png){: width="48%" }](./tutorials.html)
+[![HEP Software Training Center](../assets/images/support/HEPClick.png){: width="48%" }](https://hepsoftwarefoundation.org/training/center.html)
+[![FAQ](../assets/images/support/faqClick.png){: width="48%" }](./faq.html)
 
-[![Get Started](../assets/images/support/GetStartedClick.png){: width="45%" }](./getstarted.html)
-[![ePIC Tutorials](../assets/images/support/TutorialClick.png){: width="45%" }](./tutorials.html)
-[![HEP Software Training Center](../assets/images/support/HEPClick.png){: width="45%" }](https://hepsoftwarefoundation.org/training/center.html)
-[![FAQ](../assets/images/support/faqClick.png){: width="45%" }](./faq.html)
+Welcome to the **ePIC Landing Page**!
 
+Our mailing list: [![emailicon](../assets/images/site/icons/email.png){: width="3%" }](mailto:[email protected]) [email protected]
+
+Subscribe here: [https://lists.bnl.gov/mailman/listinfo/eic-projdet-compsw-l](https://lists.bnl.gov/mailman/listinfo/eic-projdet-compsw-l)
 

_documentation/tutorials.md

@@ -7,13 +7,25 @@ layout: default
 
 {% include layouts/title.md %}
 
-##### ePIC Software Tutorials page: 
+##### [Setting up an environment](https://eic.github.io/tutorial-setting-up-environment)
+[![EnvSS](../assets/images/Tutorials/SetupEnvSS.png){: width="60%" }](https://eic.github.io/tutorial-setting-up-environment)
+[![video1](../assets/images/Tutorials/Vid1Env.png){: width="18%" }](https://www.youtube.com/watch?v=Y0Mg24XLomY)
+[![video2](../assets/images/Tutorials/Vid2Env.png){: width="18%" }](https://www.youtube.com/watch?v=5HmzFnYW4W4)
 
-1.  [Setting up an enviroment](https://eic.github.io/tutorial-setting-up-environment/) [ (video 1, ](https://www.youtube.com/watch?v=Y0Mg24XLomY) [video 2)](https://www.youtube.com/watch?v=5HmzFnYW4W4)
-1. [Geometry within dd4hep - how to modify or add detector description](https://eic.github.io/tutorial-geometry-development-using-dd4hep/) [ (video 1, ](https://www.youtube.com/watch?v=Bj2L4JuCuRk) [video 2)](https://www.youtube.com/watch?v=RJAHnEW9cYk)
-1. [Simulation with ePIC singularity container](https://eic.github.io/tutorial-simulations-using-ddsim-and-geant4/) [ (video 1, ](https://www.youtube.com/watch?v=QjjD1_wjLIw) [video 2)](https://www.youtube.com/watch?v=WqSQ4m_esUw)
-1. [Reconstruction framework](https://eic.github.io/tutorial-jana2/) [ (video)](https://youtu.be/Ly2Zh1AGUEc https://youtu.be/9blKFZS-qMk)
-1. [DIS, SIDIS, and jet studies using epic-analysis](https://github.com/eic/epic-analysis/blob/main/README.md)
-1. [Analysis examples using XRootD and uproot](https://github.com/eic/python-analysis-bootcamp)
-1. [Tutorial: access ePIC container, simulation steps and data location, reconstructed ROOT tree](https://indico.bnl.gov/event/18373/)
-1. [Tutorial: analysis framework and reconstruction, visualization of detector and events, job submission](https://indico.bnl.gov/event/18374/)
+##### [Geometry within dd4hep](https://eic.github.io/tutorial-geometry-development-using-dd4hep/)
+[![GeoDevSS](../assets/images/Tutorials/GeoDevSS.png){: width="60%" }](https://eic.github.io/tutorial-geometry-development-using-dd4hep/)
+[![video1](../assets/images/Tutorials/GeoVid1.png){: width="18%" }](https://www.youtube.com/watch?v=Bj2L4JuCuRk)
+[![video2](../assets/images/Tutorials/GeoVid2.png){: width="18%" }](https://www.youtube.com/watch?v=RJAHnEW9cYk)
+
+##### [Simulations using ddsim and geant4](https://eic.github.io/tutorial-simulations-using-ddsim-and-geant4/)
+[![SimTutSS](../assets/images/Tutorials/SimTutSS.png){: width="60%" }](https://eic.github.io/tutorial-simulations-using-ddsim-and-geant4/)
+[![video1](../assets/images/Tutorials/SimVid1.png){: width="18%" }](https://www.youtube.com/watch?v=QjjD1_wjLIw)
+[![video2](../assets/images/Tutorials/SimVid2.png){: width="18%" }](https://www.youtube.com/watch?v=WqSQ4m_esUw)
+
+##### [Reconstruction framework](https://eic.github.io/tutorial-jana2/)
+[![ReconTutSS](../assets/images/Tutorials/ReconTutSS.png){: width="60%" }](https://eic.github.io/tutorial-jana2/)
+[![video1](../assets/images/Tutorials/RecVid1.png){: width="18%" }](https://www.youtube.com/watch?v=Ly2Zh1AGUEc)
+[![video2](../assets/images/Tutorials/RecVid2.png){: width="18%" }](https://youtu.be/Ly2Zh1AGUEc https://youtu.be/9blKFZS-qMk)
+
+##### [Analysis bootcamp](https://github.com/eic/python-analysis-bootcamp)
+[![AnaBootcampSS](../assets/images/Tutorials/AnaBootcampSS.png){: width="50%" }](https://github.com/eic/python-analysis-bootcamp)