ATLAS Matplotlib Style
======================
.. image:: https://img.shields.io/pypi/v/atlas-mpl-style?label=PyPI&style=for-the-badge :alt: PyPI
**Despite the last commit date, this package is still maintained. If you have any comments or improvements, open an issue or PR.**
Provides a Matplotlib style replicating that used by the
`ATLAS <http://atlas.cern>`__ collaboration.
**Please open an issue if you find this style deviates from the guidelines.**
Install from PyPI using pip: :code:`pip install atlas-mpl-style`
Documentation: https://atlas-mpl.readthedocs.io/en/latest/index.html
In addition, this package also provides:
- A function to draw the ATLAS label
- A ``plot`` module containing functions to plot pre-binned histograms and
limits. This includes functionality for plotting stacked backgrounds along
with data and ratios in the usual ATLAS style.
- A matplotlib style based on the background / foreground from the VIM `Paper <https://github.com/NLKNguyen/papercolor-theme>`__ color scheme, along with a print version with a white background.
- The default color cycle in all three styles is generated with HCL Wizard
- Additional Matplotlib color definitions based on the Paper theme, and the
`Oceanic Next <https://github.com/voronianski/oceanic-next-color-scheme>`__
theme
UHI and the PlottableHistogram protocol
-----------------------------------------
With the development of the `UHI <https://github.com/henryiii/uhi>`__ interface,
this package now has support for histogram objects that follow the
``PlottableHistogram`` protocol. ``plot.Background`` objects can be constructed
using ``PlottableHistograms`` and a list of such ``Backgrounds`` can be passed
to ``plot.plot_backgrounds`` omitting the ``bins`` argument. The other histogram
plotting functions could not be modified to accept ``PlottableHistogram`` in a
backward compatible manner since they take ``bins`` before the histogram
argument. Alternate versions of these functions are therefore provided in the
``uhi`` module.
As a result of this support, the histogram objects returned by `Uproot 4
<https://github.com/scikit-hep/uproot4>`__ can be plotted directly, as can
`Boost-Histogram <https://github.com/scikit-hep/boost-histogram>`__ histograms
and `Hist <https://github.com/scikit-hep/hist>`__ objects (once the relevent PRs
are merged into those repositories).
``usetex=False`` Mode
------------------------
``usetex=False`` is now the default, removing the LaTeX dependency.
If you convert a plotting script that uses ``usetex=True`` mode, make sure labels
are updated to remove LaTeX macros that are not supported by Matplotlib's
mathtext.
TeXLive and Fonts Needed
------------------------
If you have a full LaTeX installation available, you can use LaTeX to typeset the text by passing ``usetex=True`` to ``use_atlas_style``. This will give you much greater options in terms of what can
be included in labels.
A working TeXLive installation providing the following is required:
- pdflatex
- amsmath
- TeX Gyre Heros
- mathastext
- physics (the package)
- siunitx
If no LaTeX installation is available, the style will warn and fall back to the ``usetex=False`` behaviour.
To check if all necessary packages are installed, try building ``atlas_mpl_style/testing/ampl-test.tex``.
On Arch (and related distributions), the ``texlive-most`` group is sufficient.
On Debian (Jessie or above) or Ubuntu (18.04+), the following set of packages should be sufficient. It is however highly recommended
that you install `texlive-full` to obtain a complete installation of texlive.
- texlive
- texlive-latex-extra
- texlive-fonts-recommended
- texlive-lang-greek
- tex-gyre
- dvipng
- ghostscript
On CentOS 7, the supplied TeXLive (2012) is extremely old. TeXLive should be
installed from `upstream <https://www.tug.org/texlive/quickinstall.html>`__.
**TeXLive is not required for the "slides" or "print" style.** `Fira Sans
<https://bboxtype.com/typefaces/FiraSans/>`__ and `Iosevka
<https://github.com/be5invis/Iosevka/releases/>`__ should be installed
for these styles to appear as intended. However, neither is *necessary*.
Raw data
{
"_id": null,
"home_page": null,
"name": "atlas-mpl-style",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "plotting, atlas, matplotlib, cern, root, hep, high-energy-physics, physics",
"author": null,
"author_email": "Beojan Stanislaus <beojan.stanislaus@cern.ch>",
"download_url": "https://files.pythonhosted.org/packages/97/cb/a73ae881773e9715c070ca02f4694af190cea559abb4ba763940c24491ad/atlas_mpl_style-0.24.1.tar.gz",
"platform": null,
"description": "ATLAS Matplotlib Style\n======================\n.. image:: https://img.shields.io/pypi/v/atlas-mpl-style?label=PyPI&style=for-the-badge :alt: PyPI \n\n**Despite the last commit date, this package is still maintained. If you have any comments or improvements, open an issue or PR.**\n\nProvides a Matplotlib style replicating that used by the\n`ATLAS <http://atlas.cern>`__ collaboration.\n\n**Please open an issue if you find this style deviates from the guidelines.**\n\nInstall from PyPI using pip: :code:`pip install atlas-mpl-style`\n\nDocumentation: https://atlas-mpl.readthedocs.io/en/latest/index.html\n\nIn addition, this package also provides:\n\n- A function to draw the ATLAS label\n- A ``plot`` module containing functions to plot pre-binned histograms and\n limits. This includes functionality for plotting stacked backgrounds along\n with data and ratios in the usual ATLAS style.\n- A matplotlib style based on the background / foreground from the VIM `Paper <https://github.com/NLKNguyen/papercolor-theme>`__ color scheme, along with a print version with a white background.\n - The default color cycle in all three styles is generated with HCL Wizard\n\n- Additional Matplotlib color definitions based on the Paper theme, and the\n `Oceanic Next <https://github.com/voronianski/oceanic-next-color-scheme>`__\n theme\n\nUHI and the PlottableHistogram protocol\n----------------------------------------- \n\nWith the development of the `UHI <https://github.com/henryiii/uhi>`__ interface,\nthis package now has support for histogram objects that follow the\n``PlottableHistogram`` protocol. ``plot.Background`` objects can be constructed\nusing ``PlottableHistograms`` and a list of such ``Backgrounds`` can be passed\nto ``plot.plot_backgrounds`` omitting the ``bins`` argument. The other histogram\nplotting functions could not be modified to accept ``PlottableHistogram`` in a\nbackward compatible manner since they take ``bins`` before the histogram\nargument. Alternate versions of these functions are therefore provided in the\n``uhi`` module.\n\nAs a result of this support, the histogram objects returned by `Uproot 4\n<https://github.com/scikit-hep/uproot4>`__ can be plotted directly, as can\n`Boost-Histogram <https://github.com/scikit-hep/boost-histogram>`__ histograms\nand `Hist <https://github.com/scikit-hep/hist>`__ objects (once the relevent PRs\nare merged into those repositories).\n\n\n``usetex=False`` Mode\n------------------------\n\n``usetex=False`` is now the default, removing the LaTeX dependency.\n\nIf you convert a plotting script that uses ``usetex=True`` mode, make sure labels\nare updated to remove LaTeX macros that are not supported by Matplotlib's\nmathtext.\n\n\nTeXLive and Fonts Needed\n------------------------\nIf you have a full LaTeX installation available, you can use LaTeX to typeset the text by passing ``usetex=True`` to ``use_atlas_style``. This will give you much greater options in terms of what can\nbe included in labels.\n\nA working TeXLive installation providing the following is required:\n\n- pdflatex\n- amsmath\n- TeX Gyre Heros\n- mathastext\n- physics (the package)\n- siunitx\n\nIf no LaTeX installation is available, the style will warn and fall back to the ``usetex=False`` behaviour.\nTo check if all necessary packages are installed, try building ``atlas_mpl_style/testing/ampl-test.tex``.\n\nOn Arch (and related distributions), the ``texlive-most`` group is sufficient.\n\nOn Debian (Jessie or above) or Ubuntu (18.04+), the following set of packages should be sufficient. It is however highly recommended\nthat you install `texlive-full` to obtain a complete installation of texlive.\n\n- texlive\n- texlive-latex-extra\n- texlive-fonts-recommended\n- texlive-lang-greek\n- tex-gyre\n- dvipng\n- ghostscript\n\nOn CentOS 7, the supplied TeXLive (2012) is extremely old. TeXLive should be\ninstalled from `upstream <https://www.tug.org/texlive/quickinstall.html>`__.\n\n**TeXLive is not required for the \"slides\" or \"print\" style.** `Fira Sans\n<https://bboxtype.com/typefaces/FiraSans/>`__ and `Iosevka\n<https://github.com/be5invis/Iosevka/releases/>`__ should be installed\nfor these styles to appear as intended. However, neither is *necessary*.\n",
"bugtrack_url": null,
"license": null,
"summary": "ATLAS style for Matplotlib 3.0+",
"version": "0.24.1",
"project_urls": {
"Documentation": "https://atlas-mpl.readthedocs.io/en/latest/",
"Home": "https://github.com/beojan/atlas-mpl"
},
"split_keywords": [
"plotting",
" atlas",
" matplotlib",
" cern",
" root",
" hep",
" high-energy-physics",
" physics"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3f8d52aa1a2753531be55d7be0396c19faf11a2c3221d6b2ee22fd8d4ab0d091",
"md5": "e257cfd38d23bf58b01af4f7b3df6c3a",
"sha256": "d3704445b5a0e7e287453901199f32a4edb128de24c5f2075d290f1d12a99577"
},
"downloads": -1,
"filename": "atlas_mpl_style-0.24.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e257cfd38d23bf58b01af4f7b3df6c3a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 37650,
"upload_time": "2024-12-20T10:42:16",
"upload_time_iso_8601": "2024-12-20T10:42:16.420494Z",
"url": "https://files.pythonhosted.org/packages/3f/8d/52aa1a2753531be55d7be0396c19faf11a2c3221d6b2ee22fd8d4ab0d091/atlas_mpl_style-0.24.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "97cba73ae881773e9715c070ca02f4694af190cea559abb4ba763940c24491ad",
"md5": "f3fdf80f1749c74a43b84f31aa8fb0ec",
"sha256": "a411104f5670d29d20fce7a004ecdcd64fa65126ff67773cf7ad6863be699ec9"
},
"downloads": -1,
"filename": "atlas_mpl_style-0.24.1.tar.gz",
"has_sig": false,
"md5_digest": "f3fdf80f1749c74a43b84f31aa8fb0ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 147904,
"upload_time": "2024-12-20T10:42:19",
"upload_time_iso_8601": "2024-12-20T10:42:19.414449Z",
"url": "https://files.pythonhosted.org/packages/97/cb/a73ae881773e9715c070ca02f4694af190cea559abb4ba763940c24491ad/atlas_mpl_style-0.24.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 10:42:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "beojan",
"github_project": "atlas-mpl",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "atlas-mpl-style"
}
JSON
