eic.github.io/_documentation/getstarted.md

0001 ---
0002 title: Get Started
0003 description: Get Started
0004 name: getstarted
0005 layout: default
0006 ---
0007
0008 {% include layouts/title.md %}
0009
0010 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.
0011
0012 1. **Join GitHub:** [https://github.com/eic](https://github.com/eic)
0013 * GitHub serves as a central platform for version control, code review, issue tracking, and documentation. We maintain the [EIC](https://github.com/eic) organization on GitHub for collaborative development of all software related to the EIC.
0014 * **Read Access:** Contact [![emailicon](../assets/images/site/icons/email.png){: width="3%" }](mailto:eic-software-l-request@lists.bnl.gov) **[eic-software-l-request@lists.bnl.gov](mailto:eic-software-l-request@lists.bnl.gov)** from your institutional email address. Include in your email your GitHub username and confirmation of whether you or your sponsor/advisor is a member of the EICUG or ePIC. Make sure that your GitHub profile displays your full name and affiliation.
0015 * **Write Access:** For access to specific repositories, you can request to join various GitHub teams. For example, join '[EPIC Devs](https://github.com/orgs/eic/teams/epic-devs)’ for software development within the ePIC collaboration.
0016
0017 2. **Join Mattermost**: [https://chat.epic-eic.org/](https://chat.epic-eic.org/)
0018 * We use Mattermost for our main communication channel.
0019 * You can join by emailing any group member to be added.
0020 3. **Sign up for our mailing lists**:
0021 * 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:eic-projdet-collab-l@lists.bnl.gov) **eic-projdet-collab-l@lists.bnl.gov**
0022 * 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:eic-projdet-compsw-l@lists.bnl.gov) **eic-projdet-compsw-l@lists.bnl.gov**
0023
0024 4. **Join a project**! Checkout the [ePIC wiki](https://www.epic-eic.org/) to get involved:
0025 * [Physics Working Group](https://www.epic-eic.org/physics/analysis_coordination.html)
0026 * [Detector Subsystems](https://www.epic-eic.org/detector/dsc.html)
0027 * [Software Working Group](https://www.epic-eic.org/sc/sc_overview.html)
0028
0029 5. Checkout **[HEP Software](https://hepsoftwarefoundation.org/training/center.html)** and **[ePIC tutorials](./tutorials.html)**
0030
0031 6. As an interactive way to learn different aspects of the EIC/ePIC software framework, you might want to try the **[Scavenger Hunt](https://eic.github.io/scavenger-hunt)**
0032
0033 {% include documentation/getstarted_stack_diagram.html %}