# xcmocean
[](https://github.com/pangeo-data/xcmocean/actions)
[](https://codecov.io/gh/pangeo-data/xcmocean)
[](https://opensource.org/licenses/MIT)
[](https://xcmocean.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/pangeo-data/xcmocean/actions)
[](https://anaconda.org/conda-forge/xcmocean)
[](https://pypi.org/project/xcmocean)
xarray accessor for automating choosing colormaps, aimed at geosciences.
Also optional dependence on `cf-xarray`.
--------
<p><small>Project based on the <a target="_blank" href="https://github.com/jbusecke/cookiecutter-science-project">cookiecutter science project template</a>.</small></p>
## Installation:
You can pip install from PyPI:
```
pip install xcmocean
```
or install from conda-forge with
```
conda install -c conda-forge xcmocean
```
## Example usage:
```
import xcmocean
ds.salt.cmo.contourf(x='lon', y='lat')
```
which would make a `contourf` plot of the `ds.salt` data using the `cmocean` `haline` colormap. More examples in the docs.
## Dev installation for local work
Clone the repo:
```
$ git clone https://github.com/pangeo-data/xcmocean.git
```
In the `xcmocean` directory, install conda environment:
```
$ conda env create -f environment.yml
```
To also develop this package, install additional packages with:
```
$ conda install --file requirements-dev.txt
```
To then check code before committing and pushing it to github, locally run
```
$ pre-commit run --all-files
```
Raw data
{
"_id": null,
"home_page": "https://github.com/kthyng/xcmocean",
"name": "xcmocean",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Kristen Thyng",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/bb/9d/8074951c695bf6affa8a76200f4d74b3e8564dff28d8c7229f50ab6d5df6/xcmocean-0.3.2.tar.gz",
"platform": null,
"description": "# xcmocean\n[](https://github.com/pangeo-data/xcmocean/actions)\n[](https://codecov.io/gh/pangeo-data/xcmocean)\n[](https://opensource.org/licenses/MIT)\n[](https://xcmocean.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/pangeo-data/xcmocean/actions)\n[](https://anaconda.org/conda-forge/xcmocean)\n[](https://pypi.org/project/xcmocean)\n\nxarray accessor for automating choosing colormaps, aimed at geosciences.\n\nAlso optional dependence on `cf-xarray`.\n\n--------\n\n<p><small>Project based on the <a target=\"_blank\" href=\"https://github.com/jbusecke/cookiecutter-science-project\">cookiecutter science project template</a>.</small></p>\n\n## Installation:\n\nYou can pip install from PyPI:\n```\npip install xcmocean\n```\n\nor install from conda-forge with\n```\nconda install -c conda-forge xcmocean\n```\n\n\n## Example usage:\n\n```\nimport xcmocean\n\nds.salt.cmo.contourf(x='lon', y='lat')\n```\n\nwhich would make a `contourf` plot of the `ds.salt` data using the `cmocean` `haline` colormap. More examples in the docs.\n\n## Dev installation for local work\n\nClone the repo:\n```\n$ git clone https://github.com/pangeo-data/xcmocean.git\n```\n\nIn the `xcmocean` directory, install conda environment:\n```\n$ conda env create -f environment.yml\n```\n\nTo also develop this package, install additional packages with:\n```\n$ conda install --file requirements-dev.txt\n```\n\nTo then check code before committing and pushing it to github, locally run\n```\n$ pre-commit run --all-files\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Opinionated xarray accessor for choosing colormaps",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/kthyng/xcmocean"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55ad4ca7f0ba9f332eb1827ecb2d9b9b7405e52140f50015d5bba344acc249ec",
"md5": "9c31f11ad5da4e969dd4f4be49c66747",
"sha256": "37c32e805b28af171b41737796c1d38ccc690844f100e1366819e6f412e6a785"
},
"downloads": -1,
"filename": "xcmocean-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c31f11ad5da4e969dd4f4be49c66747",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5827,
"upload_time": "2023-11-27T23:35:41",
"upload_time_iso_8601": "2023-11-27T23:35:41.592501Z",
"url": "https://files.pythonhosted.org/packages/55/ad/4ca7f0ba9f332eb1827ecb2d9b9b7405e52140f50015d5bba344acc249ec/xcmocean-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb9d8074951c695bf6affa8a76200f4d74b3e8564dff28d8c7229f50ab6d5df6",
"md5": "2a08e078d079f056bc6be43b6cac0917",
"sha256": "7c55e1c0fcdea469c58331c25630e50e1d5ec0311581724f3e860c1a176cef9e"
},
"downloads": -1,
"filename": "xcmocean-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "2a08e078d079f056bc6be43b6cac0917",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 495938,
"upload_time": "2023-11-27T23:35:42",
"upload_time_iso_8601": "2023-11-27T23:35:42.859692Z",
"url": "https://files.pythonhosted.org/packages/bb/9d/8074951c695bf6affa8a76200f4d74b3e8564dff28d8c7229f50ab6d5df6/xcmocean-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-27 23:35:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kthyng",
"github_project": "xcmocean",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "xcmocean"
}
JSON
