Skip to content
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
92 changes: 92 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
name: Bug Report
description: Create a report about an error to help us improve

type: bug
body:
- type: markdown
attributes:
value: >
Thanks for taking the time to contribute to icepyx by filling out this bug report! We appreciate
your help in improving icepyx and making data more accessible.

- type: textarea
id: what-happened
attributes:
label: Describe the bug
description: |
A clear and concise description of what the problem is. In 1-3 sentences, summarize what you were
trying to accomplish and what happened instead.
placeholder: |
Example: While attempting to download 2 granules using `region.download_granules()` I got an error
informing me that I needed to login, but I had already provided my login information.

Example: While searching for data using `ipx.Query()` using the `spatial_extent` filter but upon
opening my files I see that some of the granules are located outside the specified spatial extent.
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: |
A clear and concise description of what you expected to happen.
placeholder: |
I expected 12 granules. The granules ids I expected were ...

- type: textarea
id: sample-code
attributes:
label: Reproducible Example
description: >
Minimal, contained code snippet that describes the problem (also known as an MRE, or Minimal Reproducible Example).
See more about creating MREs [here](https://matthewrocklin.com/minimal-bug-reports/#do_3). If you're not sure how to
create an MRE just paste your best version of an MRE and we will discuss your example in the issue comments. Be
sure to include granule ids if your issue pertains to a specific granule.

This will be automatically formatted into code, so no need for markdown backticks.
render: Python
value: |
import icepyx as ipx

# your minimal reproducible code ...

- type: input
id: version
attributes:
label: Version
description: |
What version of icepyx are you using?

If you're not sure what version of icepyx you're using, run `ipx.__version__` from a Python file
after importing icepyx
placeholder: v2.0.1

- type: input
id: sys-info
attributes:
label: System Information
description: What type of operating system are you using?
placeholder: Ex. Apple, Dell, Cryocloud, ...

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

- type: textarea
id: screenshots
attributes:
label: screenshots
description: If applicable, add screenshots to help explain your problem.

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://icepyx.readthedocs.io/en/latest/contributing/code_of_conduct_link.html).
options:
- label: I agree to follow this project's Code of Conduct
required: true
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Feature request
description: Suggest an idea for a new icepyx feature

type: bug
body:
- type: markdown
attributes:
value: >
Thanks for taking the time to contribute to icepyx by requesting a feature! We appreciate
your help in improving icepyx and making data more accessible.

- type: textarea
id: feature-description
attributes:
label: Is your feature request related to a problem? Please describe.
description: |
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true

- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: |
A clear and concise description of what you want to happen.

- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: |
A clear and concise description of any alternative solutions or features you've considered.

- type: textarea
id: context
attributes:
label: Additional context
description: |
Add any other context or screenshots about the feature request here.

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://icepyx.readthedocs.io/en/latest/contributing/code_of_conduct_link.html).
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion .github/workflows/get_pypi_stats.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: "traffic"

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/integration_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ jobs:
exit 1

- name: "Checkout source"
uses: "actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8" # v5.0.0
uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
with:
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: "3.12"

Expand All @@ -72,6 +72,6 @@ jobs:
# pytest icepyx/tests/integration --verbose --cov app -m "[not] downloads_data"

- name: "Upload coverage report"
uses: "codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7" # v5.5.1
uses: "codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de" # v5.5.2
with:
token: "${{ secrets.CODECOV_TOKEN }}"
4 changes: 2 additions & 2 deletions .github/workflows/linter_actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

# Use the Ruff linter to annotate code style / best-practice issues
# NOTE: More config provided in pyproject.toml
- name: Lint and annotate PR
uses: astral-sh/ruff-action@57714a7c8a2e59f32539362ba31877a1957dded1 # v3.5.1
uses: astral-sh/ruff-action@4919ec5cf1f49eff0871dbcea0da843445b837e6 # v3.6.1
10 changes: 5 additions & 5 deletions .github/workflows/publish_to_pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
# fetch all history so that setuptools-scm works
fetch-depth: 0
persist-credentials: false

- name: Set up Python
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: '3.11'

Expand All @@ -52,7 +52,7 @@ jobs:
ls -lh dist/

- name: Store the distribution packages
uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: python-package-distributions
path: dist/
Expand All @@ -72,7 +72,7 @@ jobs:

steps:
- name: Download all the dists
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
with:
name: python-package-distributions
path: dist/
Expand All @@ -96,7 +96,7 @@ jobs:

steps:
- name: Download all the dists
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
with:
name: python-package-distributions
path: dist/
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/traffic_action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: "traffic"

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/typecheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0

- uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: "3.11"

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/uml_action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: ${{ github.event.pull_request.head.ref }}
- name: set up environment
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/unit_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ jobs:
matrix:
python-version: ["3.11", "3.13"] #NOTE: min and max Python versions supported by icepyx
steps:
- uses: "actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8" # v5.0.0
- uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
with:
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: "${{ matrix.python-version }}"

Expand All @@ -46,9 +46,9 @@ jobs:

- name: "Run tests"
run: |
pytest icepyx/tests/unit --verbose --cov app
pytest icepyx/tests/unit --verbose --doctest-modules icepyx/core --cov app

- name: "Upload coverage report"
uses: "codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7" # v5.5.1
uses: "codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de" # v5.5.2
with:
token: "${{ secrets.CODECOV_TOKEN }}"
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ repos:
- tomli

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.14.3
rev: v0.15.4
hooks:
- id: ruff
args: ["--fix", "--show-fixes"]
- id: ruff-format

- repo: https://github.com/abravalheri/validate-pyproject
rev: v0.24.1
rev: v0.25
hooks:
- id: validate-pyproject

Expand Down
18 changes: 16 additions & 2 deletions doc/source/tracking/citations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,19 @@ Peer-reviewed publications about icepyx software
.. bibliography:: icepyx_pubs.bib
:style: mystyle

joss2023
quest2025
joss2023


icepyx in the open-source landscape

.. bibliography:: icepyx_pubs.bib
:style: mystyle

chudley2024
tankersley2024
Bednar2023
Shean2023

Presentations and Materials Featuring icepyx
--------------------------------------------
Expand All @@ -43,8 +47,10 @@ Presentations that feature or explain icepyx
.. bibliography:: icepyx_pubs.bib
:style: mystyle

2024_IS2HW
quest2023agu
selper2023
2023_IS2HW
js2022agu
2022_IS2-HW-tutorials
js2021agu
Expand All @@ -59,11 +65,19 @@ Research that utilizes icepyx for ICESat-2 data
.. bibliography:: icepyx_pubs.bib
:style: mystyle

al-attabi2026
narin2026
fair2025
leite2025
tian2025
eidam2024
golin2024
kamath2024
malambo2024
Tian2024
Freer2023
Idestrom2023
Mallinis2023
Shean2023
Snellink2023
Eidam2022
Leeuwen:2022
Expand Down
Loading
Loading