Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP Restructure #446

Open
wants to merge 37 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
3306397
First move
CallumWalley Feb 4, 2025
b4ab695
sume css
CallumWalley Feb 4, 2025
81aa9f7
Updated Module List
CallumWalley Feb 5, 2025
7f69765
New atempt not breaking
CallumWalley Feb 7, 2025
eeb9901
Updated Module List
CallumWalley Feb 8, 2025
676d5b5
Updated Module List
CallumWalley Feb 16, 2025
d707bc5
Merge branch 'main' into beautiful-swallow
CallumWalley Feb 18, 2025
56d2cab
mergee comsol
CallumWalley Feb 18, 2025
f23469e
pre mass link replace
CallumWalley Feb 18, 2025
c090b43
relitivise links
CallumWalley Feb 19, 2025
96bda63
Updated Module List
CallumWalley Feb 19, 2025
a7e68b2
Updated Glossary
CallumWalley Feb 19, 2025
5ea4a33
fix most links
CallumWalley Feb 20, 2025
676cdf4
some rearangin
CallumWalley Feb 20, 2025
f6d0738
Merge remote-tracking branch 'origin/main' into beautiful-swallow
CallumWalley Feb 20, 2025
9025bda
Update cachce
CallumWalley Feb 20, 2025
2858c77
rename software catalouge
CallumWalley Feb 21, 2025
7c42ea0
Some lite de-mauification
CallumWalley Feb 21, 2025
a256f0a
Refresh of module load area
CallumWalley Feb 21, 2025
003e418
More software update
CallumWalley Feb 21, 2025
99dc55c
move more things into allocations cat
CallumWalley Feb 21, 2025
f60bf8f
biggify table
CallumWalley Feb 21, 2025
cc556df
split up par copute page.
CallumWalley Feb 21, 2025
a62a341
fix broken
CallumWalley Feb 21, 2025
02466f1
Updated Module List
CallumWalley Feb 23, 2025
7f875bd
some indexes
CallumWalley Feb 25, 2025
8e0924e
renaming some top level cats
CallumWalley Feb 25, 2025
de2a847
fix-pages.yml
CallumWalley Feb 25, 2025
305d525
merge gpu into resources page
CallumWalley Feb 25, 2025
f8df32f
Merge branch 'main' into beautiful-swallow
CallumWalley Feb 26, 2025
ff34624
Replace Interactive computing with OpenOnDemand
CallumWalley Feb 26, 2025
b7cac50
compress terminal setup pages.
CallumWalley Feb 26, 2025
5b26326
Updated metadocs
CallumWalley Feb 26, 2025
93bd869
Move OpenOnDemand up
CallumWalley Feb 26, 2025
d42ed4d
must have moved something...
CallumWalley Mar 3, 2025
b44c8e2
must have moved something
CallumWalley Mar 3, 2025
9dad173
Swap to using native card system.
CallumWalley Mar 3, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
9 changes: 4 additions & 5 deletions docs/.pages.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
nav:
- Getting_Started
- General
- Scientific_Computing
- Storage
- NeSI_Service_Subscriptions
- Access
- High_Performance_Computing
- Researcher_Developer_Cloud
- Capability_&_Skills
2 changes: 2 additions & 0 deletions docs/Access/.pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
nav:
- ...
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@ nav:
- Creating_a_NeSI_Account_Profile.md
- Applying_for_a_new_NeSI_project.md
- Applying_to_join_an_existing_NeSI_project.md
- Setting_Up_and_Resetting_Your_Password.md
- Setting_Up_Two_Factor_Authentication.md
- What_is_an_allocation.md
- Quarterly_allocation_periods.md
- ...
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ affiliated with an organisation supported by the
federation, you can request access via
[my.nesi.org.nz/register](https://my.nesi.org.nz/register).

![mceclip0.png](../../assets/images/Account_Requests_for_non_Tuakiri_Members.png)
![mceclip0.png](Account_Requests_for_non_Tuakiri_Members.png)

!!! prerequisite
The email address you use on your application must be your
@@ -43,6 +43,6 @@ my.nesi.org.nz.
If you still can't find the email, {% include "partials/support_request.html" %}.

!!! note "What next?"
- [Project Eligibility](../../General/NeSI_Policies/Allocation_classes.md)
- [Applying for a new project.](../../Getting_Started/Accounts-Projects_and_Allocations/Applying_for_a_new_NeSI_project.md)
- [Applying to join an existing project](../../Getting_Started/Accounts-Projects_and_Allocations/Applying_to_join_an_existing_NeSI_project.md).
- [Project Eligibility](Allocation_classes.md)
- [Applying for a new project.](Applying_for_a_new_NeSI_project.md)
- [Applying to join an existing project](Applying_to_join_an_existing_NeSI_project.md).
Original file line number Diff line number Diff line change
@@ -9,15 +9,15 @@ description: How to add a new member to your NeSI project.
---

!!! prerequisite
- Have a [NeSI Account profile](./Creating_a_NeSI_Account_Profile.md).
- Be the **owner** of a [NeSI project](./Applying_for_a_new_NeSI_project.md).
- Have a [NeSI Account profile](Creating_a_NeSI_Account_Profile.md).
- Be the **owner** of a [NeSI project](Applying_for_a_new_NeSI_project.md).

1. Log in to [my.nesi.org.nz](https://my.nesi.org.nz/) via your browser.
2. Under **List Projects**, click on the project you want to add members to.
3. When the page is loaded, scroll down to the section **Project Members** and select the **+** button (you will need to be the owner of the project).
4. Enter the Username of the new member, select a project role from the drop-down options, and click **Submit**.

![Adding_Members.png](../../assets/images/Adding_Members.png)
![Adding_Members.png](Adding_Members.png)

!!! prerequisite "What Next?"
- The new team member will now be able to access your project on NeSI, provided they have [set a NeSI account password](../Accessing_the_HPCs/Setting_Up_and_Resetting_Your_Password.md).
- The new team member will now be able to access your project on NeSI, provided they have [set a NeSI account password](Setting_Up_and_Resetting_Your_Password.md).
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ general terms, the allocation class granted to your project is used to
decide who pays for that aspect of your project's consumption of NeSI
services.

<table style="width: 80%;">
<table style="width: 100%;">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
@@ -208,4 +208,4 @@ take a while to set up.
Our team is happy to answer any questions you may have throughout the
application process.

For more information, see [how we review applications](../NeSI_Policies/How_we_review_applications.md).
For more information, see [how we review applications](How_we_review_applications.md).
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ zendesk_section_id: 360000196195
---

!!! prerequisite
- Have a [NeSI Account profile](../../Getting_Started/Accounts-Projects_and_Allocations/Creating_a_NeSI_Account_Profile.md).
- Have a [NeSI Account profile](Creating_a_NeSI_Account_Profile.md).
- NIWA researchers only: read and follow the
[NIWA internal documentation for gaining access to the HPCs](https://one.niwa.co.nz/display/ONE/High+Performance+Computing+Facility+Services)
(this link is only valid from within the NIWA network or VPN).
@@ -24,11 +24,9 @@ zendesk_section_id: 360000196195
Carpentry](https://swcarpentry.github.io/shell-novice/), to help
you and your project team gain the necessary skills.
- Become familiar with foundational HPC skills, for example by
attending a NeSI introductory workshop, one of our [weekly
introductory sessions (or watching the
recording)](../../Getting_Started/Getting_Help/Introductory_Material.md),
attending a NeSI introductory workshop, one of our weekly introductory sessions (or watching the recording),
or having one or more of your project team members do so.
- Review our [allocation classes](../../General/NeSI_Policies/Allocation_classes.md). If
- Review our [allocation classes](Allocation_classes.md). If
you don't think you currently qualify for any class other than
Proposal Development, please {% include "partials/support_request.html" %} as soon as
possible to discuss your options. Your institution may be in a
@@ -70,7 +68,7 @@ information:
research programme's current or expected funding)
- Details of how your project is funded (this will help determine
whether you are eligible for an allocation from our
[Merit](../../General/NeSI_Policies/Merit_allocations.md) class)
[Merit](Merit_allocations.md) class)
- Your previous HPC experience
- Whether you would like expert scientific programming support on your
project
@@ -82,8 +80,8 @@ is relevant.

!!! prerequisite "What Next?"
- Your NeSI Project proposal will be
[reviewed](../../General/NeSI_Policies/How_we_review_applications.md),
[reviewed](How_we_review_applications.md),
after which you will be informed of the outcome.
- We may contact you if further details are required.
- When your project is approved you will be able to [set your Linux
Password](../../Getting_Started/Accessing_the_HPCs/Setting_Up_and_Resetting_Your_Password.md).
- When your project is approved you will be able to
[set your Linux Password](Setting_Up_and_Resetting_Your_Password.md).
Original file line number Diff line number Diff line change
@@ -13,8 +13,7 @@ zendesk_section_id: 360000196195
---

!!! prerequisite
- You must have a [NeSI
account](../../Getting_Started/Accounts-Projects_and_Allocations/Creating_a_NeSI_Account_Profile.md).
- You must have a [NeSI account](Creating_a_NeSI_Account_Profile.md).

## How to join an existing project on NeSI

@@ -24,9 +23,9 @@ If you do not know your NeSI account username:

1. Log in to [my.nesi.org.nz](https://my.nesi.org.nz/) via your browser.
2. In the left side panel, under Account, click My HPC Account. Your Username will appear at the top of the page.
![authentication\_factor\_setup.png](../../assets/images/Setting_Up_and_Resetting_Your_Password.png)
![authentication\_factor\_setup.png](Setting_Up_and_Resetting_Your_Password.png)

!!! prerequisite "What Next?"
- The project owner will add your username to the project.
- Once it is done, you will be able to [set your NeSI account
password](../../Getting_Started/Accessing_the_HPCs/Setting_Up_and_Resetting_Your_Password.md).
- Once it is done, you will be able to
[set your NeSI account password](Setting_Up_and_Resetting_Your_Password.md).
Original file line number Diff line number Diff line change
@@ -14,22 +14,20 @@ zendesk_section_id: 360000196195


!!! prerequisite
Either an active login at a Tuakiri member institution, or [a Tuakiri
Virtual Home account in respect of your current place of work or
study](../../General/NeSI_Policies/Account_Requests_for_non_Tuakiri_Members.md).
Either an active login at a Tuakiri member institution, or
[a Tuakiri Virtual Home account](Account_Requests_for_non_Tuakiri_Members.md) in respect of your current place of work or study.

1. Access [my.nesi.org.nz](https://my.nesi.org.nz) via your browser and
log in with either your institutional credentials, or your Tuakiri
Virtual Home account, whichever applies.

2. If this is your first time logging in to my.nesi and you do not have
2. If this is your first time logging in to MyNeSI and you do not have
an entry in our database (you have not previously had a NeSI
account) you will be asked to fill out some fields, such as your
role at your institution and contact telephone number, and submit
the online form to us. We will complete your personal profile for
our records.

!!! prerequisite "What next?"
- [Apply for Access](../../Getting_Started/Accounts-Projects_and_Allocations/Applying_for_a_new_NeSI_project.md),
either submit an application for a new project or
[join an existing project](../../Getting_Started/Accounts-Projects_and_Allocations/Applying_to_join_an_existing_NeSI_project.md).
- [Apply for Access](Applying_for_a_new_NeSI_project.md).
- [Join an existing project](Applying_to_join_an_existing_NeSI_project.md).
Original file line number Diff line number Diff line change
@@ -26,11 +26,11 @@ from your institution.

If you are a postgraduate student at a NeSI collaborator, your project
will likely be considered for an Institutional allocation rather than a
[Merit](../../General/NeSI_Policies/Merit_allocations.md) or
[Postgraduate](../../General/NeSI_Policies/Postgraduate_allocations.md)
[Merit](Merit_allocations.md) or
[Postgraduate](Postgraduate_allocations.md)
allocation.

Read more about [how we review applications](../../General/NeSI_Policies/How_we_review_applications.md).
Read more about [how we review applications](How_we_review_applications.md).

To learn more about NeSI Projects or to apply for a new project, please
read our article [Applying for a NeSI Project](../../Getting_Started/Accounts-Projects_and_Allocations/Applying_for_a_new_NeSI_project.md).
read our article [Applying for a NeSI Project](Applying_for_a_new_NeSI_project.md).
Original file line number Diff line number Diff line change
@@ -31,7 +31,7 @@ following outcomes:
- For "quick wins" we may be able to achieve these improvements
within the scope of the job efficiency review
- For larger pieces of work, we would assist you in applying for a
[NeSI Consultancy](../../Getting_Started/Getting_Help/Consultancy.md)
[NeSI Consultancy](../../Training/Consultancy.md)
project, where we would work with you on a longer term project
to implement any agreed changes

Original file line number Diff line number Diff line change
@@ -14,8 +14,7 @@ zendesk_section_id: 360000224835
This is the highest award given for use of NeSI services. A Merit
allocation is intended for highly skilled research teams carrying out
high quality research funded via a peer review process that supports the
[New Zealand Government's Science
Goals](https://www.mbie.govt.nz/science-and-technology/science-and-innovation/funding-information-and-opportunities/national-statement-of-science-investment/).
[New Zealand Government's Science Goals](https://www.mbie.govt.nz/science-and-technology/science-and-innovation/funding-information-and-opportunities/national-statement-of-science-investment/).
Merit allocations may be made for the HPC Compute & Analytics and
Consultancy services.

@@ -24,8 +23,7 @@ must meet the following criteria:

- The underpinning research programme (that requires access to NeSI
HPC services to achieve the objectives of the research) must support
the [Government’s Science
Goals](https://www.mbie.govt.nz/science-and-technology/science-and-innovation/funding-information-and-opportunities/national-statement-of-science-investment/).
the [Government’s Science Goals](https://www.mbie.govt.nz/science-and-technology/science-and-innovation/funding-information-and-opportunities/national-statement-of-science-investment/).
- To demonstrate research quality and alignment with national research
priorities, the research funding must have come from a
peer-reviewed, contestable process at an institutional, regional or
@@ -51,8 +49,7 @@ must meet the following criteria:
discretion consider your application for a Merit award if your
supervisor is a named investigator.

Read more about [how we review
applications](../../General/NeSI_Policies/How_we_review_applications.md).
Read more about [how we review applications](How_we_review_applications.md).

To learn more about NeSI Projects or to apply for a new project, please
read our article [Applying for a NeSI Project](../../Getting_Started/Accounts-Projects_and_Allocations/Applying_for_a_new_NeSI_project.md).
read our article [Applying for a NeSI Project](Applying_for_a_new_NeSI_project.md).
Original file line number Diff line number Diff line change
@@ -36,8 +36,7 @@ project an allocation from the Postgraduate class:
until a later time, if there is insufficient computing capacity
available to meet demand.

Read more about [how we review
applications](../../General/NeSI_Policies/How_we_review_applications.md).
Read more about [how we review applications](How_we_review_applications.md).

To learn more about NeSI Projects, and to apply please review the
content of the section entitled [Applying for a NeSI Project](../../Getting_Started/Accounts-Projects_and_Allocations/Applying_for_a_new_NeSI_project.md).
content of the section entitled [Applying for a NeSI Project](Applying_for_a_new_NeSI_project.md).
Original file line number Diff line number Diff line change
@@ -16,7 +16,7 @@ for a new project to carry on the same work.
We currently offer two sorts of extensions:

- A new allocation of computing resources (usually compute units on
Mahuika or node hours on Māui)
Mahuika)
- A project extension without a new allocation of computing resources.

## Will my project qualify for an extension?
@@ -58,16 +58,14 @@ extension request.
You can submit a request for an extension using <https://my.nesi.org.nz>
or by {% include "partials/support_request.html" %}.

Please see [Requesting to renew an allocation via
my.nesi.org.nz](../../Getting_Started/my-nesi-org-nz/Requesting_to_renew_an_allocation_via_my-nesi-org-nz.md)
Please see [Requesting to renew an allocation via my.nesi.org.nz](Requesting_to_renew_an_allocation_via_my-nesi-org-nz.md)
for more details.

You will receive a series of automated emails inviting you to apply for
a new allocation (or, alternatively, clean up your project data) in the
following circumstances:

- In the lead-up to the end of the [call
window](https://www.nesi.org.nz/news/2018/04/new-application-process-merit-postgraduate-allocations)
- In the lead-up to the end of the [call window](https://www.nesi.org.nz/news/2018/04/new-application-process-merit-postgraduate-allocations)
immediately before your currently active allocation is scheduled to
end.
- In the lead-up to the end of your allocation.
@@ -104,7 +102,7 @@ If this is your situation, please let us know when you request your
project extension. Please note that we are unlikely to let a project
continue without a compute allocation for more than six months at a
time. If you expect that your project will be suspended for more than
six months, we encourage you to enquire about our [Long-Term Storage
Service](../../Storage/Nearline_long_term_storage/Nearline_Long_Term_Storage_Service.md) or
to move your research data off our facility and make arrangements with
six months, we encourage you to enquire about our
[Long-Term Storage Service](Nearline_Long_Term_Storage_Service.md)
or to move your research data off our facility and make arrangements with
your project's host institution for long-term data storage.
Original file line number Diff line number Diff line change
@@ -15,7 +15,8 @@ A Proposal Development allocation is a short-term allocation of up to
(on Māui) or both, for up to six months. During your Proposal
Development allocation you can find out:

- whether your software can run on a [NeSI HPC](../../Scientific_Computing/The_NeSI_High_Performance_Computers/index.md),
- whether your software can run on a
[NeSI HPC](../../Scientific_Computing/Software/index.md),
- how your software scales to multiple cores or across compute nodes,
- approximately how many compute units or node hours your research
project is likely to need.
@@ -34,11 +35,11 @@ Proposal Development allocation.

Once you have completed your Proposal Development allocation, you are
welcome to apply for a further allocation. If you are successful, the
project's next allocation will be from another of the [allocation
classes](../../General/NeSI_Policies/Allocation_classes.md).
project's next allocation will be from another of the
[allocation classes](Allocation_classes.md).

The [How Applications are Reviewed](How_we_review_applications.md) section
provides additional important information for applicants.

To learn more about NeSI Projects, and to apply please review the
content of the section entitled [Applying for a NeSI Project](../../Getting_Started/Accounts-Projects_and_Allocations/Applying_for_a_new_NeSI_project.md).
content of the section entitled [Applying for a NeSI Project](Applying_for_a_new_NeSI_project.md).
Original file line number Diff line number Diff line change
@@ -24,15 +24,15 @@ Allocations will start on the first day of the next month and run for
one year. The diagram below illustrates how these quarterly call periods
are scheduled during the year:

![Quarterly\_Allocation\_Periods\_2021\_\_1\_.png](../../assets/images/Quarterly_allocation_periods.png)
![Quarterly\_Allocation\_Periods\_2021\_\_1\_.png](Quarterly_allocation_periods.png)

For example, if you apply for a new allocation on your existing project
in the month of October, we will review your application in October or
early November, you will be notified of your allocation by the end of
November, and your allocation will start on 1 December (as shown in the
graphic below).

![Blank\_Diagram\_\_1\_.png](../../assets/images/Quarterly_allocation_periods_0.png)
![Blank\_Diagram\_\_1\_.png](Quarterly_allocation_periods_0.png)

## Existing allocations

@@ -54,4 +54,4 @@ month.
wait for the following call before your request is considered.

If you have questions about the review cycles or other steps involved
with getting access to NeSI, {% include "partials/support_request.html" %}
with getting access to NeSI, {% include "partials/support_request.html" %}
Original file line number Diff line number Diff line change
@@ -12,9 +12,9 @@ zendesk_section_id: 360000034315
---

!!! prerequisite
- Have a [NeSI account](../../Getting_Started/Accounts-Projects_and_Allocations/Creating_a_NeSI_Account_Profile.md).
- Be a member of an [active project](../../Getting_Started/Accounts-Projects_and_Allocations/Creating_a_NeSI_Account_Profile.md).
- Have [set up your NeSI account password](../../Getting_Started/Accessing_the_HPCs/Setting_Up_and_Resetting_Your_Password.md).
- Have a [NeSI account](Creating_a_NeSI_Account_Profile.md).
- Be a member of an [active project](Creating_a_NeSI_Account_Profile.md).
- Have [set up your NeSI account password](Setting_Up_and_Resetting_Your_Password.md).
- Have a device with an authentication app.

##  Authentication App
@@ -33,10 +33,10 @@ If you some reason you can't do this, please contact NeSI support.

2. Click **My HPC Account** on left hand panel  and then **Setup
Two-Factor Authentication device**
![authentication\_factor\_setup.png](../../assets/images/Setting_Up_Two_Factor_Authentication.png)
![authentication\_factor\_setup.png](Setting_Up_Two_Factor_Authentication.png)

3. Click the "**Setup Two-Factor Authentication device**" link.
![set\_up\_2fa\_device.png](../../assets/images/Setting_Up_Two_Factor_Authentication_0.png)
![set\_up\_2fa\_device.png](Setting_Up_Two_Factor_Authentication_0.png)

4. After clicking on "Continue" you will retrieve the QR code.

@@ -54,4 +54,4 @@ This means that you can only try logging in to the lander node once
every 30 seconds.

!!! tip "What next?"
[Getting access to the cluster](../../Getting_Started/Accessing_the_HPCs/Choosing_and_Configuring_Software_for_Connecting_to_the_Clusters.md)
[Getting access to the cluster](Choosing_and_Configuring_Software_for_Connecting_to_the_Clusters.md)
Loading