Data

Tools

Indexes

Applications

Experiments

Open Source Science

ECCOv4-py

A Python library with routines that support the loading, analysis, and plotting fields of the ECCO Version 4 Ocean and Sea-Ice State Estimate. The ecco_v4_py library builds on several valuable tools such as xmitgcm, gcm, xarray, and dask.

https://github.com/ECCO-GROUP/ECCOv4-py

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
    11 of 24 committers (45.8%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

A Python library with routines that support the loading, analysis, and plotting fields of the ECCO Version 4 Ocean and Sea-Ice State Estimate. The ecco_v4_py library builds on several valuable tools such as xmitgcm, gcm, xarray, and dask.

Basic Info
  • Host: GitHub
  • Owner: ECCO-GROUP
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 163 MB
Statistics
  • Stars: 34
  • Watchers: 16
  • Forks: 36
  • Open Issues: 2
  • Releases: 18
Created over 8 years ago · Last pushed 12 months ago
Metadata Files
Readme License

README.md

Synopsis

eccov4py is a Python package that includes tools for loading and manipulating the ECCO v4 ocean and sea-ice state estimate (http://ecco-group.org)

Extensive documentation is provided on our readthedocs page: http://ecco-v4-python-tutorial.readthedocs.io/index.html#

Installation

Installation instructions can be found here!

https://ecco-v4-python-tutorial.readthedocs.io/InstallingPythonandPythonPackages.html

Contributors

If you would like to contribute, consider forking this repository and making pull requests via git!

Support

contact ecco-support@mit.edu or Ian.Fenty at jpl.nasa.gov

License

MIT License

Note on version numbers

eccov4py uses the 'semantic versioning' scheme described here:

https://packaging.python.org/guides/distributing-packages-using-setuptools/#semantic-versioning-preferred

The essence of semantic versioning is a 3-part MAJOR.MINOR.MAINTENANCE numbering scheme:

MAJOR version when they make incompatible API changes,

MINOR version when they add functionality in a backwards-compatible manner, and

MAINTENANCE version when they make backwards-compatible bug fixes.

Updating on pypi.org

Note: Publishing a new 'release' will trigger an 'action' and publish the new release to pypi. The version number has to be different otherwise pypi will reject it and say 'version already exists'.

The instructions below outline how to manually push code changes to pypi.

  1. Make sure your ~/.pypirc file has entries for [pypi] and [testpypi] with properly-scoped api tokens ``` [distutils] index-servers = pypi eccov4py

[pypi] username = token password = YOUR-PYPI-TOKEN-HERE

[eccov4py] repository = https://upload.pypi.org/legacy/ username = token password = YOUR-PYPI-TOKEN-HERE (can be scoped for just the eccov4py package)

[testpypi] username = token password = YOUR-TESTPYPI-TOKEN-HERE 2. Verify all code changes are up to date on github, including version number 3. Navigate to ECCOv4_py directory 4. Remove old "distribution" files by deleting the contents of thedist/directory 5. Rebuild thedist/files python3 setup.py sdist bdist_wheel 6. Push changes to pypi test platform: test.pypi.org twine upload --repository testpypi dist/* 7. Verify code updates are on test.pypi.org: https://test.pypi.org/project/ecco-v4-py/ 8. Push changes to to pypi twine upload dist/* --repository-url https://upload.pypi.org/legacy/ ``` 9. Verify code updates are on pypi.org: https://pypi.org/project/ecco-v4-py/

Note on testing with pytest

(credit to Tim Smith)

You can run the tests locally with the pytest package, which is available through conda-forge. With that installed, you can navigate to ECCOv4-py/eccov4py/test and either:

Run all the tests exactly as they are on travis (this takes a while, like 12 minutes!):

py.test . -v --cov=ecco_v4_py --cov-config .coveragerc --ignore=ecco_v4_py/test/test_generate_ecco_netcdf_product.py

Or you can run any individual module e.g. to run the few tests in ecco_utils:

``` py.test testeccoutils.py

```

(and you can add any of the -v or whatever flags you want).

Owner

  • Name: Estimating the Circulation and Climate of the Ocean (ECCO)
  • Login: ECCO-GROUP
  • Kind: organization

GitHub Events

Total
  • Create event: 25
  • Commit comment event: 3
  • Release event: 13
  • Watch event: 3
  • Delete event: 11
  • Member event: 2
  • Issue comment event: 17
  • Push event: 36
  • Pull request event: 59
  • Fork event: 7
Last Year
  • Create event: 25
  • Commit comment event: 3
  • Release event: 13
  • Watch event: 3
  • Delete event: 11
  • Member event: 2
  • Issue comment event: 17
  • Push event: 36
  • Pull request event: 59
  • Fork event: 7

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 668
  • Total Committers: 24
  • Avg Commits per committer: 27.833
  • Development Distribution Score (DDS): 0.591
Past Year
  • Commits: 142
  • Committers: 4
  • Avg Commits per committer: 35.5
  • Development Distribution Score (DDS): 0.12
Top Committers
Name Email Commits
Ian Fenty i****y@g****m 273
Andrew Delman a****n@g****m 190
Timothy Smith t****4@u****u 59
Andrew Delman a****n@u****u 57
ifenty f****y@g****m 24
Ou Wang o****g@p****v 20
Ou Wang o****1@y****m 13
Jan-Erik Tesdal j****l@g****m 5
Emma Boland e****p@b****k 4
JPL User j****r@i****v 4
Duncan Bark d****k@g****m 3
Marie Zahn m****n@j****v 2
Maike Sonnewald m****e@g****m 2
Debellis m****s@g****m 2
Ivana Escobar i****a@u****u 1
Ian Fenty i****y@l****u 1
Ian Fenty i****y@l****u 1
JPL User j****r@i****v 1
Jan-Erik Tesdal j****l@g****m 1
Ou Wang o****g@p****v 1
Ubuntu u****u@i****l 1
Greg Moore 6****e 1
Denis Felikson d****n@g****m 1
Dafydd S 1****n 1
Committer Domains (Top 20 + Academic)
utexas.edu: 2 ip-172-31-75-120.ec2.internal: 1 pfe25.nas.nasa.gov: 1 ip-100-104-70-173.jpl.nasa.gov: 1 login4.stampede2.tacc.utexas.edu: 1 login2.stampede2.tacc.utexas.edu: 1 jpl.nasa.gov: 1 ip-100-104-70-237.jpl.nasa.gov: 1 bas.ac.uk: 1 penguin.jpl.nasa.gov: 1 ucla.edu: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 22
  • Total pull requests: 146
  • Average time to close issues: 7 months
  • Average time to close pull requests: 8 days
  • Total issue authors: 17
  • Total pull request authors: 13
  • Average comments per issue: 3.5
  • Average comments per pull request: 0.83
  • Merged pull requests: 135
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 60
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 5
  • Average comments per issue: 0
  • Average comments per pull request: 0.37
  • Merged pull requests: 54
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • timothyas (4)
  • liu-ran (2)
  • jetesdal (2)
  • rcaneill (1)
  • DanJonesOcean (1)
  • rabernat (1)
  • ifenty (1)
  • christophernhill (1)
  • ggebbie (1)
  • Shreyas911 (1)
  • cspencerjones (1)
  • simonwettocean (1)
  • pittwolfe (1)
  • JustinWenzhaoLi (1)
  • jdldeauna (1)
Pull Request Authors
  • ifenty (59)
  • andrewdelman (31)
  • owang01 (21)
  • timothyas (17)
  • gjmoore (4)
  • emmomp (3)
  • dafyddstephenson (2)
  • clarkzimm (2)
  • mjzahn (2)
  • jetesdal (2)
  • IvanaEscobar (1)
  • DuncanBark (1)
  • mayadebellis (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 4
  • Total downloads:
    • pypi 219 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 4
    (may contain duplicates)
  • Total versions: 89
  • Total maintainers: 2
proxy.golang.org: github.com/ECCO-GROUP/ECCOv4-py
  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
proxy.golang.org: github.com/ecco-group/eccov4-py
  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
pypi.org: ecco-v4-py

Estimating the Circulation and Climate of the Ocean (ECCO) Version 4 Python Package

  • Versions: 63
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 219 Last month
  • Docker Downloads: 0
Rankings
Docker downloads count: 2.0%
Forks count: 7.5%
Dependent packages count: 10.1%
Average: 11.5%
Stargazers count: 12.2%
Downloads: 15.4%
Dependent repos count: 21.6%
Maintainers (2)
ifenty owang
Last synced: 12 months ago
conda-forge.org: ecco_v4_py
  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 3
Rankings
Dependent repos count: 18.1%
Forks count: 33.1%
Average: 37.7%
Stargazers count: 47.9%
Dependent packages count: 51.6%
Last synced: 10 months ago

Dependencies

setup.py pypi
  • Bottleneck *
  • Cartopy *
  • cmocean *
  • dask *
  • future *
  • numpy *