Joss edits #212

mdtanker · 2024-06-14T06:56:11Z

This is the main PR from edits resulting from submission to the Journal of Open Source Software (JOSS). The journal review is located at openjournals/joss-reviews#6502. This PR was originally #195, but was migrated here after some merge conflicts. This StackOverflow answer was helpful in fixing the merge conflicts:

This should drastically speed up testing, not overload GHA with downloading datasets, but means testing of fetch calls will need to be performed manual by deleting the local pooch cache and rerun all fetch calls / tests.

github-actions · 2024-06-14T07:30:51Z

🔔 Thank you for raising your pull request.
📦 If merged, this PR will release version 0.4.0-rc.1.

codecov · 2024-06-14T07:35:42Z

Codecov Report

Attention: Patch coverage is 5.10381% with 1097 lines in your changes missing coverage. Please review.

Project coverage is 9.93%. Comparing base (9a8ae51) to head (d4cf6b0).
Report is 257 commits behind head on main.

Files with missing lines	Patch %	Lines
src/polartoolkit/profiles.py	0.00%	539 Missing ⚠️
src/polartoolkit/maps.py	0.34%	286 Missing ⚠️
src/polartoolkit/fetch.py	4.73%	181 Missing ⚠️
src/polartoolkit/utils.py	29.68%	90 Missing ⚠️
src/polartoolkit/profile.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #212       +/-   ##
==========================================
- Coverage   35.43%   9.93%   -25.51%     
==========================================
  Files           6       7        +1     
  Lines        2627    3121      +494     
==========================================
- Hits          931     310      -621     
- Misses       1696    2811     +1115

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions · 2024-06-14T07:48:38Z

🔔 Thank you for raising your pull request.
📦 If merged, this PR will release version 0.4.0-rc.1.

github-actions · 2024-06-14T08:51:14Z

🔔 Thank you for raising your pull request.
📦 If merged, this PR will release version 0.4.0-rc.1.

github-actions · 2024-06-14T09:08:49Z

🔔 Thank you for raising your pull request.
📦 If merged, this PR will release version 0.4.0-rc.1.

github-actions · 2024-06-14T09:15:36Z

🔔 Thank you for raising your pull request.
📦 If merged, this PR will release version 0.4.0-rc.1.

github-actions · 2024-06-14T09:27:38Z

🔔 Thank you for raising your pull request.
📦 If merged, this PR will release version 0.4.0-rc.1.

…ural style of other modules. BREAKING CHANGE: please update all import statements to use `profiles` instead of `profile`!

github-actions · 2024-06-14T09:46:55Z

🔔 Thank you for raising your pull request.
📦 If merged, this PR will release version 0.4.0-rc.1.

github-actions · 2024-06-14T10:14:30Z

🔔 Thank you for raising your pull request.
📦 If merged, this PR will release version 0.4.0-rc.1.

mdtanker and others added 30 commits June 14, 2024 08:56

chore: increase timeout for test shen moho

0aad575

build: explicitly specify tqdm as dependency

de4298b

docs: update contributing guide

fd81ff9

chore: cleanup Make commands

65095bf

docs: simplify binder env

fa33bde

refactor: update np random number generator

ccb9b41

chore: update ruff version in pre-commit

53170ed

style: reformat with new ruff version

54fd4cd

docs: remove python version and nodefaults from binder env

73f7472

docs: fix issues with subplot_layout example

1b2a3d8

docs: try nbgitpull link for launch binder buttons

85d57ba

docs: switch binder env to separate repo, remove launch buttons

05dbdf2

docs: conform fetch walkthrough to standard figure creation style

5724805

chore: add tests for regions

0881b9d

style: fix regions test styling

b383fbb

style: add typing to function

1113209

docs: add available dataset gallery

e6978d9

docs: update dataset gallery template

4d6f666

docs: update bedmap2 dataset notebook

496866d

docs: add bedmachine dataset notebook

36ae2be

fix: remove faulty layer name from fetch bedmachine

9ab89cc

docs: mention dataset gallery in fetch walkthrough

44dcff4

docs: update references

76490ab

docs: add more dataset notebooks

86767ac

docs: reorganize available dataset gallery

88c00ba

chore: don't run tests on docs or style commits

ca6d0e7

feat: add Arctic/Greenland to utils/maps

02f750a

feat: add some Greenland regions

6b9bd9d

feat: add fetch MODIS Greenland

088b3f7

feat: add pen kwarg to show_region

6de294d

This was referenced Jun 14, 2024

[REVIEW]: PolarToolkit: Python Tools for Convenient, Reproducible, and Open Polar Science openjournals/joss-reviews#6502

Closed

Problems with the use of "plot_grd" function of the module "maps" #207

Closed

This was linked to issues Jun 14, 2024

Clarify use and data types in docs #202

Closed

Issues related to the description of region and box parameters #180

Closed

mdtanker mentioned this pull request Jun 14, 2024

Use environment variables to define which hemisphere to default to #208

Closed

This was linked to issues Jun 14, 2024

Problems with the use of "plot_grd" function of the module "maps" #207

Closed

Use environment variables to define which hemisphere to default to #208

Closed

mdtanker added 3 commits June 14, 2024 09:23

chore: add fetch mark to some tests

ed94337

chore: don't run fetch calls during test

8581461

This should drastically speed up testing, not overload GHA with downloading datasets, but means testing of fetch calls will need to be performed manual by deleting the local pooch cache and rerun all fetch calls / tests.

docs: spelling mistake

f827c8a

chore: remove pip local install in testing CI

5888ced

mdtanker force-pushed the joss-edits branch from 6a86005 to a75e46e Compare June 14, 2024 09:07

chore: switch CI from mini-conda to micromamba

43e4ced

mdtanker force-pushed the joss-edits branch from a75e46e to 43e4ced Compare June 14, 2024 09:13

chore: enable caching of test CI environment

4458622

refactor: change module name from profile to profiles to match pl…

03e248f

…ural style of other modules. BREAKING CHANGE: please update all import statements to use `profiles` instead of `profile`!

docs: typo and readme update

d4cf6b0

mdtanker merged commit c0ffc0c into main Jun 14, 2024
16 of 18 checks passed

mdtanker deleted the joss-edits branch June 14, 2024 10:58

This was referenced Jun 14, 2024

EarthDataDownloader object to retain user login credentials #200

Closed

Add caching to GitHub Actions for testing #133

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Joss edits #212

Joss edits #212

mdtanker commented Jun 14, 2024 •

edited

Loading

github-actions bot commented Jun 14, 2024

codecov bot commented Jun 14, 2024 •

edited

Loading

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

Joss edits #212

Joss edits #212

Conversation

mdtanker commented Jun 14, 2024 • edited Loading

github-actions bot commented Jun 14, 2024

codecov bot commented Jun 14, 2024 • edited Loading

Codecov Report

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

github-actions bot commented Jun 14, 2024

mdtanker commented Jun 14, 2024 •

edited

Loading

codecov bot commented Jun 14, 2024 •

edited

Loading