Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ jobs:
- if: ${{needs.get.outputs.filelist}}
name: Check markdown meta.
run: |
pip3 install titlecase
shopt -s globstar extglob
python3 checks/run_meta_check.py ${{needs.get.outputs.filelist}}
slurmcheck:
Expand Down
12 changes: 11 additions & 1 deletion checks/run_meta_check.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import yaml
import os
import time
from titlecase import titlecase
from pathlib import Path

# Ignore files if they match this regex
Expand All @@ -27,7 +28,7 @@

MAX_TITLE_LENGTH = 28 # As font isn't monospace, this is only approx
MAX_HEADER_LENGTH = 32 # minus 2 per extra header level
MIN_TAGS = 2
MIN_TAGS = 1
RANGE_SIBLING = [4, 8]
DOC_ROOT = "docs"

Expand Down Expand Up @@ -324,6 +325,14 @@ def title_length():
Try to keep it under {MAX_TITLE_LENGTH} characters to avoid word wrapping in the nav.",
}

def title_capitalisation():
correct_title = titlecase(title)
if title != correct_title:
yield {
"line": _get_lineno(r"^title:.*$"),
"message": f"Title '{title}' uses incorrect capitalisation. \
'{correct_title}' is preferred",
}

def minimum_tags():
if "tags" not in meta or not isinstance(meta["tags"], list):
Expand Down Expand Up @@ -407,6 +416,7 @@ def dynamic_slurm_link():
ENDCHECKS = [
title_redundant,
title_length,
title_capitalisation,
meta_missing_description,
meta_unexpected_key,
minimum_tags,
Expand Down
6 changes: 4 additions & 2 deletions docs/.pages.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
nav:
- Announcements
- Getting_Started
- General
- Scientific_Computing
- Software
- Batch_Computing
- Interactive_Computing
- Storage
- Service_Subscriptions
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ nav:
- Autodeletion_returning_for_scratch_filesystem.md
- December_holiday_support_restrictions.md
- Identity_Changes_for_Crown_Research_Institutes.md
- Known_Issues_HPC3.md
- Release_Notes

Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ sources of self-service support:

- Changes to system status are reported via our [System Status page](https://status.nesi.org.nz/ "https://status.nesi.org.nz/").
You can also subscribe for notifications of system updates and
unplanned outages sent straight to your inbox. [Sign up here.](../../Getting_Started/Getting_Help/System_status.md)
unplanned outages sent straight to your inbox. [Sign up here.](../Getting_Started/Getting_Help/System_status.md)

- [Consult our User Documentation](https://www.docs.nesi.org.nz) pages
for instructions and guidelines for using the systems.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ END: 9:00am 5 January 2026
<td>Self-service support<br><i>Available 24/7</i></td>
</tr>
<tr>
<td>Email: <a href="support@nesi.org.nz">support@nesi.org.nz</a></td>
<td>- <a href="../../Getting_Started/Getting_Help/System_status.md">Sign up for system status updates</a> for advance warning of any system updates or unplanned outages.<br>- <a href="https://www.docs.nesi.org.nz">Consult our User Documentation</a> pages for instructions and guidelines for using the systems.<br>- <a href="https://www.youtube.com/playlist?list=PLvbRzoDQPkuGMWazx5LPA6y8Ji6tyl0Sp">Visit our YouTube channel</a>  for introductory training webinars.</td>
<td>Email: <a href="../General/Announcements/support@nesi.org.nz">support@nesi.org.nz</a></td>
<td>- <a href="../Getting_Started/Getting_Help/System_status.md">Sign up for system status updates</a> for advance warning of any system updates or unplanned outages.<br>- <a href="https://www.docs.nesi.org.nz">Consult our User Documentation</a> pages for instructions and guidelines for using the systems.<br>- <a href="https://www.youtube.com/playlist?list=PLvbRzoDQPkuGMWazx5LPA6y8Ji6tyl0Sp">Visit our YouTube channel</a>  for introductory training webinars.</td>
</tr>
</tbody>
</table>
Expand All @@ -45,7 +45,7 @@ END: 9:00am 5 January 2026
<td>Self-service support<br><i>Available 24/7</i></td>
</tr>
<tr>
<td>Phone: 0508 466 466<br>Email: <a href="help@reannz.co.nz">help@reannz.co.nz</a></td>
<td>Phone: 0508 466 466<br>Email: <a href="../General/Announcements/help@reannz.co.nz">help@reannz.co.nz</a></td>
<td>- <a href="https://reannz.status.io">Sign up for system status updates</a> for advance warning of any system updates or unplanned outages.<br>- <a href="https://weathermap.reannz.co.nz">Check the REANNZ weathermap</a> for a real-time view of network operations.</td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

Below is a list issues that we're actively working on. We hope to have these resolved soon. This is intended to be a temporary page.

For differences between the new platforms and Mahuika, see the more permanent [differences from Mahuika](../../General/FAQs/Mahuika_HPC3_Differences.md).
For differences between the new platforms and Mahuika, see the more permanent [differences from Mahuika](../Getting_Started/FAQs/Mahuika_HPC3_Differences.md).


!!! info "Recently fixed"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
---
created_at: '2021-02-23T19:52:34Z'
tags: []
vote_count: 0
vote_sum: 0
title: Release Notes
zendesk_article_id: 360003507115
zendesk_section_id: 360000437436
---

NeSI publishes release notes for applications, 3rd party applications
Expand All @@ -23,7 +19,7 @@ be located under Storage, Long-Term Storage

## 3rd party applications

3rd party applications listed under [Supported Applications](../../Scientific_Computing/Supported_Applications/index.md)
3rd party applications listed under [Supported Applications](../../Software/Available_Applications/index.md)
have child pages with details about the available versions on NeSI, and
a reference to the vendor release notes or documentation.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
nav:
- Submitting_your_first_job.md
- Hardware.md
- Job_prioritisation.md
- SLURM-Best_Practice.md
- Using_GPUs.md
- Job_Checkpointing.md
- Slurm_Interactive_Sessions.md
- Fair_Share.md
- Checksums.md
- "*"
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Your *Fair Share score* is a number between **0** and **1**. Projects
with a **larger** Fair Share score receive a **higher priority** in the
queue.

A project is given an [allocation of compute units](../../Getting_Started/Accounts-Projects_and_Allocations/What_is_an_allocation.md)
A project is given an [allocation of compute units](../Getting_Started/Allocations/What_is_an_allocation.md)
over a given **period**. An institution also has a percentage **Fair Share entitlement**
of each machine's deliverable capacity over that same period.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs, but is limited to one small job per user at a time: no more than

Job priority decreases whenever the project uses more core-hours than
expected, across all partitions.
This [Fair Share](../../Scientific_Computing/Batch_Jobs/Fair_Share.md)
This [Fair Share](Fair_Share.md)
policy means that projects that have consumed many CPU core hours in the
recent past compared to their expected rate of use (either by submitting
and running many jobs, or by submitting and running large jobs) will
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ etc).
### Memory (RAM)

If you request more memory (RAM) than you need for your job, it
[will wait longer in the queue and will be more expensive when it runs](../../General/FAQs/Why_is_my_job_taking_a_long_time_to_start.md).
[will wait longer in the queue and will be more expensive when it runs](../Getting_Started/FAQs/Why_is_my_job_taking_a_long_time_to_start.md).
On the other hand, if you don't request enough memory, the job may be
killed for attempting to exceed its allocated memory limits.

Expand All @@ -53,7 +53,7 @@ your program will need at peak memory usage.

We also recommend using `--mem` instead of `--mem-per-cpu` in most
cases. There are a few kinds of jobs for which `--mem-per-cpu` is more
suitable. See [our article on how to request memory](../../General/FAQs/How_do_I_request_memory.md)
suitable. See [our article on how to request memory](../Getting_Started/FAQs/How_do_I_request_memory.md)
for more information.

## Parallelism
Expand All @@ -77,4 +77,4 @@ job array in a single command)

A low fairshare score will affect your jobs priority in the queue, learn
more about how to effectively use your allocation,
[Fair Share](../../Scientific_Computing/Batch_Jobs/Fair_Share.md).
[Fair Share](Fair_Share.md).
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This page provides generic information about how to access GPUs through the Slur

## Request GPU resources using Slurm

To request a GPU for your [Slurm job](../../Getting_Started/Next_Steps/Submitting_your_first_job.md), add
To request a GPU for your [Slurm job](Submitting_your_first_job.md), add
the following option in the header of your submission script:

```sl
Expand All @@ -28,7 +28,7 @@ the following option in the header of your submission script:
You can specify the type and number of GPU you need using the following
syntax

``` sl
```sl
#SBATCH --gpus-per-node=<gpu_type>:<gpu_number>
```

Expand Down Expand Up @@ -81,7 +81,7 @@ It is recommended to specify the exact GPU type required; otherwise, the job may
</table>

You can also use the `--gpus-per-node`option in
[Slurm interactive sessions](./Slurm_Interactive_Sessions.md),
[Slurm interactive sessions](../Interactive_Computing/Slurm_Interactive_Sessions.md),
with the `srun` and `salloc` commands. For example:

``` sh
Expand Down Expand Up @@ -111,7 +111,7 @@ duration of 30 minutes.
## Load CUDA and cuDNN modules

To use an Nvidia GPU card with your application, you need to load the
driver and the CUDA toolkit via the [environment modules](../Supported_Applications/index.md)
driver and the CUDA toolkit via the [environment modules](../Software/Available_Applications/index.md)
mechanism:

``` sh
Expand Down Expand Up @@ -229,12 +229,12 @@ CUDA_VISIBLE_DEVICES=0
The following pages provide additional information for supported
applications:

- [ABAQUS](../Supported_Applications/ABAQUS.md#examples)
- [GROMACS](../Supported_Applications/GROMACS.md)
- [Lambda Stack](../Supported_Applications/Lambda_Stack.md)
- [Matlab](../Supported_Applications/MATLAB.md#using-gpus)
- [TensorFlow on GPUs](../Supported_Applications/TensorFlow_on_GPUs.md)
- [ABAQUS](../Software/Available_Applications/ABAQUS.md#examples)
- [GROMACS](../Software/Available_Applications/GROMACS.md)
- [Lambda Stack](../Software/Available_Applications/Lambda_Stack.md)
- [Matlab](../Software/Available_Applications/MATLAB.md#using-gpus)
- [TensorFlow on GPUs](../Software/Available_Applications/TensorFlow_on_GPUs.md)

And programming toolkits:

- [NVIDIA GPU Containers](../HPC_Software_Environment/NVIDIA_GPU_Containers.md)
- [NVIDIA GPU Containers](../Software/Containers/NVIDIA_GPU_Containers.md)
6 changes: 0 additions & 6 deletions docs/General/.pages.yml

This file was deleted.

5 changes: 3 additions & 2 deletions docs/Getting_Started/.pages.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
nav:
- Accounts, Projects and Allocations : Accounts-Projects_and_Allocations
- Creating_an_Account.md
- Projects
- Allocations
- Accessing_the_HPCs
- Next_Steps
- Getting_Help
- Cheat_Sheets
- "*"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:
---

!!! prerequisite
- Have an [active account and project](../Accounts-Projects_and_Allocations/Creating_an_Account_Profile.md).
- Have an [active account and project](../Creating_an_Account.md).

Before you can start submitting work you will need some way of
connecting to the NeSI clusters.
Expand All @@ -27,7 +27,7 @@ operating system and level of experience.

!!! tip "What next?"
- More info on
[NeSI OnDemand](../../Scientific_Computing/Interactive_computing_with_OnDemand/how_to_guide.md)
[NeSI OnDemand](../../Interactive_Computing/OnDemand/how_to_guide.md)
- Visit [ondemand.nesi.org.nz](https://ondemand.nesi.org.nz/).

## Linux or Mac OS
Expand All @@ -40,12 +40,12 @@ installed, usually called, "Terminal." To find it, simply search for
Congratulations! You are ready to move to the next step.

!!! prerequisite "What next?"
Setting up your [Default Terminal](../../Scientific_Computing/Terminal_Setup/Standard_Terminal_Setup.md)
Setting up your [Default Terminal](Standard_Terminal_Setup.md)

### VSCode

The inbuilt 'remotes' plugin allows connecting to remote hosts.
If you have set up your `~/.ssh/config` as described in [Standard_Terminal_Setup](../../Scientific_Computing/Terminal_Setup/Standard_Terminal_Setup.md),
If you have set up your `~/.ssh/config` as described in [Standard_Terminal_Setup](Standard_Terminal_Setup.md),
VSCode will detect this and show configured hosts in the 'Remote Explorer' Tab.

## Windows
Expand All @@ -69,8 +69,8 @@ different options, listed in order of preference.

!!! tip "What next?"
- Enabling
[WSL](../../Scientific_Computing/Terminal_Setup/Windows_Subsystem_for_Linux_WSL.md)
- Setting up the [Ubuntu Terminal](../../Scientific_Computing/Terminal_Setup/Windows_Subsystem_for_Linux_WSL.md)
[WSL](Windows_Subsystem_for_Linux_WSL.md)
- Setting up the [Ubuntu Terminal](Windows_Subsystem_for_Linux_WSL.md)

### VSCode

Expand All @@ -91,7 +91,7 @@ VSCode can be used with WSL or without.
institution's IT team supports MobaXTerm.
!!! tip "What next?"
- Setting up
[MobaXterm](../../Scientific_Computing/Terminal_Setup/MobaXterm_Setup_Windows.md)
[MobaXterm](MobaXterm_Setup_Windows.md)

### Using a Virtual Machine

Expand Down Expand Up @@ -123,7 +123,7 @@ for new users.

!!! tip "What next?"
- Setting up
[WinSCP](../../Scientific_Computing/Terminal_Setup/WinSCP-PuTTY_Setup_Windows.md)
[WinSCP](WinSCP-PuTTY_Setup_Windows.md)

### Git Bash

Expand All @@ -141,7 +141,7 @@ primary terminal.
All Windows computers have PowerShell installed, however it will
only be useful to you if Windows Subsystem for Linux (WSL) is also
enabled, instructions can be found at
[Windows_Subsystem_for_Linux_WSL](../../Scientific_Computing/Terminal_Setup/Windows_Subsystem_for_Linux_WSL.md).
[Windows_Subsystem_for_Linux_WSL](Windows_Subsystem_for_Linux_WSL.md).

Like Git Bash, PowerShell is perfectly adequate for testing your
login or setting up your password, but lacks many of the features of
Expand Down
8 changes: 4 additions & 4 deletions docs/Getting_Started/Accessing_the_HPCs/First_Time_Login.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,24 @@ tags:
---

!!! prerequisite
- Have an [account](../Accounts-Projects_and_Allocations/Creating_an_Account_Profile.md).
- Be a member of an [active project](../Accounts-Projects_and_Allocations/Creating_an_Account_Profile.md).
- Have an [account](../Creating_an_Account.md).
- Be a member of an [active project](../Creating_an_Account.md).
- Have a device with an authentication app.

!!! note
On 01 July 2025, New Zealand eScience Infrastructure (NeSI) was integrated into the Crown company, Research and Education Advanced Network New Zealand (REANNZ) Ltd.
NeSI’s services and technologies are now hosted by REANNZ as a national eResearch Infrastructure Platform.
Some of our tools (as pictured in the screenshot below) will retain a ‘NeSI’ brand as we transition our services and develop a longer-term strategy for this integrated platform.

1. Log into [my.nesi](my.nesi.org.nz)
1. Log into [my.nesi](http://my.nesi.org.nz)

2. Go to [**OnDemand**](https://ondemand.nesi.org.nz/). It will automatically take you to the Tuakiri login screen.
![alt text](../../assets/images/ondemand_login_0.png)

3. Select your affiliated institution, and log in using your institutional account. Example below shows the University of Auckland login screen.
![alt text](../../assets/images/ondemand_login_1.png)

4. If you haven't logged into OnDemand or our HPC platforms before, you wil need to set up new authentication credentials. This is in addition to your institutional MFA process.
4. If you haven't logged into OnDemand or our HPC platforms before, you will need to set up new authentication credentials. This is in addition to your institutional MFA process.
![alt text](../../assets/images/ondemand_login_2.png)

!!! note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ title: Git Bash (Windows)
---

!!! prerequisite
- Have a [NeSI account.](../../Getting_Started/Accounts-Projects_and_Allocations/Creating_an_Account_Profile.md).
- Be a member of an [active project.](../../Getting_Started/Accounts-Projects_and_Allocations/Applying_to_join_a_project.md)
- Have a [NeSI account.](../Creating_an_Account.md).
- Be a member of an [active project.](../Projects/Applying_to_Join_a_Project.md)

## First time setup

Expand Down Expand Up @@ -40,7 +40,7 @@ credentials every time you open a new terminal or try to move a file.*
scp <path/filename> nesi:~/
```

For more info visit [data transfer](../../Getting_Started/Next_Steps/Moving_files_to_and_from_the_cluster.md).
For more info visit [data transfer](../../Storage/Moving_files_to_and_from_the_cluster.md).

!!! prerequisite "What Next?"
- [Standard Terminal Setup](Standard_Terminal_Setup.md)
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: How to set up cluster access using MobaXterm
It is recommended to use [OnDemand](https://ondemand.nesi.org.nz/) for file browsing, up and downloading and terminal access if you would normally have used MobaXterm.

!!! prerequisite
- Have an [active account and project.](../../Getting_Started/Accounts-Projects_and_Allocations/Creating_an_Account_Profile.md)
- Have an [active account and project.](../Creating_an_Account.md)
- [Download MobaXterm](https://mobaxterm.mobatek.net/download-home-edition.html)
- Followed the steps in [Standard Terminal](Standard_Terminal_Setup.md).

Expand All @@ -22,10 +22,10 @@ description: How to set up cluster access using MobaXterm
- Otherwise, choose freely the Portable or Installer Edition.

!!! prerequisite "What Next?"
- [Moving files to/from a cluster.](../../Getting_Started/Next_Steps/Moving_files_to_and_from_the_cluster.md)
- [Moving files to/from a cluster.](../../Storage/Moving_files_to_and_from_the_cluster.md)

The interactive login configuration for MobaXterm is not compatable with the current web-based authentication method. If you wish to use MobaXterm as your SSH client you therefore need to use a non-interactive setup.
This can be done by following a modified version of the instructions for setting up the [the standard terminal setup described on this support page](../../Scientific_Computing/Terminal_Setup/Standard_Terminal_Setup.md).
This can be done by following a modified version of the instructions for setting up the [the standard terminal setup described on this support page](Standard_Terminal_Setup.md).

## First time setup

Expand Down
Loading
Loading