HPCE/gitea-pages
0
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Activity

merge and move support pages

Browse Source 
this are now under the /support path, meaning that this is unified for
all clusters.
This commit is contained in:
viessm_h
2026-01-07 17:15:56 +01:00
parent 860bc998ec
commit 8acef7694c
17 changed files with 254 additions and 236 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/gmerlin6/hardware-and-software-description.md
View File

@@ -112,13 +112,13 @@ The below table summarizes the hardware setup for the Merlin6 GPU computing node
### Login Nodes
The login nodes are part of the **[Merlin6](../merlin6/index.md)** HPC cluster,
The login nodes are part of the **[Merlin6](../merlin6/introduction.md)** HPC cluster,
and are used to compile and to submit jobs to the different ***Merlin Slurm clusters*** (`merlin5`,`merlin6`,`gmerlin6`,etc.).
Please refer to the **[Merlin6 Hardware Documentation](../merlin6/hardware-and-software-description.md)** for further information.
### Storage
The storage is part of the **[Merlin6](../merlin6/index.md)** HPC cluster,
The storage is part of the **[Merlin6](../merlin6/introduction.md)** HPC cluster,
and is mounted in all the ***Slurm clusters*** (`merlin5`,`merlin6`,`gmerlin6`,etc.).
Please refer to the **[Merlin6 Hardware Documentation](../merlin6/hardware-and-software-description.md)** for further information.
@@ -134,7 +134,7 @@ ibstat | grep Rate
## Software
In the Merlin6 GPU computing nodes, we try to keep software stack coherency with the main cluster [Merlin6](../merlin6/index.md).
In the Merlin6 GPU computing nodes, we try to keep software stack coherency with the main cluster [Merlin6](../merlin6/introduction.md).
Due to this, the Merlin6 GPU nodes run:

6
docs/merlin5/cluster-introduction.md
View File

@@ -6,7 +6,7 @@
mission-critical applications which was built in 2016-2017. It was an
extension of the Merlin4 cluster and built from existing hardware due
to a lack of central investment on Local HPC Resources. **Merlin5** was
then replaced by the **[Merlin6](../merlin6/index.md)** cluster in 2019,
then replaced by the **[Merlin6](../merlin6/introduction.md)** cluster in 2019,
with an important central investment of ~1,5M CHF. **Merlin5** was mostly
based on CPU resources, but also contained a small amount of GPU-based
resources which were mostly used by the BIO experiments.
@@ -15,8 +15,8 @@ resources which were mostly used by the BIO experiments.
called **`merlin5`**. In that way, the old CPU computing nodes are still available as extra computation resources,
and as an extension of the official production **`merlin6`** [Slurm](https://slurm.schedmd.com/overview.html) cluster.
The old Merlin5 _**login nodes**_, _**GPU nodes**_ and _**storage**_ were fully migrated to the **[Merlin6](../merlin6/index.md)**
cluster, which becomes the **main Local HPC Cluster**. Hence, **[Merlin6](../merlin6/index.md)**
The old Merlin5 _**login nodes**_, _**GPU nodes**_ and _**storage**_ were fully migrated to the **[Merlin6](../merlin6/introduction.md)**
cluster, which becomes the **main Local HPC Cluster**. Hence, **[Merlin6](../merlin6/introduction.md)**
contains the storage which is mounted on the different Merlin HPC [Slurm](https://slurm.schedmd.com/overview.html) Clusters (`merlin5`, `merlin6`, `gmerlin6`).
### Submitting jobs to 'merlin5'

6
docs/merlin5/hardware-and-software-description.md
View File

@@ -63,13 +63,13 @@ The below table summarizes the hardware setup for the Merlin5 computing nodes:
### Login Nodes
The login nodes are part of the **[Merlin6](../merlin6/index.md)** HPC cluster,
The login nodes are part of the **[Merlin6](../merlin6/introduction.md)** HPC cluster,
and are used to compile and to submit jobs to the different ***Merlin Slurm clusters*** (`merlin5`,`merlin6`,`gmerlin6`,etc.).
Please refer to the **[Merlin6 Hardware Documentation](../merlin6/hardware-and-software-description.md)** for further information.
### Storage
The storage is part of the **[Merlin6](../merlin6/index.md)** HPC cluster,
The storage is part of the **[Merlin6](../merlin6/introduction.md)** HPC cluster,
and is mounted in all the ***Slurm clusters*** (`merlin5`,`merlin6`,`gmerlin6`,etc.).
Please refer to the **[Merlin6 Hardware Documentation](../merlin6/hardware-and-software-description.md)** for further information.
@@ -81,7 +81,7 @@ However, this is an old version of Infiniband which requires older drivers and s
## Software
In Merlin5, we try to keep software stack coherency with the main cluster [Merlin6](../merlin6/index.md).
In Merlin5, we try to keep software stack coherency with the main cluster [Merlin6](../merlin6/introduction.md).
Due to this, Merlin5 runs:

41
docs/merlin6/99-support/contact.md
View File

@@ -1,41 +0,0 @@
# Contact
## Support
Basic contact information can be also found when logging into the Merlin Login Nodes through the *Message of the Day*.
Support can be asked through:
* [PSI Service Now](https://psi.service-now.com/psisp)
* E-Mail: <merlin-admins@lists.psi.ch>
### PSI Service Now
**[PSI Service Now](https://psi.service-now.com/psisp)**: is the official tool for opening incident requests.
* PSI HelpDesk will redirect the incident to the corresponding department, or
* you can always assign it directly by checking the box `I know which service is affected` and providing the service name `Local HPC Resources (e.g. Merlin) [CF]` (just type in `Local` and you should get the valid completions).
### Contact Merlin6 Administrators
**E-Mail <merlin-admins@lists.psi.ch>**
* This is the official way to contact Merlin6 Administrators for discussions which do not fit well into the incident category.
Do not hesitate to contact us for such cases.
---
## Get updated through the Merlin User list!
Is strongly recommended that users subscribe to the Merlin Users mailing list: **<merlin-users@lists.psi.ch>**
This mailing list is the official channel used by Merlin6 administrators to inform users about downtimes,
interventions or problems. Users can be subscribed in two ways:
* *(Preferred way)* Self-registration through **[Sympa](https://psilists.ethz.ch/sympa/info/merlin-users)**
* If you need to subscribe many people (e.g. your whole group) by sending a request to the admin list **<merlin-admins@lists.psi.ch>**
and providing a list of email addresses.
---
## The Merlin Cluster Team
The PSI Merlin clusters are managed by the **[High Performance Computing and Emerging technologies Group](https://www.psi.ch/de/lsm/hpce-group)**, which
is part of the [Science IT Infrastructure, and Services department (AWI)](https://www.psi.ch/en/awi) in PSI's [Center for Scientific Computing, Theory and Data (SCD)](https://www.psi.ch/en/csd).

42
docs/merlin6/99-support/faq.md
View File

@@ -1,42 +0,0 @@
# FAQ
## How do I register for Merlin?
See [Requesting Merlin Access](../quick-start-guide/requesting-accounts.md).
## How do I get information about downtimes and updates?
See [Get updated through the Merlin User list!](contact.md#get-updated-through-the-merlin-user-list)
## How can I request access to a Merlin project directory?
Merlin projects are placed in the `/data/project` directory. Access to each project is controlled by Unix group membership.
If you require access to an existing project, please request group membership as described in [Requesting Unix Group Membership](../quick-start-guide/requesting-projects.md#requesting-unix-group-membership).
Your project leader or project colleagues will know what Unix group you should belong to. Otherwise, you can check what Unix group is allowed to access that project directory (simply run `ls -ltrhd` for the project directory).
## Can I install software myself?
Most software can be installed in user directories without any special permissions. We recommend using `/data/user/$USER/bin` for software since home directories are fairly small. For software that will be used by multiple groups/users you can also [request the admins](contact.md) install it as a [module](../how-to-use-merlin/using-modules.md).
How to install depends a bit on the software itself. There are three common installation procedures:
1. *binary distributions*. These are easy; just put them in a directory (eg `/data/user/$USER/bin`) and add that to your PATH.
2. *source compilation* using make/cmake/autoconfig/etc. Usually the compilation scripts accept a `--prefix=/data/user/$USER` directory for where to install it. Then they place files under `<prefix>/bin`, `<prefix>/lib`, etc. The exact syntax should be documented in the installation instructions.
3. *conda environment*. This is now becoming standard for python-based software, including lots of the AI tools. First follow the [initial setup instructions](../software-support/python.md#anaconda) to configure conda to use /data/user instead of your home directory. Then you can create environments like:
```bash
module load anaconda/2019.07
# if they provide environment.yml
conda env create -f environment.yml
# or to create manually
conda create --name myenv python==3.9 ...
conda activate myenv
```
## Something doesn't work
Check the list of [known problems](known-problems.md) to see if a solution is known.
If not, please [contact the admins](contact.md).

40
docs/merlin6/99-support/troubleshooting.md
View File

@@ -1,40 +0,0 @@
# Troubleshooting
For troubleshooting, please contact us through the official channels. See [Contact](contact.md)
for more information.
## Known Problems
Before contacting us for support, please check the **[Merlin6 Support: Known Problems](known-problems.md)** page to see if there is an existing
workaround for your specific problem.
## Troubleshooting Slurm Jobs
If you want to report a problem or request for help when running jobs, please **always provide**
the following information:
1. Provide your batch script or, alternatively, the path to your batch script.
2. Add **always** the following commands to your batch script
```bash
echo "User information:"; who am i
echo "Running hostname:"; hostname
echo "Current location:"; pwd
echo "User environment:"; env
echo "List of PModules:"; module list
```
3. Whenever possible, provide the Slurm JobID.
Providing this information is **extremely important** in order to ease debugging, otherwise
only with the description of the issue or just the error message is completely insufficient
in most cases.
## Troubleshooting SSH
Use the ssh command with the "-vvv" option and copy and paste (no screenshots please)
the output to your request in Service-Now. Example
```bash
ssh -Y -vvv $username@merlin-l-01.psi.ch
```

67
docs/merlin6/how-to-use-merlin/transfer-data.md
View File

@@ -6,14 +6,14 @@ Most methods allow data to be either transmitted or received, so it may make sen
initiate the transfer from either merlin or the other system, depending on the network
visibility.
- Merlin login nodes are visible from the PSI network, so direct data transfer
* Merlin login nodes are visible from the PSI network, so direct data transfer
(rsync/WinSCP) is generally preferable. This can be initiated from either endpoint.
- Merlin login nodes can access the internet using a limited set of protocols
- SSH-based protocols using port 22 (rsync-over-ssh, sftp, WinSCP, etc)
- HTTP-based protocols using ports 80 or 445 (https, WebDav, etc)
- Protocols using other ports require admin configuration and may only work with
* Merlin login nodes can access the internet using a limited set of protocols:
* SSH-based protocols using port 22 (rsync-over-ssh, sftp, WinSCP, etc)
* HTTP-based protocols using ports 80 or 445 (https, WebDav, etc)
* Protocols using other ports require admin configuration and may only work with
specific hosts (ftp, rsync daemons, etc)
- Systems on the internet can access the [PSI Data Transfer](https://www.psi.ch/en/photon-science-data-services/data-transfer) service
* Systems on the internet can access the [PSI Data Transfer](https://www.psi.ch/en/photon-science-data-services/data-transfer) service
`datatransfer.psi.ch`, using ssh-based protocols and [Globus](https://www.globus.org/)
## Direct transfer via Merlin6 login nodes
@@ -27,14 +27,14 @@ for use from within the PSI network.
Rsync is the preferred method to transfer data from Linux/MacOS. It allows
transfers to be easily resumed if they get interrupted. The general syntax is:
```
```bash
rsync -avAHXS <src> <dst>
```
For example, to transfer files from your local computer to a merlin project
directory:
```
```bash
rsync -avAHXS ~/localdata user@merlin-l-01.psi.ch:/data/project/general/myproject/
```
@@ -60,25 +60,28 @@ The purpose of the software is to send a large file to someone, have that file a
## PSI Data Transfer
From August 2024, Merlin is connected to the **[PSI Data Transfer](https://www.psi.ch/en/photon-science-data-services/data-transfer)** service,
`datatransfer.psi.ch`. This is a central service managed by the **[Linux team](https://linux.psi.ch/index.html)**. However, any problems or questions related to it can be directly
[reported](../99-support/contact.md) to the Merlin administrators, which will forward the request if necessary.
From August 2024, Merlin is connected to the **[PSI Data
Transfer](https://www.psi.ch/en/photon-science-data-services/data-transfer)**
service, `datatransfer.psi.ch`. This is a central service managed by the
**[Linux team](https://linux.psi.ch/index.html)**. However, any problems or
questions related to it can be directly [reported](../../support/index.md) to the
Merlin administrators, which will forward the request if necessary.
The PSI Data Transfer servers supports the following protocols:
* Data Transfer - SSH (scp / rsync)
* Data Transfer - Globus
Notice that `datatransfer.psi.ch` does not allow SSH login, only `rsync`, `scp` and [Globus](https://www.globus.org/) access is allowed.
The following filesystems are mounted:
* `/merlin/export` which points to the `/export` directory in Merlin.
* `/merlin/data/experiment/mu3e` which points to the `/data/experiment/mu3e` directories in Merlin.
* Mu3e sub-directories are mounted in RW (read-write), except for `data` (read-only mounted)
* `/merlin/data/project/general` which points to the `/data/project/general` directories in Merlin.
* Owners of Merlin projects should request explicit access to it.
* Currently, only `CSCS` is available for transferring files between PizDaint/Alps and Merlin
* `/merlin/data/project/bio` which points to the `/data/project/bio` directories in Merlin.
* `/merlin/data/user` which points to the `/data/user` directories in Merlin.
@@ -95,34 +98,42 @@ Therefore, having the Microsoft Authenticator App is required as explained [here
User data directories are mounted in RW.
!!! warning "Secure Permissions"
Please, **ensure proper secured permissions** in your `/data/user` directory. By default, when directory is created, the system applies the most restrictive permissions. However, this does not prevent users for changing permissions if they wish. At this point, users become responsible of those changes.
Please, **ensure proper secured permissions** in your `/data/user`
directory. By default, when directory is created, the system applies the
most restrictive permissions. However, this does not prevent users for
changing permissions if they wish. At this point, users become responsible
of those changes.
#### /merlin/export
Transferring big amounts of data from outside PSI to Merlin is always possible through `/export`.
!!! tip "Export Directory Access"
The `/export` directory can be used by any Merlin user. This is configured in Read/Write mode. If you need access, please, contact the Merlin administrators.
The `/export` directory can be used by any Merlin user. This is configured
in Read/Write mode. If you need access, please, contact the Merlin
administrators.
!!! warning "Export Usage Policy"
The use **export** as an extension of the quota *is forbidden*.
Auto cleanup policies in the **export** area apply for files older than 28 days.
The use **export** as an extension of the quota *is forbidden*. Auto
cleanup policies in the **export** area apply for files older than 28 days.
##### Exporting data from Merlin
For exporting data from Merlin to outside PSI by using `/export`, one has to:
* From a Merlin login node, copy your data from any directory (i.e. `/data/project`, `/data/user`, `/scratch`) to
`/export`. Ensure to properly secure your directories and files with proper permissions.
* Once data is copied, from **`datatransfer.psi.ch`**, copy the data from `/merlin/export` to outside PSI
* From a Merlin login node, copy your data from any directory (i.e. `/data/project`, `/data/user`, `/scratch`) to
`/export`. Ensure to properly secure your directories and files with proper permissions.
* Once data is copied, from **`datatransfer.psi.ch`**, copy the data from `/merlin/export` to outside PSI
##### Importing data to Merlin
For importing data from outside PSI to Merlin by using `/export`, one has to:
* From **`datatransfer.psi.ch`**, copy the data from outside PSI to `/merlin/export`.
* From **`datatransfer.psi.ch`**, copy the data from outside PSI to `/merlin/export`.
Ensure to properly secure your directories and files with proper permissions.
* Once data is copied, from a Merlin login node, copy your data from `/export` to any directory (i.e. `/data/project`, `/data/user`, `/scratch`).
* Once data is copied, from a Merlin login node, copy your data from `/export` to any directory (i.e. `/data/project`, `/data/user`, `/scratch`).
#### Request access to your project directory
@@ -148,10 +159,10 @@ Merlin6 is fully accessible from within the PSI network. To connect from outside
Merlin provides a command for mounting remote file systems, called `merlin_rmount`. This
provides a helpful wrapper over the Gnome storage utilities, and provides support for a wide range of remote file formats, including
- SMB/CIFS (Windows shared folders)
- WebDav
- AFP
- FTP, SFTP
- [others](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/using_the_desktop_environment_in_rhel_8/managing-storage-volumes-in-gnome_using-the-desktop-environment-in-rhel-8#gvfs-back-ends_managing-storage-volumes-in-gnome)
* SMB/CIFS (Windows shared folders)
* WebDav
* AFP
* FTP, SFTP
* [others](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/using_the_desktop_environment_in_rhel_8/managing-storage-volumes-in-gnome_using-the-desktop-environment-in-rhel-8#gvfs-back-ends_managing-storage-volumes-in-gnome)
[More instruction on using `merlin_rmount`](../software-support/merlin-rmount.md)

2
docs/merlin6/introduction.md
View File

@@ -1,7 +1,7 @@
# Introduction
!!! note
Merlin6 is no longer accessible for new users! Please have a look at [Merlin 7](../../merlin7/01-Quick-Start-Guide/introduction.md) instead.
Merlin6 is no longer accessible for new users! Please have a look at [Merlin 7](../merlin7/01-Quick-Start-Guide/introduction.md) instead.
## Slurm clusters

2
docs/merlin7/02-How-To-Use-Merlin/transfer-data.md
View File

@@ -134,7 +134,7 @@ The service is designed to **send large files for temporary availability**, not
From August 2024, Merlin is connected to the **[PSI Data Transfer](https://www.psi.ch/en/photon-science-data-services/data-transfer)** service,
`datatransfer.psi.ch`. This is a central service managed by the **[Linux team](https://linux.psi.ch/index.html)**. However, any problems or questions related to it can be directly
[reported](../99-support/contact.md) to the Merlin administrators, which will forward the request if necessary.
[reported](../../support/index.md) to the Merlin administrators, which will forward the request if necessary.
The PSI Data Transfer servers supports the following protocols:

21
docs/merlin7/05-Software-Support/pmodules.md
View File

@@ -11,27 +11,30 @@ If you miss any package/versions or a software with a specific missing feature,
### Module Release Stages
To ensure proper software lifecycle management, PModules uses three release stages: unstable, stable, and deprecated.
To ensure proper software lifecycle management, PModules uses three release stages: unstable, stable, and deprecated.
1. **Unstable Release Stage:**
1. **Unstable Release Stage:**
* Contains experimental or under-development software versions.
* Not visible to users by default. Use explicitly:
```bash
module use unstable
```
* Software is promoted to **stable** after validation.
2. **Stable Release Stage:**
2. **Stable Release Stage:**
* Default stage, containing fully tested and supported software versions.
* Recommended for all production workloads.
3. **Deprecated Release Stage:**
3. **Deprecated Release Stage:**
* Contains software versions that are outdated or discontinued.
* These versions are hidden by default but can be explicitly accessed:
```bash
module use deprecated
```
* Deprecated software can still be loaded directly without additional configuration to ensure user transparency.
## PModules commands
@@ -113,7 +116,7 @@ module load gcc/14.2.0
module load openmpi/5.0.5
```
#### module purge
### module purge
This command is an alternative to `module unload`, which can be used to unload **all** loaded module files.
@@ -128,18 +131,22 @@ The PModules system is designed to accommodate the diverse software needs of Mer
### Requesting Missing Software
If a specific software package is not available in PModules and there is interest from multiple users:
* **[Contact Support](../99-support/contact.md):** Let us know about the software, and we will assess its feasibility for deployment.
* **[Contact Support](../../support/index.md):** Let us know about the software, and we will assess its feasibility for deployment.
* **Deployment Timeline:** Adding new software to PModules typically takes a few days, depending on complexity and compatibility.
* **User Involvement:** If you are interested in maintaining the software package, please inform us. Collaborative maintenance helps
ensure timely updates and support.
ensure timely updates and support.
### Requesting a Missing Version
If the currently available versions of a package do not meet your requirements:
* **New Versions:** Requests for newer versions are generally supported, especially if there is interest from multiple users.
* **Intermediate Versions:** Installation of intermediate versions (e.g., versions between the current stable and deprecated versions)
can be considered if there is a strong justification, such as specific features or compatibility requirements.
### General Notes
* New packages or versions are prioritized based on their relevance and usage.
* For any request, providing detailed information about the required software or version (e.g., name, version, features) will help
expedite the process.

42
docs/merlin7/99-support/contact.md
View File

@@ -1,42 +0,0 @@
# Contact
## Support
Support can be asked through:
* [PSI Service Now](https://psi.service-now.com/psisp)
* E-Mail: <merlin-admins@lists.psi.ch>
Basic contact information is also displayed on every shell login to the system using the *Message of the Day* mechanism.
### PSI Service Now
**[PSI Service Now](https://psi.service-now.com/psisp)**: is the official tool for opening incident requests.
* PSI HelpDesk will redirect the incident to the corresponding department, or
* you can always assign it directly by checking the box `I know which service is affected` and providing the service name `Local HPC Resources (e.g. Merlin) [CF]` (just type in `Local` and you should get the valid completions).
### Contact Merlin Administrators
**E-Mail <merlin-admins@lists.psi.ch>**
* This is the official way to contact Merlin Administrators for discussions which do not fit well into the incident category.
Do not hesitate to contact us for such cases.
---
## Get updated through the Merlin User list!
Is strongly recommended that users subscribe to the Merlin Users mailing list: **<merlin-users@lists.psi.ch>**
This mailing list is the official channel used by Merlin administrators to inform users about downtimes,
interventions or problems. Users can be subscribed in two ways:
* *(Preferred way)* Self-registration through **[Sympa](https://psilists.ethz.ch/sympa/info/merlin-users)**
* If you need to subscribe many people (e.g. your whole group) by sending a request to the admin list **<merlin-admins@lists.psi.ch>**
and providing a list of email addresses.
---
## The Merlin Cluster Team
The PSI Merlin clusters are managed by the **[High Performance Computing and Emerging technologies Group](https://www.psi.ch/de/lsm/hpce-group)**, which
is part of the [Science IT Infrastructure, and Services department (AWI)](https://www.psi.ch/en/awi) in PSI's [Center for Scientific Computing, Theory and Data (SCD)](https://www.psi.ch/en/csd).

2
docs/news/posts/launching-merlin6-docs.md
View File

@@ -7,6 +7,6 @@ tags:
# Merlin 6 documentation available
Merlin 6 docs are now available at [Merlin6 docs](../../merlin6/index.md)!
Merlin 6 docs are now available at [Merlin6 docs](../../merlin6/introduction.md)!
More complete documentation will be coming shortly.

65
docs/support/faq.md Normal file
View File

@@ -0,0 +1,65 @@
---
title: "FAQ"
---
# Frequently Asked Questions
## How do I register for Merlin?
See [Requesting Merlin Access](../merlin7/01-Quick-Start-Guide/requesting-accounts.md).
## How do I get information about downtimes and updates?
See [Get updated through the Merlin User list!](index.md#merlin-user-mailing-list)
## How can I request access to a Merlin project directory?
Merlin projects are placed in the `/data/project` directory. Access to each
project is controlled by Unix group membership. If you require access to an
existing project, please request group membership as described in
[Requesting Unix Group Membership](../merlin7/01-Quick-Start-Guide/requesting-projects.md#requesting-unix-group-membership).
Your project leader or project colleagues will know what Unix group you should
belong to. Otherwise, you can check what Unix group is allowed to access that
project directory (simply run `ls -ltrhd` for the project directory).
## Can I install software myself?
Most software can be installed in user directories without any special
permissions. We recommend using `/data/user/$USER/bin` for software since home
directories are fairly small. For software that will be used by multiple
groups/users you can also [request the admins](index.md) install it as a
[module](../merlin7/05-Software-Support/pmodules.md).
How to install depends a bit on the software itself. There are three common
installation procedures:
* *binary distributions*. These are easy; just put them in a directory (eg
`/data/user/$USER/bin`) and add that to your PATH.
* *source compilation* using make/cmake/autoconfig/etc. Usually the
compilation scripts accept a `--prefix=/data/user/$USER` directory for where
to install it. Then they place files under `<prefix>/bin`, `<prefix>/lib`,
etc. The exact syntax should be documented in the installation instructions.
!!! note inline end
The following is based on `merlin6`, but should still be valid for `merlin7`.
* *conda environment*. This is now becoming standard for python-based
software, including lots of the AI tools. First follow the [initial setup
instructions](../merlin6/software-support/python.md#anaconda) to configure conda to
use /data/user instead of your home directory. Then you can create
environments like:
```bash
module load anaconda/2019.07
# if they provide environment.yml
conda env create -f environment.yml
# or to create manually
conda create --name myenv python==3.9 ...
conda activate myenv
```
## Something doesn't work
Check the list of [known problems](known-problems.md) to see if a solution is known.
If not, please [contact the admins](index.md).

56
docs/support/index.md Normal file
View File

@@ -0,0 +1,56 @@
# Getting Support
!!! tip
It is strongly recommended that users subscribe to the [user mailing
list](#merlin-user-mailing-list), that way you will receive the newest
announcements concerning the status of the clusters, information regarding
maintenance actions, and other tasks that might affect your work.
There are several channels you can use to get support:
* the **preferred** choice is to submit a ticket with [PSI Service Now](https://psi.service-now.com/psisp), alternatively
* you can also us our [user mailing list](#merlin-user-mailing-list), or lastly
* you can email the Admins directly <merlin-admins@lists.psi.ch>
!!! info
Basic contact information is also displayed on every shell login to the
system using the *Message of the Day* mechanism.
## PSI Service Now
[PSI Service Now](https://psi.service-now.com/psisp) is the official tool for
opening tickets and requests.
* PSI HelpDesk will redirect the incident to the corresponding department, or
* you can always assign it directly by checking the box `I know which service
is affected` and providing the service name `Local HPC Resources (e.g.
Merlin) [CF]` (just type in `Local` and you should get the valid
completions).
## Merlin User mailing list
This mailing list is the official channel used by Merlin administrators to inform users about downtimes,
interventions or problems. Users can be subscribed in two ways:
* *Preferred way*: Self-registration through [Sympa](https://psilists.ethz.ch/sympa/info/merlin-users)
* If you need to subscribe many people (e.g. your whole group) by sending a
request to the admin list <merlin-admins@lists.psi.ch>
and providing a list of email addresses.
## Email the Admins
This is the official way to contact Merlin Administrators for discussions which
do not fit well into the incident category. Do not hesitate to contact us for
such cases.
**E-Mail**: <merlin-admins@lists.psi.ch>
---
## Who are we?
The PSI Merlin clusters are managed by the **[High Performance Computing and
Emerging technologies Group](https://www.psi.ch/de/lsm/hpce-group)**, which is
part of the [Science IT Infrastructure, and Services department
(AWI)](https://www.psi.ch/en/awi) in PSI's [Center for Scientific Computing,
Theory and Data (SCD)](https://www.psi.ch/en/csd).

10
docs/merlin6/99-support/known-problems.md → docs/support/known-problems.md
View File

@@ -25,6 +25,7 @@ This means you will implicitly have to specify `-c\--cpus-per-task` also on your
Therefore, unless this is implicitly specified, `srun` will use only one Core per task (resulting in 2 CPUs per task when multithreading is enabled)
An example for setting up `srun` with `-c\--cpus-per-task`:
```bash
(base) ❄ [caubet_m@merlin-l-001:/data/user/caubet_m]# cat mysbatch_method1
#!/bin/bash
@@ -50,6 +51,7 @@ In this example, by setting -c/--cpus-per-task in srun
```
An example to accomplish the same thing with the `SRUN_CPUS_PER_TASK` environment variable:
```bash
(base) ❄ [caubet_m@merlin-l-001:/data/user/caubet_m]# cat mysbatch_method2
#!/bin/bash
@@ -90,10 +92,11 @@ getent passwd $USER | awk -F: '{print $NF}'
```
If SHELL does not correspond to the one you need to use, you should request a central change for it.
This is because Merlin accounts are central PSI accounts. Hence, **change must be requested via [PSI Service Now](contact.md#psi-service-now)**.
This is because Merlin accounts are central PSI accounts. Hence, **change must be requested** via [PSI Service Now](index.md#psi-service-now).
Alternatively, if you work on other PSI Linux systems but for Merlin you need a different SHELL type, a temporary change can be performed during login startup.
You can update one of the following files:
* `~/.login`
* `~/.profile`
* Any `rc` or `profile` file in your home directory (i.e. `.cshrc`, `.bashrc`, `.bash_profile`, etc.)
@@ -130,9 +133,9 @@ module load paraview
vglrun paraview
```
Officially, the supported method for running `vglrun` is by using the [NoMachine remote desktop](../how-to-use-merlin/nomachine.md).
Officially, the supported method for running `vglrun` is by using the [NoMachine remote desktop](../merlin7/02-How-To-Use-Merlin/nomachine.md).
Running `vglrun` it's also possible using SSH with X11 Forwarding. However, it's very slow and it's only recommended when running
in Slurm (from [NoMachine](../how-to-use-merlin/nomachine.md)). Please, avoid running `vglrun` over SSH from a desktop or laptop.
in Slurm (from [NoMachine](../merlin7/02-How-To-Use-Merlin/nomachine.md)). Please, avoid running `vglrun` over SSH from a desktop or laptop.
## Software
@@ -167,4 +170,3 @@ fi
```
It can also be fixed temporarily in an existing terminal by running `. /etc/bashrc` manually.

42
docs/support/troubleshooting.md Normal file
View File

@@ -0,0 +1,42 @@
# Troubleshooting
For troubleshooting, please contact us through the official channels. See
[here](index.md) for more information.
## Known Problems
Before contacting us for support, please check the [Known
Problems](known-problems.md) page to see if there is an existing workaround for
your specific problem.
## Troubleshooting Slurm Jobs
If you want to report a problem or request for help when running jobs, please
**always provide** the following information:
1. Provide your batch script or, alternatively, the path to your batch script.
2. Add **always** the following commands to your batch script
```bash
echo "User information:"; who am i
echo "Running hostname:"; hostname
echo "Current location:"; pwd
echo "User environment:"; env
echo "List of PModules:"; module list
```
3. Whenever possible, provide the Slurm JobID.
Providing this information is **extremely important** in order to ease
debugging, otherwise only with the description of the issue or just the error
message is completely insufficient in most cases.
## Troubleshooting SSH
Use the ssh command with the "-vvv" option and copy and paste the text
(**please don't send us screenshots**) the output to your request in
Service-Now. Example:
```bash
ssh -Y -vvv $username@<hostname>
```

10
mkdocs.yml
View File

@@ -122,7 +122,6 @@ nav:
- merlin7/05-Software-Support/cray-module.env.md
- Support:
- merlin7/99-support/migration-from-merlin6.md
- merlin7/99-support/contact.md
- Merlin 6:
- merlin6/introduction.md
- merlin6/hardware-and-software-description.md
@@ -183,11 +182,7 @@ nav:
- merlin6/98-announcements/downtimes.md
- merlin6/98-announcements/past-downtimes.md
- Support:
- merlin6/99-support/contact.md
- merlin6/99-support/faq.md
- merlin6/99-support/known-problems.md
- merlin6/99-support/migration-from-merlin5.md
- merlin6/99-support/troubleshooting.md
- MeG:
- meg/index.md
- meg/contact.md
@@ -195,3 +190,8 @@ nav:
- PSI@CSCS:
- cscs-userlab/index.md
- cscs-userlab/transfer-data.md
- Support:
- support/index.md
- support/faq.md
- support/known-problems.md
- support/troubleshooting.md