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:
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.
- Make sure your
~/.pypircfile 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
- Verify all code changes are up to date on github, including version number
- Navigate to ECCOv4_py directory
- Remove old "distribution" files by deleting the contents of the
dist/directory - Rebuild the
dist/files
python3 setup.py sdist bdist_wheel
- Push changes to pypi test platform: test.pypi.org
twine upload --repository testpypi dist/*
- Verify code updates are on test.pypi.org: https://test.pypi.org/project/ecco-v4-py/
- Push changes to to pypi
twine upload dist/* --repository-url https://upload.pypi.org/legacy/
- 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).
Release files for ecco-v4-py 1.8.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ecco_v4_py-1.8.1.tar.gz | 96.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ecco_v4_py-1.8.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 207.0 kB
Release files / ecco_v4_py-1.8.1.tar.gz
| Download URL | ecco_v4_py-1.8.1.tar.gz |
|---|---|
| Size | 96.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ff0d37987feafe9872bd2877049c8d0d6e16e295b00fda3d4afba300f0921a7b
|
|
BLAKE2b-256 checksum How to use checksums |
d173a61dc3924dbe0025e1288e134838e307299f60b3c2e41065ac816a0595f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / ecco_v4_py-1.8.1-py3-none-any.whl
| Download URL | ecco_v4_py-1.8.1-py3-none-any.whl |
|---|---|
| Size | 110.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
897e68136b1d01288e1d87e7a6863f9901a734d37b3cad0c7384e3ddaff96f3b
|
|
BLAKE2b-256 checksum How to use checksums |
96a368695b4ac6878e7c4f17930195af1544db4ecd0d93b42d9479731a37b41d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
