Skip to main content

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

Project description

Synopsis

ecco_v4_py 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/Installing_Python_and_Python_Packages.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

ecco_v4_py 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
    ecco_v4_py 

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

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

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ecco_v4_py-1.7.7.tar.gz (133.5 kB view details)

Uploaded Source

Built Distribution

ecco_v4_py-1.7.7-py3-none-any.whl (167.4 kB view details)

Uploaded Python 3

File details

Details for the file ecco_v4_py-1.7.7.tar.gz.

File metadata

  • Download URL: ecco_v4_py-1.7.7.tar.gz
  • Upload date:
  • Size: 133.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ecco_v4_py-1.7.7.tar.gz
Algorithm Hash digest
SHA256 c9491adb0ee71e23dea8f053cce0ea7dd4b0526ce973a50e1ae784a4f5473539
MD5 25f157104f6b8881f34dd8c6003f7b74
BLAKE2b-256 f994aaf4163450f43b545161f2b8fd5f090570d3b3e470a677b811c077750c1c

See more details on using hashes here.

File details

Details for the file ecco_v4_py-1.7.7-py3-none-any.whl.

File metadata

  • Download URL: ecco_v4_py-1.7.7-py3-none-any.whl
  • Upload date:
  • Size: 167.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ecco_v4_py-1.7.7-py3-none-any.whl
Algorithm Hash digest
SHA256 becb288ba03b2232ced1917cb00333ddf96c3c58e5edfbc0c382d0f63e569bb1
MD5 7638f0f77d738d81cf4382712ea07e76
BLAKE2b-256 56dbe4da2f9fd0f604e14c8d2f0efef8021f09f7c5def1906c9a0c86df0b094a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page