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

revamping credit request guide #176

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
154 changes: 97 additions & 57 deletions documentation/PATh/overview/account_setup/request-credits.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,80 +5,120 @@ path:

# Request PATh Facility Credits

All compute time on the PATh Facility is charged using a credit system.
All compute time on the PATh Facility is charged using a credit system.

If you have not already applied for a credit allocation at the time of requesting
an account, PATh staff can provide a small startup allocation for initial testing.
Credits are granted from the NSF and associated with the active project.
This guide details the process and templates available to request
credits.

After start up testing, credits
are granted from the NSF via the relevant program officer. This guide
details the process and templates available to request credits.
PATh staff can provide a small startup allocation at any time for
initial testing before a full credit request.

## Requirements

The opportunity to use PATh Facility resources is available to all PIs submitting, or having submitted, proposals to the
following Programs as per the [Dear Colleagues Letter][dear-colleague].
The opportunity to use PATh Facility resources is available to all PIs
submitting, or having submitted, proposals to the programs listed below:
[Program Officers](#program-officers)

## How to Apply

The [Dear Colleague Letter][dear-colleague]
describes the request process. Researchers are asked to draft a credit request,
and do one of the following:
* **New Proposals:** As documented in the [PAPPG 24-1, Ch 2, section E.7](https://new.nsf.gov/policies/pappg/24-1/ch-2-proposal-preparation#ch2E7),
projects can request credits as part of the award process. Include the
request for HTC resources as a Supplementary Document attached to the
proposal (as described in the original DCL NSF 22-051).

- **New Proposals:** Include the request for HTC resources as a Supplementary Document.
- **Existing Awards:** Contact the NSF cognizant program officer of their project by e-mail, with the description of their HTC resource request. Please include "HTCAccess" and the award number for the funded project in the e-mail subject line.
* **Existing Awards:** Email the NSF cognizant program officer of their
project, and copy [email protected], with the description of
their HTC resource request. Please include "HTCAccess" and the award
number for the funded project in the e-mail subject line.

### Sample Credit Request

The credit request is described in the [Dear Colleague letter][dear-colleague] and should include:
The credit request should include:

> (1) the anticipated total HTC resources required, with yearly breakdown; and (2) a technical description and justification for the request. The latter should include information regarding (a) the expected number of self-contained tasks per ensemble ‒ note that each task can be packaged into one or more batch job(s); (b) the resource requirements for each task type in the ensemble ‒ for example, requirements for cores, memory, wall-time, and scratch space; (c) the expected number of ensembles; (d) the expected input and output data requirements for each task type; and (e) the expected number and size of shared input files within an ensemble – expected number of times each file is read per ensemble.
> (1) the anticipated total HTC resources required, with yearly breakdown;
> and (2) a technical description and justification for the request. The
> latter should include information regarding (a) the expected number of
> self-contained tasks per ensemble ‒ note that each task can be packaged
> into one or more batch job(s); (b) the resource requirements for each
> task type in the ensemble ‒ for example, requirements for cores, memory,
> wall-time, and scratch space; (c) the expected number of ensembles; (d)
> the expected input and output data requirements for each task type; and
> (e) the expected number and size of shared input files within an
> ensemble – expected number of times each file is read per ensemble.

This should be no more than two pages. The Research Facilitation team has assembled a
template credit request for you to use as a starting point, in this folder:
This should be no more than two pages. The Research Facilitation team
has assembled a template credit request for you to use as a starting
point: [Template for NSF PATh Credit Requests](https://docs.google.com/document/d/1aHnihTmrW_gprIy8K_60No343SBysNM0Tf1Lv1ZpY7o/)

[PATh Facility Allocation Templates][templates]
## How Many Credits?

If you are not sure how many credits to request for your allocation, please do one
or more of the following:
If you are not sure how many credits to request for your allocation, please
do one or more of the following:

- Request an account and startup allocation on the PATh Facility to run test jobs and determine resource needs and possible scale: [Getting Started](../getting-started/)
- Use the credit guide and worksheet linked below: [PATh Facility Credit Guide](#path-facility-credit-guide)
- Contact the PATh Facility team at [email protected]
* Use the credit calculator developed by the Facilitation team:
* Go to the sample credit calculator here: [PATh Facility Credit Calculator](https://docs.google.com/spreadsheets/d/1HLW2HETHiWAGxr4_qs6rEovPrZthkJlLoDpgRPKmrF4/)
* Follow the instructions in the calculator - make a copy and fill in information
about your jobs and ensembles to generate a credit estimate.
* Contact the PATh Facility team at [email protected]
* Request an account and startup allocation on the PATh Facility to run test
jobs and determine resource needs and possible scale: [Getting Started](https://portal.path-cc.io/documentation/overview/account_setup/getting-started/)

### Program Officers

Requests can be submitted to the following program officers, based on domain:

* [Computational and Data-Enabled Science and Engineering](https://beta.nsf.gov/funding/opportunities/computational-and-data-enabled-science-and-engineering-cdse-0) (CDS&E), NSF, PO: Christina Payne, [[email protected]](mailto:[email protected])
* [Cyberinfrastructure for Sustained Scientific Innovation](https://beta.nsf.gov/funding/opportunities/cyberinfrastructure-sustained-scientific-innovation-cssi) (CSSI), CISE/OAC, PO: Tevfik Kosar, [[email protected]](mailto:[email protected])
* [Innovation: Bioinformatics](https://beta.nsf.gov/funding/opportunities/innovation-bioinformatics), BIO/DBI, PO: Jean X. Gao, [[email protected]](mailto:[email protected])
* [Neural Systems](https://beta.nsf.gov/funding/opportunities/neural-systems-0), BIO/IOS, PO: Evan Balaban, [[email protected]](mailto:[email protected])
* [Collaborative Research in Computational Neuroscience](https://beta.nsf.gov/funding/opportunities/collaborative-research-computational-neuroscience-crcns) (CRCNS), CISE/IIS, PO: Kenneth Whang, [[email protected]](mailto:[email protected]) ‒ see also [NSF DCL 22-022](https://www.nsf.gov/publications/pub_summ.jsp?ods_key=nsf22022)
* [Astronomy and Astrophysics Research Grants](https://beta.nsf.gov/funding/opportunities/astronomy-and-astrophysics-research-grants-aag) (AAG), MPS/AST, PO: Andreas Berlind, [[email protected]](mailto:[email protected])
* [Chemical Theory, Models, and Computational Methods](https://beta.nsf.gov/funding/opportunities/chemical-theory-models-and-computational-methods-ctmc-0) (CTMC), MPS/CHE, PO: Richard Dawes, [[email protected]](mailto:[email protected])
* [Condensed Matter and Materials Theory](https://beta.nsf.gov/funding/opportunities/condensed-matter-and-materials-theory-cmmt-0) (CMMT), MPS/DMR, PO: Daryl Hess, [[email protected]](mailto:[email protected])
* [Atomic, Molecular and Optical Physics ‒ Theory](https://beta.nsf.gov/funding/opportunities/atomic-molecular-and-optical-physics-theory-0), MPS/PHY, PO: Robert Forrey, [[email protected]](mailto:[email protected])
* [Nuclear Physics ‒ Theory](https://beta.nsf.gov/funding/opportunities/nuclear-physics-theory-0), MPS/PHY, PO: Bogdan Mihaila, MPS/PHY, [[email protected]](mailto:[email protected])
* [Geoinformatics (GI),](https://beta.nsf.gov/funding/opportunities/geoinformatics-gi) GEO/EAR, PO: Raleigh Martin, [[email protected]](mailto:[email protected])
* [Geophysics (PH)](https://beta.nsf.gov/funding/opportunities/geophysics-ph-0), GEO/EAR, PO: Eva Zanzerkia, [[email protected]](mailto:[email protected])
* [Arctic Research Opportunities](https://beta.nsf.gov/funding/opportunities/arctic-research-opportunities), GEO/OPP, POs: Marc Stieglitz, [[email protected]](mailto:[email protected]), Allen Pope, [[email protected]](mailto:[email protected])
* [Antarctic Research](https://beta.nsf.gov/funding/opportunities/antarctic-research), GEO/OPP, PO: Allen Pope, [[email protected]](mailto:[email protected])

> More details can be found in the [Dear Colleagues Letter](https://www.nsf.gov/pubs/2022/nsf22051/nsf22051.jsp) provided by the NSF.

## PATh Facility Credit Guide
The current credit system is documented on this page: [PATh Facility Credit Charges](https://portal.path-cc.io/documentation/overview/references/credit-account-charges/).

For ease of calculating needed credits, the Research Facilitation team has provided
an excel worksheet tha can be used to interactively view how many credits are needed
for different job sizes. The spreadsheet is in this Google Drive folder:

[PATh Facility Allocation Templates][templates]

Download and open the spreadsheet and then follow the instructions.

The current credit system is documented on this page:
[PATh Facility Credit Charges](../../references/credit-account-charges/).
### Program Officers

[dear-colleague]: https://www.nsf.gov/pubs/2022/nsf22051/nsf22051.jsp
[templates]: https://drive.google.com/drive/u/0/folders/1Cy_tVnmrwLfg5oyZbWsW8VpCctuf14BC
Requests can be submitted to the following program officers, based on
domain:

* [Computational and Data-Enabled Science and
Engineering](https://beta.nsf.gov/funding/opportunities/computational-
and-data-enabled-science-and-engineering-cdse-0) (CDS&E), NSF, PO:
Christina Payne, [[email protected]](mailto:[email protected]) *
[Cyberinfrastructure for Sustained Scientific
Innovation](https://beta.nsf.gov/funding/opportunities/
cyberinfrastructure-sustained-scientific-innovation-cssi) (CSSI),
CISE/OAC, PO: Tevfik Kosar, [[email protected]](mailto:[email protected]) *
[Innovation:
Bioinformatics](https://beta.nsf.gov/funding/opportunities/innovation-
bioinformatics), BIO/DBI, PO: Jean X. Gao,
[[email protected]](mailto:[email protected]) * [Neural
Systems](https://beta.nsf.gov/funding/opportunities/neural-systems-0),
BIO/IOS, PO: Evan Balaban, [[email protected]](mailto:[email protected]) *
[Collaborative Research in Computational
Neuroscience](https://beta.nsf.gov/funding/opportunities/collaborative-
research-computational-neuroscience-crcns) (CRCNS), CISE/IIS, PO:
Kenneth Whang, [[email protected]](mailto:[email protected]) ‒ see also [NSF
DCL
22-022](https://www.nsf.gov/publications/pub_summ.jsp?ods_key=nsf22022)
* [Astronomy and Astrophysics Research
Grants](https://beta.nsf.gov/funding/opportunities/astronomy-and-
astrophysics-research-grants-aag) (AAG), MPS/AST, PO: Andreas Berlind,
[[email protected]](mailto:[email protected]) * [Chemical Theory, Models,
and Computational
Methods](https://beta.nsf.gov/funding/opportunities/chemical-theory-
models-and-computational-methods-ctmc-0) (CTMC), MPS/CHE, PO: Richard
Dawes, [[email protected]](mailto:[email protected]) * [Condensed Matter and
Materials
Theory](https://beta.nsf.gov/funding/opportunities/condensed-matter-and-
materials-theory-cmmt-0) (CMMT), MPS/DMR, PO: Daryl Hess,
[[email protected]](mailto:[email protected]) * [Atomic, Molecular and Optical
Physics ‒
Theory](https://beta.nsf.gov/funding/opportunities/atomic-molecular-and-
optical-physics-theory-0), MPS/PHY, PO: Robert Forrey,
[[email protected]](mailto:[email protected]) * [Nuclear Physics ‒
Theory](https://beta.nsf.gov/funding/opportunities/nuclear-physics-
theory-0), MPS/PHY, PO: Bogdan Mihaila, MPS/PHY,
[[email protected]](mailto:[email protected]) * [Geoinformatics
(GI),](https://beta.nsf.gov/funding/opportunities/geoinformatics-gi)
GEO/EAR, PO: Raleigh Martin, [[email protected]](mailto:[email protected])
* [Geophysics
(PH)](https://beta.nsf.gov/funding/opportunities/geophysics-ph-0),
GEO/EAR, PO: Eva Zanzerkia, [[email protected]](mailto:[email protected])
* [Arctic Research
Opportunities](https://beta.nsf.gov/funding/opportunities/arctic-
research-opportunities), GEO/OPP, POs: Marc Stieglitz,
[[email protected]](mailto:[email protected]), Allen Pope,
[[email protected]](mailto:[email protected]) * [Antarctic
Research](https://beta.nsf.gov/funding/opportunities/antarctic-research)
, GEO/OPP, PO: Allen Pope, [[email protected]](mailto:[email protected])
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@ path:

# Credit Account Charges

This page describes the specific credit charges for certain resources on the
[PATh Facility](https://path-cc.io/facility/). For details on how to request
credits for your project, see [Request PATh Facility Credits](../account-setup/request-credits)

Credits may be requested and used under the CPU Credit category or the GPU Credit category. Credits are
specific to each node type – CPU Credits are not transferable to GPU Credits, and vice-versa. CPU Credit charges
are defined by a combination of per-job cores and memory request, while GPU Credit charges are defined by a combination
of per-job GPU, CPU, and memory request.


## CPU Credits

|Cores per job|Credit charge per core hour|
Expand Down