## 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.
## 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).
Raw data
{
"_id": null,
"home_page": "https://github.com/ECCO-GROUP/ECCOv4-py",
"name": "ecco-v4-py",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "ecco, climate, mitgcm, estimate, circulation, climate",
"author": "Ian Fenty, Ou Wang, Tim Smith, and others",
"author_email": "ian.fenty@jpl.nasa.gov, ecco-group@mit.edu",
"download_url": "https://files.pythonhosted.org/packages/1b/d2/78e35b490c7a51f0a2d8ce58b36ca57dc594dda436414b181a151ccf8582/ecco_v4_py-1.6.0.tar.gz",
"platform": null,
"description": "## Synopsis\n\necco_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)\n\nExtensive documentation is provided on our readthedocs page: \nhttp://ecco-v4-python-tutorial.readthedocs.io/index.html#\n\n## Installation\n\nInstallation instructions can be found here!\n\nhttps://ecco-v4-python-tutorial.readthedocs.io/Installing_Python_and_Python_Packages.html\n\n\n## Contributors\n\nIf you would like to contribute, consider forking this repository and making pull requests via git!\n\n## Support \n\ncontact ecco-support@mit.edu or Ian.Fenty at jpl.nasa.gov\n\n## License\n\nMIT License\n\n\n## Note on version numbers\n\necco_v4_py uses the 'semantic versioning' scheme described here:\n\nhttps://packaging.python.org/guides/distributing-packages-using-setuptools/#semantic-versioning-preferred\n\nThe essence of semantic versioning is a 3-part MAJOR.MINOR.MAINTENANCE numbering scheme:\n\nMAJOR version when they make incompatible API changes,\n\nMINOR version when they add functionality in a backwards-compatible manner, and\n\nMAINTENANCE version when they make backwards-compatible bug fixes.\n\n## Note on testing with `pytest`\n\n(credit to Tim Smith)\n\n\nYou 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:\n\nRun all the tests exactly as they are on travis (this takes a while, like 12 minutes!):\n\n```\npy.test . -v --cov=ecco_v4_py --cov-config .coveragerc --ignore=ecco_v4_py/test/test_generate_ecco_netcdf_product.py\n```\n\nOr you can run any individual module e.g. to run the few tests in ecco_utils:\n\n```\npy.test test_ecco_utils.py\n\n```\n\n(and you can add any of the -v or whatever flags you want). \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Estimating the Circulation and Climate of the Ocean (ECCO) Version 4 Python Package",
"version": "1.6.0",
"project_urls": {
"Homepage": "https://github.com/ECCO-GROUP/ECCOv4-py"
},
"split_keywords": [
"ecco",
" climate",
" mitgcm",
" estimate",
" circulation",
" climate"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bda20e0fa5ed6ebb68b31ed3978db7adadba74590bbb4adb1244a238b9452391",
"md5": "631019c6aff88abf5efe718d38f5cec8",
"sha256": "f94a9fcabf310da2c3c4208a1d8b44b0e53d24a868a5ce04ab92e3ad4955b395"
},
"downloads": -1,
"filename": "ecco_v4_py-1.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "631019c6aff88abf5efe718d38f5cec8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 90974,
"upload_time": "2024-05-10T22:04:56",
"upload_time_iso_8601": "2024-05-10T22:04:56.169653Z",
"url": "https://files.pythonhosted.org/packages/bd/a2/0e0fa5ed6ebb68b31ed3978db7adadba74590bbb4adb1244a238b9452391/ecco_v4_py-1.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1bd278e35b490c7a51f0a2d8ce58b36ca57dc594dda436414b181a151ccf8582",
"md5": "f1b430a716cfb90161e47f9d800cd21a",
"sha256": "7fe0fec93911e7f53b23b7cd4c4ac657792c90a82a3e57f40b44ae3fc0b86115"
},
"downloads": -1,
"filename": "ecco_v4_py-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "f1b430a716cfb90161e47f9d800cd21a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 80169,
"upload_time": "2024-05-10T22:04:58",
"upload_time_iso_8601": "2024-05-10T22:04:58.279167Z",
"url": "https://files.pythonhosted.org/packages/1b/d2/78e35b490c7a51f0a2d8ce58b36ca57dc594dda436414b181a151ccf8582/ecco_v4_py-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-10 22:04:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ECCO-GROUP",
"github_project": "ECCOv4-py",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"lcname": "ecco-v4-py"
}
JSON
