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

Copyedits #560

Merged
merged 6 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ Run `mkdocs serve` or `make serve` to auto-build and serve the docs for preview
$ make serve
```

GitHub Actions are used to automatically validate all changes in pull requests before they are merged, by executing `mkdocs build --strict`. The [`--strict`](https://www.mkdocs.org/user-guide/configuration/#validation) flag will print out warnings and return a nonzero code if any of a number of checks fail (e.g. broken relative links, orphaned Markdown pages thtat are missing from the navigation sidebar, etc.). To see if your changes will pass these tests, run the following command locally:
GitHub Actions are used to automatically validate all changes in pull requests before they are merged, by executing `mkdocs build --strict`. The [`--strict`](https://www.mkdocs.org/user-guide/configuration/#validation) flag will print out warnings and return a nonzero code if any of a number of checks fail (e.g. broken relative links, orphaned Markdown pages that are missing from the navigation sidebar, etc.). To see if your changes will pass these tests, run the following command locally:
```
$ make build-docs
```

### Working on documentation

* All commits must have a commit message
* Create your own branch from the `main` branch. For this writing we are using `YOURBRANCH` as an example:
* Create your own branch from the `main` branch. Here, we are using `YOURBRANCH` as an example:
```
$ cd user-guides
$ git fetch --all
Expand All @@ -64,7 +64,7 @@ $ git push -u origin YOURBRANCH
* Commit your changes to the remote repo:
```
$ cd user-guides
$ git status # check the status of the files you have editted
$ git status # check the status of the files you have edited
$ git commit -a -m "Updated docs" # preferably one issue per commit
$ git status # should say working tree clean
$ git push origin YOURBRANCH # push YOURBRANCH to origin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,19 @@ All computing carried out on the ALCF systems is associated with a user "account

If you need an account, visit the Accounts and Project Management website: [Request an account](https://my.alcf.anl.gov/accounts/#/accountRequest)

If you want to learn how to get started, visit the Get Started Guide: [Get Started Guide](https://www.alcf.anl.gov/support-center/get-started)
If you want to learn how to get started, visit the [Get Started Guide](https://www.alcf.anl.gov/support-center/get-started)

## Who Can Get an Account
Those who are interested in having an account on an ALCF resource must first request an allocation and provide a detailed description of the work, including computational requirements and coding capabilities for the Blue Gene platform. Another means of acquiring an allocation on the ALCF system is to be part of a project team that already has an active allocation. Once an allocation has been granted, new users should complete an account request. A project’s Principal Investigator (PI) must sponsor these accounts—if the PI is the user, an ALCF staff member must serve as sponsor. Sponsors are asked annually to evaluate the accounts they have sponsored to determine whether or not these accounts should be kept active.

Those who are interested in having an account on an ALCF resource must first request an allocation and provide a detailed description of the work, including computational requirements and coding capabilities for the Blue Gene platform.
Alternatively, one may be part of a project team that already has an active allocation. Once an allocation has been granted, new users should complete an account request. A project’s Principal Investigator (PI) must sponsor these accounts—if the PI is the user, an ALCF staff member must serve as sponsor. Sponsors are asked annually to evaluate the accounts they have sponsored to determine whether or not these accounts should be kept active.

## Account Abilities

A user with an active account can log in to the ALCF login servers (e.g., polaris.alcf.anl.gov). This account will have some home directory space, where file transfer can occur from that space via the login nodes, and where development activities, such as editing and compiling, can also occur.

## Account States

Accounts are classified in one of the following categories:

- **Pending:** An account that has been requested but has not yet been created.
Expand All @@ -21,6 +25,7 @@ Accounts are classified in one of the following categories:
- **Deleted:** An account that existed on the system and is thus in the records and backups, but whose user no longer has access to the systems or files on disk.

## More Information

- [Account Policy](../../policies/accounts/accounts-policy.md)
- [User Authentication Policy](../../policies/accounts/user-authentication-policy.md)
- [Account Sponsorship and Retention Policy](../../policies/accounts/account-sponsorship-retention-policy.md)
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ For information on how to run the query, look at our documentation on our [sbank

To determine which platforms have an active balance, check our allocation accounting system [sbank](sbank-allocation-accounting-system.md).

- To obtain the allocation balance, check the sbank command [sbank-list-allocations](not_in_nav/sbank-list-allocations.md).
- DD projects with a negative balance will not be able to run jobs until they have requested additional time; see Getting more time below.
- To obtain the allocation balance, check the `sbank` command [sbank-list-allocations](not_in_nav/sbank-list-allocations.md).
- DD projects with a negative balance will not be able to run jobs until they have requested additional time; see the "Getting More Time" subsection below.
- INCITE and ALCC PIs automatically receive an email summary of project usage. If this is a DD project, please email [[email protected]](mailto:[email protected]).

## Allocation Expiration

Projects and allocations at the ALCF are different. A particular project might have multiple allocations of time. For example, a discretionary project that has been approved more than 3 times will have 3 allocations (2 are probably expired) but just one project. Projects will not expire, allocations will. If allocations are expired, or have no hours left, jobs will not be able to run. Use the two bullets above (Checking for an active allocation and Determining the balance of an allocation) to determine active allocations.
Projects and allocations at the ALCF are different. A particular project might have multiple allocations of time. For example, a discretionary project that has been approved more than three times will have three allocations
(two are probably expired) but just one project. Projects will not expire -- allocations will. If allocations are expired, or have no hours left, jobs will not be able to run. Consult the two above sections
to determine active allocations.

## Getting More Time

Expand All @@ -42,7 +44,9 @@ PI creates suballocations
sbank new sub <allocationid> --name <nameofsuballoc>
```

*Tip: see `sbank new suballocation -h` for all the options.*
!!! tip inline end

See `sbank new suballocation -h` for all the options.

**Step 2: Manage Suballocations (Project PI)**

Expand Down Expand Up @@ -85,6 +89,7 @@ sbank e sub <projectname>::<nameofsuballoc> --hours-to-move <hours> --to-suballo
```

!!! note

`hours-to-move` must be greater than or equal to the available balance for the suballocation `nameofsuballoc`.

!!! tip inline end
Expand All @@ -111,4 +116,6 @@ List all suballocations for a project that shows the number of jobs run, charges
sbank-list-allocations -r polaris -p <projectname> -f "+subname users_list"
```

*Tip: see `sbank l a -h` for all the options and `sbank –f\?` for a list of fields that can be displayed.*
!!! tip

See `sbank l a -h` for all the options and `sbank –f\?` for a list of fields that can be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The PI or Proxy must approve each member of the team to gain access and to run project jobs on the ALCF's resources. If you have an active ALCF account, you can manage your project team by logging into the ALCF account and project management website and navigating to [https://my.alcf.anl.gov/](https://my.alcf.anl.gov/)

Project members will need to have an active ALCF user account to access project data and to run jobs on ALCF systems. See [Accounts and Access for your Project Members]{https://docs.alcf.anl.gov/account-project-management/project-management/starting-alcf-award/#accounts-and-access-for-your-project-members) for information on how team members can get an account, reactivate an account, or request to join your project.
Project members will need to have an active ALCF user account to access project data and to run jobs on ALCF systems. See [Accounts and Access for your Project Members](https://docs.alcf.anl.gov/account-project-management/project-management/starting-alcf-award/#accounts-and-access-for-your-project-members) for information on how team members can get an account, reactivate an account, or request to join your project.

## Accessing your project(s)
1. Log in at [https://my.alcf.anl.gov/](https://my.alcf.anl.gov/) using your credentials (ALCF username and Physical/Mobile token passcode one-time passcode).
Expand Down
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Our user guides contain information for:
- [Facility Policies](policies/facility-policies.md): Information on our policies and procedures.

## How to Get Access
Researchers interested in using the ALCF systems (including Polaris and the AI Testbed’s Cerebras CS-2 and SambaNova DataScale platforms) can now submit project proposals via the [ALCF’s Director’s Discretionary program](https://www.alcf.anl.gov/science/directors-discretionary-allocation-program). Calls for porposals for additional allocation programs will be open at a later date.
Researchers interested in using the ALCF systems (including Polaris and the AI Testbed’s Cerebras CS-2 and SambaNova DataScale platforms) can now submit project proposals via the [ALCF’s Director’s Discretionary program](https://www.alcf.anl.gov/science/directors-discretionary-allocation-program). Calls for proposals for additional allocation programs will be open at a later date.

Submit your proposal requests at: [Allocation Request Page](https://www.alcf.anl.gov/science/directors-discretionary-allocation-program)

## Getting Started
If you'd like to get started using our ALCF resources, our [Getting Started webpage](https://www.alcf.anl.gov/support-center/get-started) provides information on what you need to do in order to get time on our systems, get an account, and how to start running jobs.
If you'd like to get started using our ALCF resources, our [Getting Started page](https://www.alcf.anl.gov/support-center/get-started) provides information on what you need to do in order to get time on our systems, get an account, and how to start running jobs.

If you have an account and an award for Polaris, we suggest visiting on [Getting on Polaris webpage](polaris/getting-started.md).
If you have an account and an award for Polaris, we suggest visiting [Getting on Polaris](polaris/getting-started.md).

If you'd like to user our AI accelerators, visit our [Getting Started on AI Testbed webpage](https://argonne-lcf.github.io/ai-testbed-userdocs/#getting-started).
If you'd like to use our AI accelerators, visit [Getting Started on AI Testbed](https://argonne-lcf.github.io/ai-testbed-userdocs/#getting-started).

Please send feedback to [[email protected]](mailto:[email protected])
Loading