Getting-Started Guide

This Getting Started Guide is designed to offer essential information to assist you (a potential, new or current member) in navigating the diverse array of resources and opportunities provided within the Euclid Consortium. Herein, you’ll find information on the membership process, project management, ongoing activities, code development, data access, external resources, and where to seek assistance when needed. Our goal is to ensure that you feel informed and prepared to engage with the Euclid community effectively.

This guide has been curated for you by the Euclid Consortium Information and Communication Management (ECICOM) group. Our central role is dedicated to facilitating internal communication and managing information within the Euclid Consortium (EC). We aim to help you become well acquainted with the Euclid Consortium’s complex organisational landscape. If you have any questions or need assistance, feel free to reach out to us via the EC Slack (internal access required) or through the designated points of contact provided throughout this guide.

Membership Management

This section explains everything you need to know about joining and maintaining your membership with the Euclid Consortium. Whether you’re a prospective member or a member looking to update your account information, the following subsections provide guidance on the application process, activity reporting, login credentials and instructions when changing institutes.

Membership application process

If you are interested in becoming a member of the Euclid Consortium, the first prerequisite is to verify your eligibility and understand your status within the consortium. Please follow the steps outlined below.

1. Eligibility Verification: Begin by reading this short document to verify that you are eligible and under which status. Take a moment to ensure that you meet the necessary criteria for membership.

2. Understanding Your Status: Each status comes with different privileges and responsibilities. Therefore, it is important to understand your status within the consortium. Be sure to:

a. Contact your national representative, as advised in the document referenced in step (1) above, for further guidance.

b. Complete the membership request form and remember to read and accept the Euclid Consortium’s Code of Conduct.

c. Monitor your mailbox for further instructions, including requests to upload your CV and a motivation letter.

3. Accessing Resources: Once your membership is confirmed, you’ll gain access to the various resources and opportunities exclusively available to EC members. These resources include portals, project management tools, data repositories, and collaboration platforms described in this Getting Started guide.

Tracking Portal for activity reporting and membership status

Once your membership is confirmed, you will be granted access to the various internal project and data management platforms in accordance with your membership type. The Tracking P o rtal facilitates this by providing comprehensive tools for recording, monitoring, and approving contributions made by project members.

The Tracking Portal will prompt you every 6 months to log your work on Euclid in order to assign you a membership status (Contributing Member, Long-term Contributor, or a Builder) which entitles you to sign different EC publications. Please consult the Euclid Consortium Effort Tracking document for instructions on how to report your effort and understand the weighting of different activities. Failure to submit anything for 2 years will result in being marked as an “Inactive Member”, leading to loss of access to EC resources such as pages and portals. Please note that if your account is marked as “Inactive Member”, you cannot reactivate it alone. In this case, please contact your national representative in the Euclid Consortium Board.

ESA Cosmos: Login credentials and authentication system

The ESA Cosmos Portal, formerly used for hosting some wikis (now migrating to Redmine), provides login credentials to all Euclid Consortium (EC) members. It serves as a gateway to access certain resources and information related to the Euclid project within the European Space Agency (ESA) Cosmos infrastructure.

Access to ESA Cosmos provides login credentials for several other portals, making it a vital resource for EC members. Furthermore, authentication through ESA Cosmos ensures secure access to these portals. For details on the authentication system used for each portal, please refer to the table in the Authentication System Overview section. Upon approval of your Euclid Consortium membership, a ticket will be submitted on your behalf to the Euclid Cosmos Helpdesk, simplifying the access process. Please be aware it may take up to 10 business days for your new account to be created, so we appreciate your patience during this process.

Note to Current Members: If you are currently a member of the Euclid Consortium but not part of ESA’s list of EC members, efforts are underway to unify this list with the membership data stored in the Tracking Portal. This initiative aims to streamline access to ESA Cosmos and other valuable resources for all consortium members. If you need to gain some priority in this long process, please submit your request at the Euclid Cosmos Helpdesk. Further details and guides can be found in the dedicated Redmine wiki page (internal access required) associated with the ESA Cosmos portal.

Updating membership details

If you need to update your membership details due to a recent institute change within the Euclid Consortium, follow these steps:

1. Update Email and Affiliation: To update an email address or affiliation, you’ll need to make changes in both the Tracking Portal and ESA Cosmos (internal access required). These changes will affect your access to all portals. Do the following:

a. Update your email address/affiliation on the Tracking Portal (IMPORTANT: update it in the My Account section in the left menu, NOT using the Change my email address option in the top menu).

b. Next, sign into your account on ESA/COSMOS, open your account (using the drop-down menu on the top right), and update your email address/affiliation in the Personal Details tab.

2. Notify National EC Representative: Contact your current national EC representative to inform them about the change. They will guide you through the process and ensure that your affiliation change is processed smoothly.

Please note that these updates may take 2-3 business days to reflect across all systems. However, by following these steps, you ensure a seamless transition and uninterrupted access to EC resources during this period of change.

If your new institute is not in an EC member country or if you are leaving the Euclid Consortium, it’s important to reach out to your national representative for guidance on the transition process as well as other opportunities to continue contributing to the Euclid mission if desired.

Project Management

Collaboration within Euclid is structured around Groups and Projects. Groups represent the hierarchical, organisational structure within the consortium, while Projects coordinate members for the research and the writing of EC publications on specific subjects.

Projects Portal for project management

Both Groups and Projects are managed within the Projects Portal (internal access required) where EC members can propose new projects or join existing ones. Each entity has access to various resources including mailing lists and a Redmine subproject/wiki (provided on request), which can be accessed via links on the overview pages in the Projects Portal. For EC members, detailed instructions on using the Projects Portal can be found within the internal help pages. If you’re interested in joining existing projects, please refer to the next section on ‘Projects Portal for Joining Projects‘ for more information.

Redmine for collaborative project management

The Euclid Consortium (EC) Redmine (internal access required) serves as the central hub for wikis and project management tools, such as issue tracking and project planning, for both Groups and Projects within the collaboration. Additionally, the Redmine platform offers other features, such as file hosting in the Document Management System (DMS) tab, which we highly encourage all teams to utilise. EC members can access further guidance through the internal help pages which also feature Redmine usage tips.

Ongoing Activities and How to Join Them

Once you have access to most of the resources mentioned on this page (or while you are waiting for access), you can explore the list of group leads. If you find a group you’re interested in joining, contacting its leads is the next step. Once you gain access to the group’s main space, you’ll have the opportunity to explore specific work packages (WPs) and join those that align with your interests by contacting their respective leads.

Projects Portal for proposing or joining projects

As mentioned in the previous section, the Projects Portal (internal access required) provides a resource for new members to explore ongoing projects and planned papers within the Euclid Consortium (EC). Here, members can browse through existing projects as well as associated papers, learn about their objectives, and discover opportunities to contribute. Each project features an action button that allows members to join the project directly. By clicking “Join Project” members will be added to the project’s mailing list to learn about upcoming telecons and activities to begin participating right away.

The Projects Portal is also the place where new projects or papers within an existing (approved) project have to be proposed. The EC Publication Policy requires that papers originate from an EC Publication Group-approved project. Make sure to register new papers through the administrator of a project well ahead of time, optimally before the writing starts – or risk a rejection later when it conflicts with already existing approved papers. Find more information here (internal access required).

Publication Portal for accessing publications

The Publication Portal (internal access required) is the dedicated platform for managing publications within the Euclid Consortium (EC). It provides essential tools for browsing, commenting on, and signing EC Publications under review by the Euclid Consortium Editorial Board (ECEB).

Lead authors of a paper are defined by the corresponding author(s) of a paper. Other EC members may qualify as eligible authors either based on their Full-Time Equivalent (FTE) contributions, as tracked by the FTE Tracking Portal at the time of the paper announcement, or by possessing Founder/Builder status. More information on Founder and Builder statuses can be found here and here, respectively.

Eligible authors are invited to sign a paper by the Publication Portal, both by email and by a link provided on the overview page. New papers or EC Publications are submitted by the paper contact (i.e., corresponding author) to the ECEB through an existing and approved project on the Projects Portal (refer to the Projects Portal for proposing or joining projects section for details).

For more detailed information, please consult the Publication Portal wiki page (internal access required). Additionally, you can refer to the ECEB style guide (internal access required) for guidance on writing Euclid publications according to consortium standards.

Speaker’s Bureau Portal for external talks submission

The Speaker’s Bureau Portal oversees the submission of external talks related to the Euclid project. It offers talk templates and helps track speakers for high-level conferences, fostering the dissemination of Euclid’s scientific findings to wider audiences. For more information about the Speaker’s Bureau Portal, please visit the Speaker’s Bureau website.

EC Slack for real-time communication and collaboration

The Euclid Consortium (EC) Slack (internal access required) serves as our primary platform for real-time communication and collaboration. It enables quick discussions and keeps members updated on project developments as they occur. You will receive an invitation to join the EC Slack within 2-3 days after your addition to the Tracking Portal database. Ensure that you have read and agree to the Slack Management and User Guidelines (internal access required) and memorised the Slack Rules and Tips (internal access required) for optimal use and adherence to community standards.

Please note that there is only one official Euclid Slack workspace. If you manage or come across any workspaces dedicated to Euclid, please let the ECICOM know so that we can assist in migrating them. Most workspaces have migrated as of Summer 2023, ensuring centralised communication and collaboration within the Euclid community.

One of the notable features of the EC Slack is its glossary resolution app, which helps decipher numerous EC and ESA acronyms. Additionally, it serves as a valuable tool for improving project coordination and knowledge sharing within the EC community. For more details, please refer to the EC Slack wiki page (internal access required).

Code Development for the EC

In the dynamic environment of the Euclid Consortium, software development plays a vital role in reaching the mission’s objectives. The Science Ground Segment (SGS) leads the development of the data processing and science analysis pipelines that will transform Euclid raw data into science-ready data products. This section introduces the tools and resources available for developers within the consortium, and in particular, those joining the SGS.

GitLab for version control and collaboration on Euclid software

GitLab (internal access required) serves as the central software repository for all Euclid Science Ground Segment (SGS) software. It is developed within the Euclid Collaborative Development Environment platform (internal access required), encompassing various science codes and projects.

Developer’s Wiki for guidance on Euclid-compliant software development

The Developer’s Wiki (internal access required) provides a resource for developers working on the Science Ground Segment data processing pipelines within the Euclid Consortium. It offers comprehensive documentation on key concepts and tools necessary for developing Euclid-compliant software. The wiki covers various topics, including:

-Tutorials: Step-by-step guides for beginners to get started creating software for Euclid’s Science Ground Segment pipelines

-Installation Instructions: Detailed instructions on how to set up the development environment and necessary tools.

-FAQs: Answers to commonly asked questions about software development for the Euclid project.

-How-to Guides: Practical guides on specific tasks and best practices for developing Euclid software.

-Architecture Overview: An overview of the software architecture, including important diagrams and explanations.

These tools are curated to provide developers with the information they need to efficiently contribute to the development of software that meets Euclid’s standards.

Data Access and Storage Facilities

To maximise engagement with the Euclid Consortium’s data facilities, it’s crucial for members to familiarise themselves with its key components. Depending on your role within the consortium, specific sections may be particularly relevant to you. If you’re a developer or pipeline scientist within the Science Ground Segment (SGS), you’ll utilise various facilities to manage data and parameters efficiently within your pipeline. These include the Mission Database for storing important mission parameters, as well as certain subsystems of the Euclid Archive System for data processing and data storage described in the section Euclid Archive System for Euclid data management. If you’re a member within the Science Working Groups interested in analysing science-ready data products, you can find relevant information and important links within the dedicated section on the Euclid Archive System’s Science Archive System.

Mission Database for storing mission parameters

The Euclid Mission Database (MDB) (internal access required) serves as a centralised repository for storing key parameters of the Euclid mission, including instrument details and scientific objectives. It provides comprehensive documentation, reference data, and mission status updates to support various stakeholders, including SGS Software Developers, ESA Project, Euclid Consortium members, and Industry contractors. The MDB ensures version control and efficient distribution of mission-critical parameters. For more detailed information, please refer to the MDB wiki page (internal access required).

Euclid Archive System for Euclid data management

The Euclid Archive System (EAS) provides access to Euclid’s extensive collection of science data, serving as a central repository for storing and retrieving information generated by the Euclid mission. The Euclid Archive System comprises three system components:

DPS, Data Processing System: The DPS is the central database system, hosted at ESAC (European Space Astronomy Centre), where all data products from the mission are stored.

DSS, Distributed Storage System: Deployed at the Science Data Centres (SDCs), the DSS stores locally produced files, primarily in FITS format.

SAS, Science Archive System: Hosted at ESAC, the SAS allows publication of validated SGS results to the Science Working Groups and to the broader public.

Members who plan to work on a project within the Science Ground Segment can follow the user guide available on the EAS Wiki (internal access required). It explains the steps towards gaining user access to the Euclid DPS and provides an instructional guide as well as scripts for ingesting and/or retrieving data into/from the database. Additionally, the procedures for receiving user support are provided in the EAS Support Wiki (internal access required).

Science Archive System for published Science Ground Segment data

The Euclid Science Archive System (SAS) is a vital component of the Euclid Archive System, specifically designed to facilitate the publication of validated scientific results generated by the Euclid Science Ground Segment (SGS) to the Science Working Groups (SWGs) and the broader research community. Researchers can access Euclid’s scientific data with ease through interactive tools, interfaces, and tutorials provided by the SAS.

For a comprehensive list of data products released and planned for release by the Science Ground Segment, refer to the Data Product Def i nitions Document. Please note that this document is updated periodically. For further details on data access and how to provide feedback, members can consult the SGS User Guide: Accessing and Providing Feedback on SGS Euclid Data Products (internal access required) available in the Redmine. This wiki contains information on the types of Euclid data product instances, their accessibility, and permissible use, while offering clear instructions on how to effectively provide feedback.

For assistance with querying and retrieving specific datasets for analysis and research purposes in the SAS platform, users can refer to the Science Archive User Manual. Members can contact the Euclid Helpdesk at https://support.cosmos.esa.int/euclid for help with reporting problems or questions regarding the functionality of the Euclid archive.

External and Publically-Accessible Resources

There are also various other types of online platforms which members can use to explore additional resources related to Euclid.

Other pages and portals

Below are the other types of pages and portals, you may find useful:

Euclid Consortium Website: Public-facing information about the Euclid Consortium is available here on the Euclid Consortium website. Please note that internal information previously available on this website is now accessible through the ECL Wiki (internal access required).

CosmoHub: While not an official Euclid Consortium portal, CosmoHub hosts several cosmological simulations designed specifically for Euclid, including most releases from Euclid Flagship mock galaxy catalogues. These simulations are invaluable for testing and validating scientific models related to the Euclid mission. Moreover, the platform has features designed to enhance productivity and efficiency with super-fast queries, online plotting previews and easy data downloads.

Euclid NASA Science Center (ENSCI): Established by the National Aeronautics and Science Administration (NASA) to support US-based investigations using Euclid data. Visit ENSCI’s website and its help page for additional resources and support.

ELSA Euclid site: Public-facing information about the Horizon-funded ELSA project for creating value-added spectroscopic data products for Euclid: https://elsa-euclid.github.io/

ELSA Euclid GitHub site: public software repository for the Horizon-funded ELSA project: https://github.com/elsa-euclid

Social media

If you’re interested in staying updated on Euclid’s activities through social media, there are several options available.

Twitter: For regular tweets about Euclid’s activities, follow accounts such as
@EC_Euclid
@Euclid_FR
@EuclidItalia
@Euclid_UK
@Euclid_NISP
@ESA_Euclid
@EuclidMission
@elsa_euclid

Bluesky: Microblogging site, alternative to Twitter
@elsa-euclid

Instagram: For posts, reels, and short videos, you can follow
@euclidconsortium
@franceforeuclid
@Euclid_italia

YouTube: Explore video content on these Euclid-affiliated YouTube channels
EC_Euclid
Euclid-France
EuclidItalia

Mastodon: Join the conversation on Mastodon
@EC_Euclid@astrodon.social
@elsa_euclid@astrodon.social

Facebook: Connect with the Euclid community on Facebook through
@EuclidConsortium
@missioneuclidfrance
@EuclidItalia

LinkedIn: Follow the Euclid Consortium on LinkedIn
https://www.linkedin.com/company/euclid-consortium/
https://www.linkedin.com/company/elsa-euclid/

In addition, searching online about Euclid may reveal more general pages with new information and science highlights. If you come across any pages not listed here or believe the Guide may need an update, please submit a Redmine issue (use Tracker: Suggestion) to the ECICOM or reach out to us on Slack.

Help

If you encounter any issues, assistance is readily available. Try these options:

Self-Help Resources

Check the EC Portals FAQs (internal access required) for common issues and solutions on technical problems.

Utilise the channel search function on Slack to find posts on related issues, as they may contain helpful solutions shared by other members.

If you find a post where the problem hasn’t been solved, you can engage in the thread by asking for updates or indicate that you are experiencing the same issue. This can help draw attention to unresolved problems and prompt further discussion or assistance from the community.

Group-specific Help Desks and Support Pages

Some groups (e.g. EAS Support) within the Euclid Consortium provide specialised help desks and support pages to assist with specific issues or inquiries. Please refer to these dedicated resources provided by the group for tailored assistance.

Ask Your Colleagues

Reach out to your colleagues. They may have encountered similar issues and can offer helpful advice.

Portals Help Channel on Slack

Join the #help-portals channel on EC Slack and tag the appropriate support team by typing @support and making an appropriate selection of the support group from the drop-down menu. Our dedicated support teams are available to provide assistance and guidance.

Submit a Redmine Issue

If you’re unable to resolve the issue through Slack, submit a Redmine issue (internal access required) in the relevant sub-project. Provide detailed information about the problem to ensure a prompt response from our support team.

Email Portal Support

For general inquiries or issues not suitable for Slack or Redmine, you can email our portal support team at help@euclid-ec.org. Be sure to mention the specific portal and issue in your email for efficient assistance.

Our goal is to provide timely support and ensure your experience with Euclid’s resources is seamless. Don’t hesitate to reach out whenever you need help.

Portal Authentication System Overview

To fully engage with the Euclid Consortium, it is crucial to understand how to access its various portals introduced in the Getting Started Guide. Below is a summary of the authentication systems used for each portal:

Portal Name	Authentication System
EC Website	Public access, no login required (go to portal)
Tracking Portal	Login with registered email and password (go to portal)
Slack	Login with registered email and password (go to portal)
Redmine	Login with ESA Cosmos username and password (go to portal)
Publication Portal	Login with ESA Cosmos username and password (go to portal)
Projects Portal	Login with ESA Cosmos username and password (go to portal)
Speaker’s Bureau Portal	Login with ESA Cosmos username and password (go to portal)
GitLab	Login with ESA Cosmos username and password (go to portal)
ESA Cosmos Portal	Login with ESA Cosmos username and password (go to portal)
Euclid Archive System	Login with ESA Cosmos username and password (go to portal)
Euclid Mission Database	Login with ESA Cosmos username and password (go to portal)

For a more detailed summary of each portal, visit the EC Portals Redmine (internal access required).

In this Guide:

Membership Management
Project Management
Ongoing Activities and How to Join Them
Code Development for the EC
Data Access and Storage Facilities
External and Publically-Accessible Resources
Help
Portal Authentication System Overview