first stab at mkdocs migration
refactor CSCS and Meg content add merlin6 quick start update merlin6 nomachine docs give the userdoc its own color scheme we use the Materials default one refactored slurm general docs merlin6 add merlin6 JB docs add software support m6 docs add all files to nav vibed changes #1 add missing pages further vibing #2 vibe #3 further fixes
This commit is contained in:
108
docs/merlin7/02-How-To-Use-Merlin/merlin_tools.md
Normal file
108
docs/merlin7/02-How-To-Use-Merlin/merlin_tools.md
Normal file
@@ -0,0 +1,108 @@
|
||||
---
|
||||
title: Merlin7 Tools
|
||||
#tags:
|
||||
keywords: merlin_quotas
|
||||
#last_updated: 07 September 2022
|
||||
#summary: ""
|
||||
sidebar: merlin7_sidebar
|
||||
permalink: /merlin7/tools.html
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
We provide tool(s) to help user get the most out of using the cluster. The tools
|
||||
described here are organised by use case and include usage examples.
|
||||
|
||||
## Files and Directories
|
||||
|
||||
### `merlin_quotas`
|
||||
|
||||
This tool is available on all of the login nodes and provides a brief overview of
|
||||
a user's filesystem quotas. These are limits which restrict how much storage (or
|
||||
number of files) a user can create. A generic table of filesystem quotas can be
|
||||
found on the [Storage page](storage.md#dir_classes).
|
||||
|
||||
#### Example #1: Viewing quotas
|
||||
|
||||
Simply calling `merlin_quotas` will show you a table of our quotas:
|
||||
|
||||
```console
|
||||
$ merlin_quotas
|
||||
Path SpaceUsed SpaceQuota Space % FilesUsed FilesQuota Files %
|
||||
-------------- --------- ---------- ------- --------- ---------- -------
|
||||
/data/user 30.26G 1T 03% 367296 2097152 18%
|
||||
└─ <USERNAME>
|
||||
/afs/psi.ch 3.4G 9.5G 36% 0 0 00%
|
||||
└─ user/<USERDIR>
|
||||
/data/project 2.457T 10T 25% 58 2097152 00%
|
||||
└─ bio/shared
|
||||
/data/project 338.3G 10T 03% 199391 2097152 10%
|
||||
└─ bio/hpce
|
||||
```
|
||||
|
||||
!!! tip
|
||||
You can change the width of the table by either passing `--no-wrap` (to
|
||||
disable wrapping of the *Path*) or `--width N` (to explicitly set some
|
||||
width by `N` characters).
|
||||
|
||||
#### Example #2: Project view
|
||||
|
||||
The tool can also be used to list out information about what projects directories
|
||||
there are and who owns/manages these:
|
||||
|
||||
```console
|
||||
$ merlin_quotas projects
|
||||
Project ID Path Owner Group
|
||||
---------- ------------------------ --------- --------------
|
||||
600000000 /data/project/bio/shared germann_e unx-merlin_adm
|
||||
600000001 /data/project/bio/hpce assman_g unx-merlin_adm
|
||||
```
|
||||
|
||||
By default this only shows information on projects that you have access to, but
|
||||
to view the whole list you can pass `--all` flag:
|
||||
|
||||
```console
|
||||
$ merlin_quotas projects --all
|
||||
Project ID Path Owner Group
|
||||
---------- ------------------------------- -------------- -----------------
|
||||
500000000 /data/project/general/mcnp gac-mcnp unx-mcnp_all
|
||||
500000001 /data/project/general/vis_as talanov_v unx-vis_as
|
||||
500000002 /data/project/general/mmm krack org-7302
|
||||
500000003 /data/project/general laeuch_a org-7201
|
||||
└─ LTC_CompPhys
|
||||
600000000 /data/project/bio/shared germann_e unx-merlin_adm
|
||||
600000001 /data/project/bio/hpce assman_g unx-merlin_adm
|
||||
600000002 /data/project/bio/abrahams abrahams_j unx-bio_abrahams
|
||||
600000003 /data/project/bio/benoit benoit_r unx-bio_benoit
|
||||
600000004 /data/project/bio/ishikawa ishikawa unx-bio_ishikawa
|
||||
600000005 /data/project/bio/kammerer kammerer_r unx-bio_kammerer
|
||||
600000006 /data/project/bio/korkhov korkhov_v unx-bio_korkhov
|
||||
600000007 /data/project/bio/luo luo_j unx-bio_luo
|
||||
600000008 /data/project/bio/mueller mueller_e unx-bio_mueller
|
||||
600000009 /data/project/bio/poghosyan poghosyan_e unx-bio_poghosyan
|
||||
600000010 /data/project/bio/schertler schertler_g unx-bio_schertler
|
||||
600000011 /data/project/bio/shivashankar shivashankar_g unx-bio_shivashan
|
||||
600000012 /data/project/bio/standfuss standfuss unx-bio_standfuss
|
||||
600000013 /data/project/bio/steinmetz steinmetz unx-bio_steinmetz
|
||||
```
|
||||
|
||||
!!! tip
|
||||
As above you can change the table width by pass either `--no-wrap` or
|
||||
`--width N`.
|
||||
|
||||
#### Example #3: Project config
|
||||
|
||||
To make tracking quotas of projects easier, `merlin_quotas` generates a config
|
||||
file in your home directory which defines the projects to show when you call the
|
||||
tool (called `~/.merlin_quotas`).
|
||||
|
||||
The config file simply contains a list (one per line) of project IDs which should
|
||||
be tracked. In theory any (or all available projects) can be tracked, but due to
|
||||
UNIX and Lustre permissions, accessing quotas information for a project you're not
|
||||
a member of **is not possible**.
|
||||
|
||||
If you are added/removed from a project, you can update this config file by
|
||||
calling `merlin_quotas genconf --force` (notice the `--force`, which will overwrite
|
||||
your existing config file) or by editing the file by hand (*not recommended*).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user