SalishSeaNowcast

Python package associated with running the SalishSeaCast NEMO and other ocean models in near-real-time to produce daily nowcasts/forecasts

https://github.com/SalishSeaCast/SalishSeaNowcast

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    12 of 19 committers (63.2%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (6.8%) to scientific vocabulary

Keywords

automation ocean-modelling oceanography salishsea salishseacast ubc-moad

Keywords from Contributors

meopar archival mesh energy-system-model distributed generic transformers observation particles data-profilers
Last synced: 6 months ago · JSON representation

Repository

Python package associated with running the SalishSeaCast NEMO and other ocean models in near-real-time to produce daily nowcasts/forecasts

Basic Info
Statistics
  • Stars: 4
  • Watchers: 3
  • Forks: 3
  • Open Issues: 32
  • Releases: 6
Topics
automation ocean-modelling oceanography salishsea salishseacast ubc-moad
Created about 6 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.rst

****************
SalishSeaNowcast
****************

+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Continuous Integration** | .. image:: https://github.com/SalishSeaCast/SalishSeaNowcast/actions/workflows/pytest-with-coverage.yaml/badge.svg                                                                                       |
|                            |      :target: https://github.com/SalishSeaCast/SalishSeaNowcast/actions?query=workflow:pytest-with-coverage                                                                                              |
|                            |      :alt: Pytest with Coverage Status                                                                                                                                                                   |
|                            | .. image:: https://codecov.io/gh/SalishSeaCast/SalishSeaNowcast/branch/main/graph/badge.svg                                                                                                              |
|                            |      :target: https://app.codecov.io/gh/SalishSeaCast/SalishSeaNowcast                                                                                                                                   |
|                            |      :alt: Codecov Testing Coverage Report                                                                                                                                                               |
|                            | .. image:: https://github.com/SalishSeaCast/SalishSeaNowcast/actions/workflows/codeql-analysis.yaml/badge.svg                                                                                            |
|                            |      :target: https://github.com/SalishSeaCast/SalishSeaNowcast/actions?query=workflow:CodeQL                                                                                                            |
|                            |      :alt: CodeQL analysis                                                                                                                                                                               |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Documentation**          | .. image:: https://app.readthedocs.org/projects/salishsea-nowcast/badge/?version=latest                                                                                                                  |
|                            |      :target: https://salishsea-nowcast.readthedocs.io/en/latest/                                                                                                                                        |
|                            |      :alt: Documentation Status                                                                                                                                                                          |
|                            | .. image:: https://github.com/SalishSeaCast/SalishSeaNowcast/actions/workflows/sphinx-linkcheck.yaml/badge.svg                                                                                           |
|                            |      :target: https://github.com/SalishSeaCast/SalishSeaNowcast/actions?query=workflow:sphinx-linkcheck                                                                                                  |
|                            |      :alt: Sphinx linkcheck                                                                                                                                                                              |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package**                | .. image:: https://img.shields.io/github/v/release/SalishSeaCast/SalishSeaNowcast?logo=github                                                                                                            |
|                            |      :target: https://github.com/SalishSeaCast/SalishSeaNowcast/releases                                                                                                                                 |
|                            |      :alt: Releases                                                                                                                                                                                      |
|                            | .. image:: https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/SalishSeaCast/SalishSeaNowcast/main/pyproject.toml&logo=Python&logoColor=gold&label=Python |
|                            |      :target: https://docs.python.org/3/                                                                                                                                                                 |
|                            |      :alt: Python Version from PEP 621 TOML                                                                                                                                                              |
|                            | .. image:: https://img.shields.io/github/issues/SalishSeaCast/SalishSeaNowcast?logo=github                                                                                                               |
|                            |      :target: https://github.com/SalishSeaCast/SalishSeaNowcast/issues                                                                                                                                   |
|                            |      :alt: Issue Tracker                                                                                                                                                                                 |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Meta**                   | .. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg                                                                                                                                    |
|                            |      :target: https://www.apache.org/licenses/LICENSE-2.0                                                                                                                                                |
|                            |      :alt: Licensed under the Apache License, Version 2.0                                                                                                                                                |
|                            | .. image:: https://img.shields.io/badge/version%20control-git-blue.svg?logo=github                                                                                                                       |
|                            |      :target: https://github.com/SalishSeaCast/SalishSeaNowcast                                                                                                                                          |
|                            |      :alt: Git on GitHub                                                                                                                                                                                 |
|                            | .. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white                                                                                                  |
|                            |      :target: https://pre-commit.com                                                                                                                                                                     |
|                            |      :alt: pre-commit                                                                                                                                                                                    |
|                            | .. image:: https://img.shields.io/badge/code%20style-black-000000.svg                                                                                                                                    |
|                            |      :target: https://black.readthedocs.io/en/stable/                                                                                                                                                    |
|                            |      :alt: The uncompromising Python code formatter                                                                                                                                                      |
|                            | .. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg                                                                                                                                    |
|                            |      :target: https://github.com/pypa/hatch                                                                                                                                                              |
|                            |      :alt: Hatch project                                                                                                                                                                                 |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


The ``SalishSeaNowcast`` package is a collection of Python modules associated with running
the SalishSeaCast ocean models system of daily nowcasts and forecasts.
The runs use as-recent-as-available
(typically previous day)
forcing data for the western boundary sea surface height and the Fraser River flow,
and atmospheric forcing from the four-times-daily produced forecast results from the
Environment and Climate Change Canada High Resolution Deterministic Prediction System
(HRDPS) operational GEM 2.5km resolution model.

The model runs are automated using an asynchronous,
message-based architecture that:

* obtains the forcing datasets from web services
* pre-processes the forcing datasets into the formats expected by NEMO and the other models
  in the automation system
* uploads the forcing dataset files to the HPC or cloud-computing facility where the runs
  will be executed
* executes the run
* downloads the results
* prepares a collection of plots from the run results for monitoring purposes
* publishes the plots and the processing log to the web

Documentation for the package is in the ``docs/`` directory and is rendered at https://salishsea-nowcast.readthedocs.io/en/latest/.

.. image:: https://readthedocs.org/projects/salishsea-nowcast/badge/?version=latest
    :target: https://salishsea-nowcast.readthedocs.io/en/latest/
    :alt: Documentation Status


License
=======

.. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg
    :target: https://www.apache.org/licenses/LICENSE-2.0
    :alt: Licensed under the Apache License, Version 2.0

The SalishSeaCast ocean model automation system code and documentation are copyright 2013 – present
by the `SalishSeaCast Project Contributors`_ and The University of British Columbia.

.. _SalishSeaCast Project Contributors: https://github.com/SalishSeaCast/docs/blob/main/CONTRIBUTORS.rst

They are licensed under the Apache License, Version 2.0.
http://www.apache.org/licenses/LICENSE-2.0
Please see the LICENSE file for details of the license.

Owner

  • Name: SalishSeaCast
  • Login: SalishSeaCast
  • Kind: organization
  • Location: Vancouver, Canada

A three-dimensional physical-biological-chemical ocean model for the Strait of Georgia and Salish Sea

GitHub Events

Total
  • Create event: 67
  • Release event: 2
  • Issues event: 14
  • Delete event: 69
  • Issue comment event: 48
  • Push event: 111
  • Pull request event: 126
Last Year
  • Create event: 67
  • Release event: 2
  • Issues event: 14
  • Delete event: 69
  • Issue comment event: 48
  • Push event: 111
  • Pull request event: 126

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 2,856
  • Total Committers: 19
  • Avg Commits per committer: 150.316
  • Development Distribution Score (DDS): 0.122
Past Year
  • Commits: 88
  • Committers: 3
  • Avg Commits per committer: 29.333
  • Development Distribution Score (DDS): 0.33
Top Committers
Name Email Commits
Doug Latornell d****l@d****a 2,507
Susan Allen s****n@e****a 145
dependabot[bot] 4****] 109
Nancy Soontiens 9****e 22
James Petrie j****e@e****a 12
Elise Olson e****n@e****a 12
Michael Dunphy M****y@d****a 10
Muriel Dunn m****n@e****a 8
Michael Dunphy m****y@e****a 6
Melanie Grenier m****r@e****a 5
Vy (Vicky) Do v****o@e****a 4
Ben Moore-Maley b****a@e****a 4
pre-commit-ci[bot] 6****] 3
Daniel Robb d****b@e****a 3
Golnaz Irannejad g****d@g****m 2
Birgit 1****a 1
Ben Moore-Maley b****a@e****a 1
Yingkai Sha (Kyle) y****i@e****a 1
sasahu s****u@e****a 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 58
  • Total pull requests: 339
  • Average time to close issues: over 1 year
  • Average time to close pull requests: 3 days
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 1.17
  • Average comments per pull request: 0.63
  • Merged pull requests: 312
  • Bot issues: 0
  • Bot pull requests: 146
Past Year
  • Issues: 8
  • Pull requests: 129
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.7
  • Merged pull requests: 114
  • Bot issues: 0
  • Bot pull requests: 51
Top Authors
Issue Authors
  • douglatornell (58)
Pull Request Authors
  • douglatornell (195)
  • dependabot[bot] (143)
  • pre-commit-ci[bot] (7)
Top Labels
Issue Labels
Workers (37) bug (18) major (17) maintenance (16) enhancement (10) v3.0 (9) task (7) Plots (7) v3.3 (7) documentation (5) Figures (5) proposal (3) Workflow (2) Model Results (2) config (1) help wanted (1) dependencies (1) minor (1) v2.0 (1) Framework (1) sarracenia (1) critical (1) wontfix (1)
Pull Request Labels
dependencies (152) Workers (83) maintenance (76) python (74) bug (67) github_actions (66) Workflow (40) config (34) documentation (32) enhancement (30) Figures (16) minor (9) sarracenia (8) Model Results (2) critical (2) Framework (1) major (1)

Dependencies

envs/requirements.txt pypi
  • Babel ==2.10.3
  • Bottleneck ==1.3.5
  • Cartopy ==0.20.3
  • Fiona ==1.8.21
  • GDAL ==3.5.1
  • GitPython ==3.1.27
  • HeapDict ==1.0.1
  • Jinja2 ==3.1.2
  • Mako ==1.2.1
  • MarkupSafe ==2.1.1
  • Pillow ==9.2.0
  • PyNaCl ==1.5.0
  • PyPDF2 ==2.2.0
  • PyQt5 ==5.15.7
  • PyQt5-sip ==12.11.0
  • PySocks ==1.7.1
  • PyYAML ==6.0
  • Pygments ==2.12.0
  • Rtree ==1.0.0
  • Shapely ==1.8.2
  • Sphinx ==5.0.2
  • affine ==2.3.1
  • alabaster ==0.7.12
  • angles ==2.0
  • arrow ==1.2.2
  • attrs ==21.4.0
  • autopage ==0.5.1
  • backports.functools-lru-cache ==1.6.4
  • bcrypt ==3.2.2
  • beautifulsoup4 ==4.11.1
  • bokeh ==2.4.3
  • branca ==0.5.0
  • brotlipy ==0.7.0
  • cached-property ==1.5.2
  • certifi ==2022.6.15
  • cffi ==1.15.1
  • cfgv ==3.3.1
  • cftime ==1.6.1
  • charset-normalizer ==2.1.0
  • click ==7.1.2
  • click-plugins ==1.1.1
  • cliff ==3.10.1
  • cligj ==0.7.2
  • cloudpickle ==2.1.0
  • cmd2 ==2.3.3
  • cmocean ==2.0
  • colorama ==0.4.5
  • coloredlogs ==15.0.1
  • colorspacious ==1.1.2
  • coverage ==6.4.1
  • cryptography ==37.0.4
  • cycler ==0.11.0
  • cytoolz ==0.12.0
  • dask ==2022.7.0
  • distlib ==0.3.4
  • distributed ==2022.7.0
  • docutils ==0.18.1
  • et-xmlfile ==1.1.0
  • execnet ==1.9.0
  • f90nml ==1.4.2
  • feedgen ==0.9.0
  • filelock ==3.7.1
  • folium ==0.12.1.post1
  • fonttools ==4.34.4
  • fsspec ==2022.5.0
  • future ==0.18.2
  • geopandas ==0.11.0
  • gitdb ==4.0.9
  • gsw ==3.4.0
  • humanfriendly ==10.0
  • identify ==2.5.1
  • idna ==3.3
  • imagesize ==1.4.1
  • importlib-metadata ==4.11.4
  • iniconfig ==1.1.1
  • isodate ==0.6.1
  • joblib ==1.1.0
  • kiwisolver ==1.4.3
  • locket ==1.0.0
  • lxml ==4.9.1
  • lz4 ==4.0.0
  • mapclassify ==2.4.3
  • matplotlib ==3.5.2
  • msgpack ==1.0.4
  • munch ==2.5.0
  • munkres ==1.1.4
  • nc-time-axis ==1.4.1
  • netCDF4 ==1.6.0
  • networkx ==2.8.4
  • nodeenv ==1.7.0
  • numexpr ==2.8.0
  • numpy ==1.23.1
  • numpy-indexed ==0.3.5
  • openpyxl ==3.0.10
  • packaging ==21.3
  • pandas ==1.4.3
  • paramiko ==2.11.0
  • partd ==1.2.0
  • pbr ==5.9.0
  • pip ==22.1.2
  • platformdirs ==2.5.1
  • pluggy ==1.0.0
  • ply ==3.11
  • pre-commit ==2.20.0
  • prettytable ==3.3.0
  • psutil ==5.9.1
  • py ==1.11.0
  • pyOpenSSL ==22.0.0
  • pycparser ==2.21
  • pygrib ==2.1.4
  • pyparsing ==3.0.9
  • pyperclip ==1.8.2
  • pyproj ==3.3.1
  • pyshp ==2.3.0
  • pytest ==7.1.2
  • pytest-cov ==3.0.0
  • pytest-forked ==1.4.0
  • pytest-randomly ==3.12.0
  • pytest-xdist ==2.5.0
  • python-dateutil ==2.8.2
  • python-hglib ==2.6.2
  • pytz ==2022.1
  • pyzmq ==23.2.0
  • rasterio ==1.3.0
  • requests ==2.28.1
  • requests-file ==1.5.1
  • requests-toolbelt ==0.9.1
  • retrying ==1.3.3
  • schedule ==1.1.0
  • scikit-learn ==1.1.1
  • scipy ==1.8.1
  • scour ==0.38.2
  • sentry-sdk ==1.7.0
  • setuptools ==63.1.0
  • sip ==6.6.2
  • six ==1.16.0
  • smmap ==3.0.5
  • snowballstemmer ==2.2.0
  • snuggs ==1.4.7
  • sortedcontainers ==2.4.0
  • soupsieve ==2.3.1
  • sphinx-rtd-theme ==0.5.2
  • sphinxcontrib-applehelp ==1.0.2
  • sphinxcontrib-devhelp ==1.0.2
  • sphinxcontrib-htmlhelp ==2.0.0
  • sphinxcontrib-jsmath ==1.0.1
  • sphinxcontrib-qthelp ==1.0.3
  • sphinxcontrib-serializinghtml ==1.1.5
  • stevedore ==3.5.0
  • supervisor ==4.2.4
  • sysrsync ==1.1.0
  • tables ==3.7.0
  • tblib ==1.7.0
  • threadpoolctl ==3.1.0
  • toml ==0.10.2
  • tomli ==2.0.1
  • toolz ==0.12.0
  • tornado ==6.1
  • tqdm ==4.64.0
  • typing_extensions ==4.3.0
  • ukkonen ==1.0.1
  • unicodedata2 ==14.0.0
  • urllib3 ==1.26.10
  • utm ==0.7.0
  • verboselogs ==1.7
  • virtualenv ==20.15.1
  • watchdog ==2.1.9
  • wcwidth ==0.2.5
  • wheel ==0.37.1
  • xarray ==2022.3.0
  • xyzservices ==2022.6.0
  • zeep ==4.1.0
  • zict ==2.2.0
  • zipp ==3.8.0
.github/workflows/pytest-with-coverage.yaml actions
  • actions/checkout v3 composite
  • codecov/codecov-action d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 composite
  • conda-incubator/setup-miniconda 3b0f2504dd76ef23b6d31f291f4913fb60ab5ff3 composite
envs/requirements-sarracenia.txt pypi
  • PyNaCl ==1.5.0
  • PyYAML ==6.0
  • amqp ==5.1.0
  • appdirs ==1.4.4
  • bcrypt ==3.2.2
  • cffi ==1.15.1
  • cryptography ==39.0.1
  • humanfriendly ==10.0
  • humanize ==4.5.0
  • importlib-metadata ==6.0.0
  • jsonpickle ==3.0.0
  • metpx-sarracenia ==2.22.10.post2
  • netifaces ==0.11.0
  • paramiko ==3.0.0
  • pip ==23.0
  • psutil ==5.9.4
  • pycparser ==2.21
  • setuptools ==57.4.0
  • six ==1.16.0
  • vine ==5.0.0
  • watchdog ==2.2.1
  • wheel ==0.38.4
  • zipp ==3.12.0
pyproject.toml pypi
  • angles *
  • arrow *
  • beautifulsoup4 *
  • bottleneck *
  • cartopy *
  • click *
  • cliff *
  • cmocean *
  • dask *
  • docutils *
  • f90nml *
  • feedgen *
  • flox *
  • geopandas *
  • gitpython *
  • gsw *
  • httpx *
  • lxml *
  • mako *
  • matplotlib *
  • nc-time-axis *
  • nemo_nowcast *
  • netcdf4 *
  • numpy *
  • numpy-indexed *
  • pandas *
  • paramiko *
  • pillow *
  • pygrib *
  • pypdf2 *
  • pyproj *
  • python-hglib *
  • pyyaml *
  • rasterio *
  • retrying *
  • rich *
  • scipy *
  • scour *
  • sentry-sdk *
  • shapely *
  • structlog *
  • supervisor *
  • sysrsync *
  • tables *
  • tenacity *
  • utm *
  • watchdog *
  • xarray *
.github/workflows/assign-issue-pr.yaml actions
.github/workflows/codeql-analysis.yaml actions
.github/workflows/sphinx-linkcheck.yaml actions