Skip to content

Commit fbe9ee5

Browse files
lee1043lee1043
authored
Merge branch 'main' into update_mov_run
2 parents 7c5c8f1 + e133c6c commit fbe9ee5

File tree

114 files changed

+3878
-64017
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+3878
-64017
lines changed

‎.github/DISCUSSION_TEMPLATE/2-questions.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
labels: [question]
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
Thanks for your interest in PMP! Please follow the template below to ensure the development team and community can help you effectively.
7+
8+
- type: checkboxes
9+
id: checks
10+
attributes:
11+
label: Question criteria
12+
description: Please confirm and check all the following options.
13+
options:
14+
- label: I added a descriptive title here.
15+
required: true
16+
- label: I searched the [PMP GitHub Discussions](https://github.com/PCMDI/pcmdi_metrics/discussions) to find a similar question and didn't find it.
17+
required: true
18+
- label: I searched the [PMP documentation](http://pcmdi.github.io/pcmdi_metrics/).
19+
required: true
20+
21+
- type: textarea
22+
id: your-question
23+
attributes:
24+
label: Describe your question
25+
description: |
26+
Please help the community help you. The more specific you can be, the easier it will be to help.
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: possible-answers
32+
attributes:
33+
label: Are there are any possible answers you came across?
34+
description: |
35+
This will help others determine if you're on the right track. Include links to pages you've researched (e.g., software docs, Stack Overflow posts).
36+
37+
- type: textarea
38+
id: sample-code
39+
attributes:
40+
label: Minimal Complete Verifiable Example (MVCE)
41+
description: |
42+
Minimal, self-contained copy-pastable example that generates the question/issue if possible. Please be concise with code posted (e.g., module imports, publicly accessible files).
43+
Examples that follow these guidelines are easier to parse. This section will be automatically formatted into code, so no need for markdown backticks.
44+
45+
See guidelines below on how to provide a good MCVE:
46+
47+
- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
48+
- [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
49+
render: python
50+
51+
- type: textarea
52+
id: log-output
53+
attributes:
54+
label: Relevant log output
55+
description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks.
56+
render: python
57+
58+
- type: textarea
59+
id: show-versions
60+
attributes:
61+
label: Environment
62+
description: |
63+
If an MVCE and log output was provided, share your PMP version and some other information if your environment here
64+
65+
- type: textarea
66+
id: extra
67+
attributes:
68+
label: Anything else we need to know?
69+
description: |
70+
Please describe any other information you want to share.

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Bug Report
2+
description: File a bug report to help us improve PMP
3+
title: "[Bug]: "
4+
labels: ["Type: Bug"]
5+
assignees: []
6+
body:
7+
- type: textarea
8+
id: what-happened
9+
attributes:
10+
label: What happened?
11+
description: |
12+
Thanks for reporting a bug! Please describe what you were trying to get done.
13+
Tell us what happened, what went wrong.
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: what-did-you-expect-to-happen
19+
attributes:
20+
label: What did you expect to happen? Are there are possible answers you came across?
21+
description: |
22+
Describe what you expected to happen. Include links to pages you've researched (e.g., software docs, Stack Overflow posts).
23+
validations:
24+
required: false
25+
26+
- type: textarea
27+
id: sample-code
28+
attributes:
29+
label: Minimal Complete Verifiable Example (MVCE)
30+
description: |
31+
Minimal, self-contained copy-pastable example that generates the issue if possible. Please be concise with code posted (e.g., module imports, publicly accessible files).
32+
Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly. This section will be automatically formatted into code, so no need for markdown backticks.
33+
34+
See guidelines below on how to provide a good MCVE:
35+
36+
- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
37+
- [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
38+
render: python
39+
40+
- type: textarea
41+
id: log-output
42+
attributes:
43+
label: Relevant log output
44+
description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks.
45+
render: python
46+
47+
- type: textarea
48+
id: extra
49+
attributes:
50+
label: Anything else we need to know?
51+
description: |
52+
Please describe any other information you want to share.
53+
54+
- type: textarea
55+
id: show-versions
56+
attributes:
57+
label: Environment
58+
description: |
59+
Please share some information about your environment.
60+
validations:
61+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Questions (PMP)
4+
url: https://github.com/PCMDI/pcmdi_metrics/discussions
5+
about: |
6+
Ask questions and discuss with other PMP community members here. Please
7+
browse the PMP Discussions Forum or PMP documentation first before asking a
8+
question to make sure it is not already answered. If you can't find an
9+
answer, please include a self-contained reproducible example with your
10+
question if possible. Thanks!
11+

‎.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Documentation Update
2+
description: Update PMP documentation
3+
title: "[Doc]: "
4+
labels: ["Type: Documentation"]
5+
assignees: []
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Describe your documentation update
11+
description: |
12+
Concise description of why the documentation is being updated (e.g., missing content for new feature, typo)
13+
If this is related to an issue or PR, please mention it.
14+
validations:
15+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Feature Request
2+
description: Suggest an idea for PMP
3+
title: "[Feature]: "
4+
labels: ["Type: Enhancement"]
5+
assignees: []
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Is your feature request related to a problem?
11+
description: |
12+
Please do a quick search of existing issues to make sure that this has not been asked before.
13+
Please provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: solution
19+
attributes:
20+
label: Describe the solution you'd like
21+
description: |
22+
A clear and concise description of what you want to happen.
23+
validations:
24+
required: false
25+
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Describe alternatives you've considered
30+
description: |
31+
A clear and concise description of any alternative solutions or features you've considered.
32+
validations:
33+
required: false
34+
35+
- type: textarea
36+
id: additional-context
37+
attributes:
38+
label: Additional context
39+
description: |
40+
Add any other context about the feature request here.
41+
validations:
42+
required: false

‎.github/workflows/build_workflow.yml

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ on:
99

1010
workflow_dispatch:
1111

12+
env:
13+
CANCEL_OTHERS: true
14+
PATHS_IGNORE: '["**/README.rst", "**/docs/**", "**/ISSUE_TEMPLATE/**", "**/pull_request_template.md", "**/.vscode/**"]'
15+
1216
jobs:
1317
check-jobs-to-skip:
1418
runs-on: ubuntu-latest
@@ -27,25 +31,16 @@ jobs:
2731
runs-on: ubuntu-latest
2832
timeout-minutes: 10
2933
steps:
30-
- uses: actions/setup-node@v3
31-
with:
32-
node-version: '16'
3334
- name: Checkout Code Repository
3435
uses: actions/checkout@v3
35-
with:
36-
node-version: '16'
36+
3737
- name: Set up Python
3838
uses: actions/setup-python@v4
3939
with:
40-
node-version: '16'
4140
python-version: '3.10'
42-
# Run all pre-commit hooks on all the files.
43-
# Getting only staged files can be tricky in case a new PR is opened
44-
# since the action is run on a branch in detached head state
41+
4542
- name: Install and Run Pre-commit
4643
uses: pre-commit/action@v3.0.0
47-
with:
48-
node-version: '16'
4944

5045
build:
5146
needs: check-jobs-to-skip
@@ -56,9 +51,6 @@ jobs:
5651
shell: bash -l {0}
5752
timeout-minutes: 10
5853
steps:
59-
- uses: actions/setup-node@v3
60-
with:
61-
node-version: '16'
6254
- uses: actions/checkout@v3
6355

6456
- name: Set up Conda Environment
@@ -82,7 +74,6 @@ jobs:
8274
- name: Cache Conda
8375
uses: actions/cache@v3
8476
with:
85-
node-version: '16'
8677
path: ${{ env.CONDA }}/envs
8778
key:
8879
conda-${{ runner.os }}--${{ runner.arch }}--${{

‎.pre-commit-config.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration file for `pre-commit` tool.
22
# Source: https://pre-commit.com/#pre-commit-configyaml---top-level
3-
exclude: "docs|node_modules|migrations|.git|.tox|.md|sample_setups/(external-setups|jsons)|tests/deprecated"
3+
exclude: "docs|node_modules|migrations|.git|.tox|README.md|sample_setups/(external-setups|jsons)|tests/deprecated"
44
default_stages: [commit]
55
fail_fast: true
66

@@ -20,16 +20,15 @@ repos:
2020
# Python code formatters
2121
# =======================
2222
- repo: https://github.com/psf/black
23-
rev: 23.1.0
23+
rev: 23.3.0
2424
hooks:
2525
- id: black
2626

27-
- repo: https://github.com/PyCQA/isort
27+
- repo: https://github.com/timothycrosley/isort
2828
rev: 5.12.0
2929
hooks:
3030
- id: isort
3131

32-
3332
# =======================
3433
# Python linting
3534
# =======================

‎.vscode/pcmdi_metrics.code-workspace

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// This file stores the pcmdi_metrics repository's VS Code workspace settings.
2+
// Simply open up this file in VS Code and the editor will be automatically configured using this file.
3+
// Workspace settings take precedence over your user settings.
4+
{
5+
"folders": [
6+
{
7+
"path": ".."
8+
}
9+
],
10+
"settings": {
11+
// ===================
12+
// Editor settings
13+
// ===================
14+
"editor.formatOnSave": true,
15+
// ===================
16+
// Python settings
17+
// ===================
18+
"[python]": {
19+
// editor.rulers: [comments, max line length, wrap line length],
20+
// Black does not wrap comments.
21+
"editor.rulers": [80, 88, 120],
22+
"editor.wordWrap": "wordWrapColumn",
23+
"editor.wordWrapColumn": 120,
24+
"editor.defaultFormatter": "ms-python.black-formatter"
25+
},
26+
"black-formatter.importStrategy": "fromEnvironment",
27+
// Code Formatting and Linting
28+
// ---------------------------
29+
"flake8.args": ["--config=setup.cfg"],
30+
"flake8.importStrategy": "fromEnvironment",
31+
// Type checking
32+
// ---------------------------
33+
"mypy-type-checker.args": ["--config=pyproject.toml"],
34+
"mypy-type-checker.importStrategy": "fromEnvironment",
35+
// Testing
36+
// ---------------------------
37+
"python.testing.unittestEnabled": false,
38+
"python.testing.pytestEnabled": true,
39+
// NOTE: Debugger doesn't work if pytest-cov is enabled, so set "--no-cov"
40+
// https://github.com/microsoft/vscode-python/issues/693
41+
"python.testing.pytestArgs": ["--no-cov"],
42+
// ===================
43+
// Extension settings
44+
// ===================
45+
"jupyter.notebookFileRoot": "${workspaceFolder}",
46+
"autoDocstring.docstringFormat": "numpy",
47+
"[restructuredtext]": {
48+
"editor.rulers": [88, 120],
49+
"editor.wordWrap": "wordWrapColumn",
50+
"editor.wordWrapColumn": 120
51+
}
52+
}
53+
}

0 commit comments

Comments
 (0)