oceansdb

A database of marine reference data like climatologies and bathymetry

https://github.com/castelao/oceansdb

Science Score: 46.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
Links to: zenodo.org
✓
Committers with academic emails
1 of 5 committers (20.0%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (10.9%) to scientific vocabulary

Last synced: 7 months ago · JSON representation

Repository

A database of marine reference data like climatologies and bathymetry

Basic Info

Host: GitHub
Owner: castelao
License: bsd-3-clause
Language: Python
Default Branch: main
Size: 246 KB

Statistics

Stars: 23
Watchers: 6
Forks: 15
Open Issues: 7
Releases: 3

Created about 10 years ago · Last pushed about 3 years ago

Metadata Files

Readme Changelog Contributing License Authors Zenodo

README.rst

========
OceansDB
========

.. image:: https://zenodo.org/badge/52222122.svg
   :target: https://zenodo.org/badge/latestdoi/52222122

.. image:: https://readthedocs.org/projects/oceansdb/badge/?version=latest
    :target: http://oceansdb.readthedocs.org/en/latest/?badge=latest
         :alt: Documentation Status

.. image:: https://img.shields.io/travis/castelao/oceansdb.svg
        :target: https://travis-ci.org/castelao/oceansdb

.. image:: https://img.shields.io/pypi/v/oceansdb.svg
        :target: https://pypi.python.org/pypi/oceansdb


Package to subsample, or interpolate, climatologies like WOA to any coordinates.

This package started with functions to obtain climatological values to compare with measured data, allowing a quality control check by comparison. It hence needed to work for any coordinates requested. I split these functionalities from `CoTeDe `_ into this standalone package to allow more people to use it for other purposes.

* Free software: 3-clause BSD style license - see LICENSE.rst  
* Documentation: https://oceansdb.readthedocs.io.

Features
--------

- If the database files are not localy available, automatically download it.

- Extract, or interpolate if necessary, climatologic data on requested coordinates;

  - Can request a single point, a profile or a section;

  - Ready to handle -180 to 180 or 0 to 360 coordinate system;

- Ready to use with:

  - World Ocean Atlas (WOA)

  - CSIRO Atlas Regional Seas (CARS)

  - ETOPO (topography)

Quick howto use
---------------

Inside python:

.. code-block:: python

    >>> import oceansdb
    >>> with oceansdb.WOA() as db:

Find out what is available:

.. code-block:: python

    >>>     db.keys()

Average temperature at one point:

.. code-block:: python

    >>>     t = db['sea_water_temperature'].extract(var='mean', doy=136.875, depth=0, lat=17.5, lon=-37.5)

A profile of salinity:

.. code-block:: python

    >>>     t = db['sea_water_salinity'].extract(var='mean', doy=136.875, depth=[0, 10, 15, 18], lat=17.5, lon=-37.5)

A full depth section of temperature:

.. code-block:: python

    >>>     t = db['sea_water_temperature'].extract(var='mean', doy=136.875, lat=17.48, lon=[-39, -37.5, -35.2])

Using CARS instead of WOA:

.. code-block:: python

    >>> with oceansdb.CARS() as db:
    >>>     t = db['sea_water_temperature'].extract(var='mean', doy=136.875, lat=17.48, lon=[-39, -37.5, -35.2], depth=[0,10,120,280])

Or to get topography for one point from the 1 min arc resolution:

.. code-block:: python

    >>> with oceansdb.ETOPO(resolution='1min') as db:
    >>>     h = db['topography'].extract(lat=17.5, lon=0)

Owner

Name: Guilherme Castelão
Login: castelao
Kind: user
Location: CO
Company: @NREL

Website: www.castelao.net
Repositories: 80
Profile: https://github.com/castelao

multi-class: PhD in Physical Oceanography, offshore solo sailor, Rustacean and Pythonista.

GitHub Events

Total

Watch event: 2
Fork event: 1

Last Year

Watch event: 2
Fork event: 1

Committers

Last synced: 8 months ago

All Time

Total Commits: 332
Total Committers: 5
Avg Commits per committer: 66.4
Development Distribution Score (DDS): 0.187

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Gui	g**e@c**t	270
Guilherme Castelao	c**o@h**u	53
Guilherme Castelao	c**o@g**l	7
ZeDias	j**n@g**m	1
Chris Slater	6****m	1

Committer Domains (Top 20 + Academic)

hatch.ucsd.edu: 1 castelao.net: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time

Total issues: 16
Total pull requests: 9
Average time to close issues: about 1 month
Average time to close pull requests: about 16 hours
Total issue authors: 11
Total pull request authors: 3
Average comments per issue: 0.75
Average comments per pull request: 0.67
Merged pull requests: 8
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

castelao (5)
jdassink (2)
biavillasboas (1)
BillMills (1)
sgartzman (1)
ba05 (1)
maryjacketti (1)
madHatter106 (1)
petejan (1)
jichaojoyce (1)
uliw (1)

Pull Request Authors

castelao (7)
jdiasn (1)
electricsam (1)

Top Labels

Issue Labels

bug (2) enhancement (1)

Pull Request Labels

Packages

Total packages: 3
Total downloads:
- pypi 544 last-month

Total dependent packages: 2
(may contain duplicates)
Total dependent repositories: 6
(may contain duplicates)
Total versions: 43
Total maintainers: 1

proxy.golang.org: github.com/castelao/oceansdb

Documentation: https://pkg.go.dev/github.com/castelao/oceansdb#section-documentation
License: bsd-3-clause
Latest release: v0.8.15
published about 3 years ago

Versions: 15
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 7 months ago

pypi.org: oceansdb

Subsample ocean climatologies and reference data

Documentation: https://oceansdb.readthedocs.io/
License: BSD License
Latest release: 0.8.15
published about 3 years ago

Versions: 24
Dependent Packages: 1
Dependent Repositories: 6
Downloads: 544 Last month
Docker Downloads: 0

Rankings

Docker downloads count: 4.2%

Dependent packages count: 4.7%

Dependent repos count: 6.0%

Average: 7.1%

Downloads: 13.5%

Maintainers (1)

castelao

Last synced: 7 months ago

conda-forge.org: oceansdb

Homepage: https://github.com/castelao/oceansdb
License: BSD-3-Clause
Latest release: 0.8.14
published almost 5 years ago

Versions: 4
Dependent Packages: 1
Dependent Repositories: 0

Rankings

Dependent packages count: 28.8%

Dependent repos count: 34.0%

Average: 37.3%

Forks count: 39.0%

Stargazers count: 47.3%

Last synced: 7 months ago

Dependencies

.github/workflows/ci.yml actions

actions/cache v3 composite
actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/publish-to-pypi.yml actions

actions/checkout v3 composite
actions/setup-python v3 composite
pypa/gh-action-pypi-publish release/v1 composite

docs/environment.yml pypi

pyproject.toml pypi

netCDF4 >=1.2.4
numpy >=1.14
scipy >=1.1
supportdata >=0.1.3

setup.py pypi