carbonplan-styles


Namecarbonplan-styles JSON
Version 0.5.1 PyPI version JSON
download
home_pageNone
SummaryCarbonPlan plotting styles
upload_time2024-04-16 21:27:54
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT
keywords matplotlib altair
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="left" >
<a href='https://carbonplan.org'>
<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://carbonplan-assets.s3.amazonaws.com/monogram/light-small.png">
  <img alt="CarbonPlan monogram." height="48" src="https://carbonplan-assets.s3.amazonaws.com/monogram/dark-small.png">
</picture>
</a>
</p>

# carbonplan / styles

**plot styles for matplotlib and altair**

[![CI](https://github.com/carbonplan/styles/actions/workflows/main.yaml/badge.svg)](https://github.com/carbonplan/styles/actions/workflows/main.yaml)
![PyPI](https://img.shields.io/pypi/v/carbonplan_styles)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

A collection of plotting styles for [Matplotlib](https://matplotlib.org/) and [Altair](https://altair-viz.github.io/).

Try it out on Binder:
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/carbonplan/styles/main?urlpath=lab)

## install

```shell
pip install "carbonplan[styles]"
```

## usage

There are currently two separate styles/themes available in this package:

1. `carbonplan_dark`: black background, lighter colors
2. `carbonplan_light`: white background, darker colors

Both styels/themes are automatically made available in Matplotlib and Altair.

### matplotlib

```python
from carbonplan import styles

styles.mpl.set_theme(style='carbonplan_dark')
```

### altair

```python
import altair as alt

alt.themes.enable('carbonplan_dark')
```

## license

All the code in this repository is [MIT](https://choosealicense.com/licenses/mit/)-licensed. We include attribution for this content, and we please request that you also maintain that attribution if using this data.

## about us

CarbonPlan is a nonprofit organization that uses data and science for climate action. We aim to improve the transparency and scientific integrity of climate solutions with open data and tools. Find out more at [carbonplan.org](https://carbonplan.org/) or get in touch by [opening an issue](https://github.com/carbonplan/styles/issues/new) or [sending us an email](mailto:hello@carbonplan.org).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "carbonplan-styles",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "matplotlib, altair",
    "author": null,
    "author_email": "CarbonPlan <tech@carbonplan.org>",
    "download_url": "https://files.pythonhosted.org/packages/92/0a/1f4011ab7e3f3cc2135fb24685825e091c7d6cb316f3f466aa90510672ea/carbonplan_styles-0.5.1.tar.gz",
    "platform": null,
    "description": "<p align=\"left\" >\n<a href='https://carbonplan.org'>\n<picture>\n  <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://carbonplan-assets.s3.amazonaws.com/monogram/light-small.png\">\n  <img alt=\"CarbonPlan monogram.\" height=\"48\" src=\"https://carbonplan-assets.s3.amazonaws.com/monogram/dark-small.png\">\n</picture>\n</a>\n</p>\n\n# carbonplan / styles\n\n**plot styles for matplotlib and altair**\n\n[![CI](https://github.com/carbonplan/styles/actions/workflows/main.yaml/badge.svg)](https://github.com/carbonplan/styles/actions/workflows/main.yaml)\n![PyPI](https://img.shields.io/pypi/v/carbonplan_styles)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\nA collection of plotting styles for [Matplotlib](https://matplotlib.org/) and [Altair](https://altair-viz.github.io/).\n\nTry it out on Binder:\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/carbonplan/styles/main?urlpath=lab)\n\n## install\n\n```shell\npip install \"carbonplan[styles]\"\n```\n\n## usage\n\nThere are currently two separate styles/themes available in this package:\n\n1. `carbonplan_dark`: black background, lighter colors\n2. `carbonplan_light`: white background, darker colors\n\nBoth styels/themes are automatically made available in Matplotlib and Altair.\n\n### matplotlib\n\n```python\nfrom carbonplan import styles\n\nstyles.mpl.set_theme(style='carbonplan_dark')\n```\n\n### altair\n\n```python\nimport altair as alt\n\nalt.themes.enable('carbonplan_dark')\n```\n\n## license\n\nAll the code in this repository is [MIT](https://choosealicense.com/licenses/mit/)-licensed. We include attribution for this content, and we please request that you also maintain that attribution if using this data.\n\n## about us\n\nCarbonPlan is a nonprofit organization that uses data and science for climate action. We aim to improve the transparency and scientific integrity of climate solutions with open data and tools. Find out more at [carbonplan.org](https://carbonplan.org/) or get in touch by [opening an issue](https://github.com/carbonplan/styles/issues/new) or [sending us an email](mailto:hello@carbonplan.org).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CarbonPlan plotting styles",
    "version": "0.5.1",
    "project_urls": {
        "repository": "https://github.com/carbonplan/style"
    },
    "split_keywords": [
        "matplotlib",
        " altair"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "687a7efd210a7595f770c32eb41bd20f2efea63545c724b1fa0b49b417be9b2e",
                "md5": "aad4afc3704b4a080f77c5440bb2925f",
                "sha256": "f1c9e89d10cd3ec6c836b4fd3e2e309c998357127aab92dffe655cdf0a212a4e"
            },
            "downloads": -1,
            "filename": "carbonplan_styles-0.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aad4afc3704b4a080f77c5440bb2925f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 73278,
            "upload_time": "2024-04-16T21:27:53",
            "upload_time_iso_8601": "2024-04-16T21:27:53.418774Z",
            "url": "https://files.pythonhosted.org/packages/68/7a/7efd210a7595f770c32eb41bd20f2efea63545c724b1fa0b49b417be9b2e/carbonplan_styles-0.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "920a1f4011ab7e3f3cc2135fb24685825e091c7d6cb316f3f466aa90510672ea",
                "md5": "ac9a35e0e872277459876dcfbc674bae",
                "sha256": "dfce68b291deb112f536d3394ba0965bed3cff3f4341108ec18775599b5f0567"
            },
            "downloads": -1,
            "filename": "carbonplan_styles-0.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ac9a35e0e872277459876dcfbc674bae",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 143979,
            "upload_time": "2024-04-16T21:27:54",
            "upload_time_iso_8601": "2024-04-16T21:27:54.930964Z",
            "url": "https://files.pythonhosted.org/packages/92/0a/1f4011ab7e3f3cc2135fb24685825e091c7d6cb316f3f466aa90510672ea/carbonplan_styles-0.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-16 21:27:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "carbonplan",
    "github_project": "style",
    "github_not_found": true,
    "lcname": "carbonplan-styles"
}
        
Elapsed time: 0.22415s