roms-tools 0.20__tar.gz → 1.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. {roms_tools-0.20 → roms_tools-1.0.1}/.github/workflows/pre-commit.yaml +2 -2
  2. {roms_tools-0.20 → roms_tools-1.0.1}/.github/workflows/pypipublish.yaml +7 -6
  3. {roms_tools-0.20 → roms_tools-1.0.1}/.github/workflows/tests.yaml +2 -1
  4. {roms_tools-0.20/roms_tools.egg-info → roms_tools-1.0.1}/PKG-INFO +6 -2
  5. {roms_tools-0.20 → roms_tools-1.0.1}/README.md +4 -1
  6. {roms_tools-0.20 → roms_tools-1.0.1}/ci/environment.yml +1 -0
  7. {roms_tools-0.20 → roms_tools-1.0.1}/docs/api.rst +3 -4
  8. roms_tools-1.0.1/docs/boundary_forcing.ipynb +23106 -0
  9. {roms_tools-0.20 → roms_tools-1.0.1}/docs/index.rst +2 -2
  10. roms_tools-1.0.1/docs/initial_conditions.ipynb +12042 -0
  11. {roms_tools-0.20 → roms_tools-1.0.1}/docs/methods.rst +13 -2
  12. roms_tools-1.0.1/docs/surface_forcing.ipynb +10576 -0
  13. {roms_tools-0.20 → roms_tools-1.0.1}/docs/tides.ipynb +39 -39
  14. {roms_tools-0.20 → roms_tools-1.0.1}/pyproject.toml +1 -0
  15. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/__init__.py +1 -2
  16. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/_version.py +1 -1
  17. roms_tools-1.0.1/roms_tools/setup/boundary_forcing.py +757 -0
  18. roms_tools-1.0.1/roms_tools/setup/datasets.py +1154 -0
  19. roms_tools-1.0.1/roms_tools/setup/download.py +118 -0
  20. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/setup/initial_conditions.py +195 -166
  21. roms_tools-1.0.1/roms_tools/setup/mixins.py +395 -0
  22. roms_tools-1.0.1/roms_tools/setup/surface_forcing.py +596 -0
  23. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/setup/tides.py +76 -174
  24. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/setup/topography.py +1 -1
  25. roms_tools-1.0.1/roms_tools/setup/utils.py +352 -0
  26. roms_tools-1.0.1/roms_tools/tests/test_boundary_forcing.py +706 -0
  27. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/tests/test_datasets.py +73 -9
  28. roms_tools-1.0.1/roms_tools/tests/test_initial_conditions.py +520 -0
  29. roms_tools-1.0.1/roms_tools/tests/test_surface_forcing.py +2622 -0
  30. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/tests/test_tides.py +13 -14
  31. roms_tools-1.0.1/roms_tools/tests/test_utils.py +16 -0
  32. {roms_tools-0.20 → roms_tools-1.0.1/roms_tools.egg-info}/PKG-INFO +6 -2
  33. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools.egg-info/SOURCES.txt +6 -4
  34. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools.egg-info/requires.txt +1 -0
  35. roms_tools-0.20/docs/atmospheric_forcing.ipynb +0 -9332
  36. roms_tools-0.20/docs/boundary_forcing.ipynb +0 -7099
  37. roms_tools-0.20/docs/forcings/bdry_forcing.nc +0 -0
  38. roms_tools-0.20/docs/initial_conditions.ipynb +0 -4477
  39. roms_tools-0.20/roms_tools/setup/atmospheric_forcing.py +0 -935
  40. roms_tools-0.20/roms_tools/setup/boundary_forcing.py +0 -711
  41. roms_tools-0.20/roms_tools/setup/datasets.py +0 -457
  42. roms_tools-0.20/roms_tools/setup/utils.py +0 -162
  43. roms_tools-0.20/roms_tools/tests/test_atmospheric_forcing.py +0 -1645
  44. roms_tools-0.20/roms_tools/tests/test_boundary_forcing.py +0 -332
  45. roms_tools-0.20/roms_tools/tests/test_initial_conditions.py +0 -300
  46. {roms_tools-0.20 → roms_tools-1.0.1}/.github/workflows/sphinx.yaml +0 -0
  47. {roms_tools-0.20 → roms_tools-1.0.1}/.gitignore +0 -0
  48. {roms_tools-0.20 → roms_tools-1.0.1}/.pre-commit-config.yaml +0 -0
  49. {roms_tools-0.20 → roms_tools-1.0.1}/.readthedocs.yaml +0 -0
  50. {roms_tools-0.20 → roms_tools-1.0.1}/LICENSE +0 -0
  51. {roms_tools-0.20 → roms_tools-1.0.1}/coverage.toml +0 -0
  52. {roms_tools-0.20 → roms_tools-1.0.1}/docs/Makefile +0 -0
  53. {roms_tools-0.20 → roms_tools-1.0.1}/docs/_templates/autosummary/class.rst +0 -0
  54. {roms_tools-0.20 → roms_tools-1.0.1}/docs/conf.py +0 -0
  55. {roms_tools-0.20 → roms_tools-1.0.1}/docs/grid.ipynb +0 -0
  56. {roms_tools-0.20 → roms_tools-1.0.1}/docs/images/Step1.png +0 -0
  57. {roms_tools-0.20 → roms_tools-1.0.1}/docs/images/Step2.png +0 -0
  58. {roms_tools-0.20 → roms_tools-1.0.1}/docs/images/Step3.png +0 -0
  59. {roms_tools-0.20 → roms_tools-1.0.1}/docs/images/Step4.png +0 -0
  60. {roms_tools-0.20 → roms_tools-1.0.1}/docs/installation.rst +0 -0
  61. {roms_tools-0.20 → roms_tools-1.0.1}/docs/make.bat +0 -0
  62. {roms_tools-0.20 → roms_tools-1.0.1}/docs/references.bib +0 -0
  63. {roms_tools-0.20 → roms_tools-1.0.1}/docs/references.rst +0 -0
  64. {roms_tools-0.20 → roms_tools-1.0.1}/docs/support.rst +0 -0
  65. {roms_tools-0.20 → roms_tools-1.0.1}/docs/vertical_coordinate.ipynb +0 -0
  66. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/setup/__init__.py +0 -0
  67. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/setup/fill.py +0 -0
  68. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/setup/grid.py +0 -0
  69. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/setup/plot.py +0 -0
  70. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/setup/vertical_coordinate.py +0 -0
  71. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/tests/test_grid.py +0 -0
  72. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/tests/test_topography.py +0 -0
  73. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools/tests/test_vertical_coordinate.py +0 -0
  74. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools.egg-info/dependency_links.txt +0 -0
  75. {roms_tools-0.20 → roms_tools-1.0.1}/roms_tools.egg-info/top_level.txt +0 -0
  76. {roms_tools-0.20 → roms_tools-1.0.1}/setup.cfg +0 -0
@@ -9,6 +9,6 @@ jobs:
9
9
  pre-commit:
10
10
  runs-on: ubuntu-latest
11
11
  steps:
12
- - uses: actions/checkout@v3
13
- - uses: actions/setup-python@v3
12
+ - uses: actions/checkout@v4
13
+ - uses: actions/setup-python@v4
14
14
  - uses: pre-commit/action@v3.0.1
@@ -38,7 +38,7 @@ jobs:
38
38
  git restore -SW .
39
39
  python -m build --sdist --wheel .
40
40
 
41
- - uses: actions/upload-artifact@v3
41
+ - uses: actions/upload-artifact@v4
42
42
  with:
43
43
  name: releases
44
44
  path: dist
@@ -51,7 +51,7 @@ jobs:
51
51
  name: Install Python
52
52
  with:
53
53
  python-version: '3.10'
54
- - uses: actions/download-artifact@v3
54
+ - uses: actions/download-artifact@v4
55
55
  with:
56
56
  name: releases
57
57
  path: dist
@@ -70,14 +70,15 @@ jobs:
70
70
  needs: test-built-dist
71
71
  if: github.event_name == 'release'
72
72
  runs-on: ubuntu-latest
73
+ permissions:
74
+ id-token: write
75
+ contents: read
73
76
  steps:
74
- - uses: actions/download-artifact@v3
77
+ - uses: actions/download-artifact@v4
75
78
  with:
76
79
  name: releases
77
80
  path: dist
78
81
  - name: Publish package to PyPI
79
82
  uses: pypa/gh-action-pypi-publish@v1.8.10
80
83
  with:
81
- username: "__token__"
82
- password: ${{ secrets.PYPI_API_TOKEN }}
83
- verbose: true
84
+ repository-url: https://upload.pypi.org/legacy/
@@ -28,6 +28,7 @@ jobs:
28
28
  environment-file: ci/environment.yml
29
29
  create-args: |
30
30
  python=${{ matrix.python-version }}
31
+ cache-key: micromamba-${{ matrix.python-version }}-${{ runner.os }} # Add a unique cache key
31
32
 
32
33
  - name: Conda info
33
34
  run: conda info
@@ -42,7 +43,7 @@ jobs:
42
43
  shell: bash -l {0}
43
44
  run: |
44
45
  python -V
45
- coverage run --rcfile=coverage.toml -m pytest --verbose roms_tools/tests/test_datasets.py roms_tools/tests/test_grid.py roms_tools/tests/test_topography.py roms_tools/tests/test_tides.py roms_tools/tests/test_atmospheric_forcing.py roms_tools/tests/test_initial_conditions.py roms_tools/tests/test_vertical_coordinate.py roms_tools/tests/test_boundary_forcing.py
46
+ coverage run --rcfile=coverage.toml -m pytest --verbose roms_tools/tests/test_datasets.py roms_tools/tests/test_grid.py roms_tools/tests/test_topography.py roms_tools/tests/test_tides.py roms_tools/tests/test_surface_forcing.py roms_tools/tests/test_initial_conditions.py roms_tools/tests/test_vertical_coordinate.py roms_tools/tests/test_boundary_forcing.py roms_tools/tests/test_utils.py
46
47
 
47
48
  - name: Get coverage report
48
49
  shell: bash -l {0}
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: roms-tools
3
- Version: 0.20
3
+ Version: 1.0.1
4
4
  Summary: Tools for running and analysing UCLA-ROMS simulations
5
5
  Author-email: Nora Loose <nora.loose@gmail.com>, Thomas Nicholas <tom@cworthy.org>
6
6
  License: Apache-2
@@ -19,6 +19,7 @@ Requires-Python: >=3.10
19
19
  Description-Content-Type: text/markdown
20
20
  License-File: LICENSE
21
21
  Requires-Dist: xarray>=2022.6.0
22
+ Requires-Dist: xarray-datatree
22
23
  Requires-Dist: numpy
23
24
  Requires-Dist: netcdf4
24
25
  Requires-Dist: pooch
@@ -31,9 +32,12 @@ Requires-Dist: numba
31
32
 
32
33
  # ROMS-Tools
33
34
 
35
+ [![PyPI version](https://badge.fury.io/py/roms-tools.svg)](https://badge.fury.io/py/roms-tools)
34
36
  [![codecov](https://codecov.io/gh/CWorthy-ocean/roms-tools/graph/badge.svg?token=5S1oNu39xE)](https://codecov.io/gh/CWorthy-ocean/roms-tools)
35
37
  [![Documentation Status](https://readthedocs.org/projects/roms-tools/badge/?version=latest)](https://roms-tools.readthedocs.io/en/latest/?badge=latest)
36
- [![PyPI version](https://badge.fury.io/py/roms-tools.svg)](https://badge.fury.io/py/roms-tools)
38
+ ![Run Tests](https://github.com/CWorthy-ocean/roms-tools/actions/workflows/tests.yaml/badge.svg)
39
+ ![Supported Python Versions](https://img.shields.io/pypi/pyversions/roms-tools)
40
+
37
41
 
38
42
  ## Overview
39
43
 
@@ -1,8 +1,11 @@
1
1
  # ROMS-Tools
2
2
 
3
+ [![PyPI version](https://badge.fury.io/py/roms-tools.svg)](https://badge.fury.io/py/roms-tools)
3
4
  [![codecov](https://codecov.io/gh/CWorthy-ocean/roms-tools/graph/badge.svg?token=5S1oNu39xE)](https://codecov.io/gh/CWorthy-ocean/roms-tools)
4
5
  [![Documentation Status](https://readthedocs.org/projects/roms-tools/badge/?version=latest)](https://roms-tools.readthedocs.io/en/latest/?badge=latest)
5
- [![PyPI version](https://badge.fury.io/py/roms-tools.svg)](https://badge.fury.io/py/roms-tools)
6
+ ![Run Tests](https://github.com/CWorthy-ocean/roms-tools/actions/workflows/tests.yaml/badge.svg)
7
+ ![Supported Python Versions](https://img.shields.io/pypi/pyversions/roms-tools)
8
+
6
9
 
7
10
  ## Overview
8
11
 
@@ -9,6 +9,7 @@ dependencies:
9
9
  - matplotlib
10
10
  - cartopy
11
11
  - xarray
12
+ - xarray-datatree
12
13
  - netcdf4
13
14
  - pooch
14
15
  - packaging
@@ -26,14 +26,13 @@ Tidal Forcing
26
26
 
27
27
  roms_tools.TidalForcing
28
28
 
29
- Atmospheric Forcing
30
- --------------------
29
+ Surface Forcing
30
+ ----------------
31
31
 
32
32
  .. autosummary::
33
33
  :toctree: generated/
34
34
 
35
- roms_tools.AtmosphericForcing
36
- roms_tools.SWRCorrection
35
+ roms_tools.SurfaceForcing
37
36
 
38
37
  Initial Conditions
39
38
  --------------------