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

Added MOCA Prepaid Invoice #124

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

QuanMPhm
Copy link
Contributor

Closes #87. This PR consists of the last commit. This invoice has custom filepaths for S3 and only lists projects belonging to prepay groups not managed by MGHPCC.

@joachimweyl Let me know if the file names or other specifications might have changed.

@joachimweyl
Copy link
Contributor

no chages from the doc since nov 19th

- ValidateBillablePIsProcessor
- NewPICreditProcessor
"""

INCLUDED_INSTITUTIONS = [
"Harvard University",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there any value in having universities here in a separate table we pull from so that they can more easily be added to?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know what would be a more appropriate place to store this kind of metadata. @knikolla Do you have a suggestion?

Copy link
Contributor

@knikolla knikolla Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joachimweyl @QuanMPhm seems like something that can be added to the institute_list.yaml for each institution under a specific key included_in_nerc_invoice and defaults to False.

Prepayments have been implemented by a new processor, `PrepaymentProcessor`.
The full implementation for prepayments involved the following changes:
- Several new columns names have been added to `invoices/invoice.py`,
including column names for the prepay data files and for the exported
invoices
- Many invoices will now export with 4 new columns: `Prepaid Group Name`,
`Prepaid Group Institution`, `Prepaid Group Balance`, `Prepaid Group Used`
- 4 command line arguments have been added to `process_report.py`.
3 of them allows the user to pass in a local version of the prepay credits,
contacts, and projects file. The last one (`—prepay-debits`) allows passing
a local version of the prepay debits files, and defaults to fetching from s3 if not
provided
- A set of test cases have been added for `PrepaymentProcessor`

Since the implementation of this feature required a lot of logic decisions
(i.e What happens if a prepaid project is active, but has no
funds?), below is (hopefully) an exhaustive list of code logic decisions
that were made. These can also be inferred through the test cases.
- Prepay projects listed in `prepaid_projects.csv` are identified by their
project name, not project - allocation name
- Attempting to process past invoices (“backprocessing”) may result in
incorrect output due to the nature of the prepay debit ledger
- While backprocessing is not supported for past months, processing
the same invoice month twice will still return correct output. In this
case, the month’s debit entry may be will be overwritten
- Prepay balances can be used in the same month they are added.
- The time range in which prepay projects are considered “active” includes
their start and end date
- After processing of any given invoice month, debit entries for that
month will be added. I emphasize this for clarification. A debit entry
such as:

`2024-11,G1,1062.48`

Should be interpreted as:
In the period from 2024-11-01 to 2024-11-30, prepay group G1 spent $1062.48
As opposed to:
In the period from 2024-10-01 to 2024-10-31, …

- If prepay projects are “active” but their prepay group has $0 balance,
their prepay info (group name, contact email) is still included, but the
prepay balance will be displayed as $0 and the prepay used as an empty field
…r` to `util`

Since these functions are now used in more than one location (`add_insti_proc`
and `prepay_proc`), it makes sense for them to be relocated to `util`

The test case checking institution-processing has changed slightly
This invoice has custom output filepaths for S3,
and only lists projects belonging to prepay groups not
managed by MGHPCC
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate MOCA Prepaid Group CSV
3 participants