====== ColdFront user guide ====== [[https://coldfront.csc.uni-frankfurt.de|ColdFront]] is where you get access to the CSC's FUCHS cluster: PIs create a project, request compute time for it and add their group's members. ===== I want to use FUCHS in an existing project ===== - [[#logging_in|Log in]] once, so your account exists. - Tell your PI your ColdFront username; they [[#adding_members|add you]]. ===== I want to run my own project (professors) ===== - [[#logging_in|Log in]] - [[#requesting_pi_status|Request PI status]] - [[#creating_a_project|Create a project]] - [[#requesting_an_allocation|Request compute time on FUCHS]] - [[#adding_members|Add members]] ===== Help ===== Questions or problems: . Using FUCHS itself: see [[public:usage:fuchs|Using FUCHS]]. ===== Logging in ===== ColdFront has no registration of its own. You log in with the account of your home institution (for members of Goethe University: your HRZ account) via **RegApp**, the CSC's federated login service. Institutions in the eduGAIN federation can be used; so far, login has been tested with Goethe University. Your ColdFront account is created automatically the first time you log in. ==== Step by step ==== - Open [[https://coldfront.csc.uni-frankfurt.de|coldfront.csc.uni-frankfurt.de]] and click **Log in via your institution**.\\ {{:public:access:login-01-page.png?nolink&600|Login page}}\\ The username/password form above the button is only for CSC administrators. - RegApp's login page (//FAUST//) asks for your home organisation. Select it (e.g. "Universität Frankfurt") and click **Proceed**. Tick **Remember Home organisation** to skip this step next time.\\ {{:public:access:login-02-regapp-idp.png?nolink&600|Choosing the home institution in RegApp}} - Log in at your institution's login page with your usual credentials. - **First login only:** RegApp asks you to register for the service **Coldfront Cluster Access**. Click **Register**; RegApp then forwards you to ColdFront.\\ {{:public:access:login-03-regapp-register.png?nolink&600|Registering for the service in RegApp}} - Back in ColdFront, on your **first** login and whenever a document has changed, you are asked to review the terms of use (//Nutzungsbedingungen//) and the export-control self-declaration (//Exportkontrolle: Selbsterklärung//). Read them, tick every box and click **Continue**. **Decline and log out** logs you out again; you cannot use ColdFront without accepting.\\ {{:public:access:login-04-terms-dialog.png?nolink&600|Terms dialog}} - You land on your **dashboard**: your projects and allocations, and anything that needs your attention.\\ {{:public:access:login-05-dashboard.png?nolink&600|Dashboard of a new user}} ==== Your username ==== ColdFront creates a username for you from your name: the first letter of your given name, the first five letters of your family name, and a short suffix, e.g. ''mmuste_k3''. You need it when a PI wants to add you to a project. You find it under **User Profile** (top right menu). {{:public:access:login-06-profile.png?nolink&600|User profile with username}} Name and e-mail address come from your home institution and are updated on every login; change them there, not in ColdFront. ==== Problems ==== * Login fails, or RegApp shows an error page: write to . If your institution is not Goethe University, please mention which one. * You accepted the terms but are asked again: a new version was published; only the changed document is shown. ===== Requesting PI status ===== Only **PIs** (principal investigators) can create projects. A PI is responsible for their projects: they request resources, decide who becomes a member and confirm the export-control declaration for each member. Everyone else works in projects as a member, which needs no PI status — ask your PI to add you (see [[#adding_members|Adding members]]). Every professor at Goethe University can request PI status. It is granted by the CSC administrators. ==== Step by step ==== - Log in (see [[#logging_in|Logging in]]). On your dashboard, click the item about requesting PI status. Alternatively: **User Profile** → **Upgrade Account**.\\ {{:public:access:pi-01-dashboard-item.png?nolink&600|Dashboard item}} - Enter your position and institute and what you need PI status for, then click **Send request**.\\ {{:public:access:pi-02-form.png?nolink&600|PI request form}} - Your request is now pending. You see it on your dashboard and on the request page, where you can also **Withdraw request**. You can only have one open request at a time.\\ {{:public:access:pi-03-pending.png?nolink&600|Pending request}} - A decision usually takes no more than a week. Check your dashboard or the request page: once decided, the decision and the administrator's note are listed under **Earlier requests**. - Once approved, **Add a project** appears on your dashboard and in the project list. Continue with [[#creating_a_project|Creating a project]].\\ {{:public:access:pi-04-approved.png?nolink&600|Dashboard after approval}} Questions: . ===== Creating a project ===== A project groups the people working together and the resources they use (compute time on the FUCHS cluster). You need PI status (see [[#requesting_pi_status|Requesting PI status]]); you are automatically the project's PI. A new project can be used straight away (its status shows **New**): you can add members and managers immediately. Resources, however, have to be requested separately and are only available once the CSC administrators have approved them (see [[#requesting_an_allocation|Requesting an allocation]]). ==== Step by step ==== - Click **Add a project** (dashboard or **Project → Projects**).\\ {{:public:access:project-01-add-button.png?nolink&600|Add a project}} - Fill in the form; the fields are explained in the table below.\\ {{:public:access:project-02-form-top.png?nolink&600|Project form, upper part}}\\ {{:public:access:project-03-dfg-subject.png?nolink&600|Choosing the DFG subject}}\\ {{:public:access:project-04-form-bottom.png?nolink&600|Project form, lower part}} - Click **Save**. The project page opens.\\ {{:public:access:project-05-detail.png?nolink&600|New project page}} ^ Field ^ What to enter ^ | **Title** | A short, descriptive project title. | | **Project short ID** | A short, descriptive name that is unique across all projects: up to 16 lowercase letters and digits, starting with a letter (no hyphens or underscores). It names the project's group, Slurm account and directories on the cluster. **It cannot be changed later.** | | **Description** | What the project is about. The field starts with a placeholder text; replace it. | | **Subject area (DFG)** | The DFG subject area (Fachgebiet) of the project. Choose this first. | | **Subject (DFG)** | The subject (Fach) within that area; the list shows only the chosen area's subjects, grouped by review board (Fachkollegium). Uses the DFG classification 2024–2028. | | **Kostenstelle** | The cost center the project is billed to. | | **Export-control confirmation** | Tick to confirm the export-control declaration for yourself as PI of this project. | ==== Next steps ==== * [[#requesting_an_allocation|Request compute time on FUCHS]]. * [[#adding_members|Add members]]. Title, description and DFG subject can be changed later via **Update Project Information** on the project page; the short ID cannot. ===== Requesting an allocation ===== An **allocation** gives a project access to a resource. Currently one resource can be requested, once per project: ^ Resource ^ What you get ^ Requested amount ^ | **FUCHS** (cluster) | A Slurm account and project directories on the FUCHS HPC cluster. | Core-hours per year (minimum 100,000; smaller requests are refused) | The PI and the project's managers can request allocations. ==== Step by step ==== - On the project page, click **Request Resource Allocation**.\\ {{:public:access:alloc-01-button.png?nolink&600|Request Resource Allocation}} - Choose **FUCHS** as **Resource**, enter a **Justification** and the requested **Core-hours per year**. If the project already has members, tick those who should get access right away; you can add more later.\\ {{:public:access:alloc-02-form.png?nolink&600|Allocation request for FUCHS}} - Click **Submit**. The allocation appears on the project page with status **New** and is reviewed by the CSC administrators.\\ {{:public:access:alloc-03-pending.png?nolink&600|Pending allocation}}\\ Your dashboard also lists it as waiting for the administrators.\\ {{:public:access:alloc-03-dashboard.png?nolink&600|Dashboard with the pending allocation}} - Once approved, the status changes to **Active** and the accounts, groups and directories on FUCHS are set up automatically. Check the status on the project page or your dashboard.\\ {{:public:access:alloc-04-active.png?nolink&600|Active allocation}} ==== Duration, renewal and changes ==== Allocations run for one year; your dashboard warns you 30 days before an allocation expires. There is no process in ColdFront yet for renewing an allocation or changing the requested amount — please write to . ==== Getting started on FUCHS ==== * [[public:access|Access to the CSC systems]] * [[public:usage:fuchs|Using FUCHS]] ===== Adding members ===== PIs and project managers can add people to a project and give them access to its allocations. ==== Before you start ==== * **The person must have logged in to ColdFront once** and accepted the current terms of use (see [[#logging_in|Logging in]]). Only then do they exist in ColdFront and can be found. * Ask them for their **ColdFront username** (shown under **User Profile**). Searching by name or e-mail also works. ==== Roles ==== ^ Role ^ Can ^ | **User** | Use the allocations they were added to. | | **Manager** | Additionally add members and request allocations. Cannot confirm export-control declarations (only the PI can). | ==== Step by step ==== - On the project page, click **Add Users**.\\ {{:public:access:members-01-add-users-button.png?nolink&600|Add Users}} - Enter one or more usernames (separated by spaces or new lines) and choose **Exact Username Only**, or enter part of a name or e-mail address and choose **All Fields**. Click **Search**.\\ {{:public:access:members-02-search.png?nolink&600|User search}} - In the results: * tick the people to add, * choose their **Role**, * tick **Export control** to confirm the export-control declaration for each new member (PI only), * tick the allocations they should get access to (**Available Allocations**, above the user list). - Click **Add Selected Users to Project**.\\ {{:public:access:members-03-results.png?nolink&600|Search results}} - The new members appear in the project's member list and, once active, get access to the selected allocations automatically.\\ {{:public:access:members-05-member-list.png?nolink&600|Member list}} ==== Removing members ==== Removing members is not possible on the cluster side yet. To remove someone from a project, please write to instead of using **Remove Users**.