mplunitx


Namemplunitx JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryUnits in python strings for matplotlib labels
upload_time2024-02-15 15:25:20
maintainer
docs_urlNone
authorAdrian Peter Krone
requires_python>=3.9
license"MIT"
keywords matplotlib siunitx latex
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            mplunitx
========

.. image:: https://img.shields.io/badge/version-0.1.0-blue
   :target: https://img.shields.io/badge/version-0.1.0-blue
.. image:: https://img.shields.io/badge/License-MIT-blue
   :target: https://github.com/exp4-age/agepy/blob/main/LICENSE

*mplunitx* is a Python package heavily inspired by the LaTeX
package `siunitx`_ intended to be used complementary with *matplotlib*.

*matplotlib* supports some LaTeX in its text rendering,
but not the use of *siunitx*. Using *siunitx* is possible with
``text.usetex=True`` in the *matplotlib* rc settings, but this needs a
local installation of LaTeX and keeping the fonts consistent is not trivial.
*mplunitx* aims to provide a similar functionality to *siunitx* by
imitating the ``\num``, ``\unit`` and ``\qty`` commands with python functions,
which return strings with LaTeX code that *matplotlib* understands.

For the labels of the axes, the *mplunitx* package additionally provides
a function for typesetting the variable name and unit with either ``"/"`` in
between or ``"[]"`` around the unit.


Installation
------------

Install with ::

   pip install mplunitx

Usage
-----

See `documentation`_.

.. _documentation: https://mplunitx.readthedocs.io/en/latest/
.. _siunitx: https://ctan.org/pkg/siunitx?lang=en

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "mplunitx",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "matplotlib,siunitx,latex",
    "author": "Adrian Peter Krone",
    "author_email": "adrian.krone@physik.uni-kassel.de",
    "download_url": "https://files.pythonhosted.org/packages/b7/13/92697c4950277a7a176022c17ba2be8f78885051323bd3a3149973135203/mplunitx-0.1.0.tar.gz",
    "platform": null,
    "description": "mplunitx\n========\n\n.. image:: https://img.shields.io/badge/version-0.1.0-blue\n   :target: https://img.shields.io/badge/version-0.1.0-blue\n.. image:: https://img.shields.io/badge/License-MIT-blue\n   :target: https://github.com/exp4-age/agepy/blob/main/LICENSE\n\n*mplunitx* is a Python package heavily inspired by the LaTeX\npackage `siunitx`_ intended to be used complementary with *matplotlib*.\n\n*matplotlib* supports some LaTeX in its text rendering,\nbut not the use of *siunitx*. Using *siunitx* is possible with\n``text.usetex=True`` in the *matplotlib* rc settings, but this needs a\nlocal installation of LaTeX and keeping the fonts consistent is not trivial.\n*mplunitx* aims to provide a similar functionality to *siunitx* by\nimitating the ``\\num``, ``\\unit`` and ``\\qty`` commands with python functions,\nwhich return strings with LaTeX code that *matplotlib* understands.\n\nFor the labels of the axes, the *mplunitx* package additionally provides\na function for typesetting the variable name and unit with either ``\"/\"`` in\nbetween or ``\"[]\"`` around the unit.\n\n\nInstallation\n------------\n\nInstall with ::\n\n   pip install mplunitx\n\nUsage\n-----\n\nSee `documentation`_.\n\n.. _documentation: https://mplunitx.readthedocs.io/en/latest/\n.. _siunitx: https://ctan.org/pkg/siunitx?lang=en\n",
    "bugtrack_url": null,
    "license": "\"MIT\"",
    "summary": "Units in python strings for matplotlib labels",
    "version": "0.1.0",
    "project_urls": {
        "GitHub": "https://github.com/adryyan/mplunitx",
        "docs": "https://mplunitx.readthedocs.io/en/latest/,"
    },
    "split_keywords": [
        "matplotlib",
        "siunitx",
        "latex"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6cc00b7b0e8a2e047a3adb2326a985260dcf59f31c000a522a171a6a31a72fa3",
                "md5": "3e61ea96d9bf1199a4935b435ca14361",
                "sha256": "603d4f1fcf4fec75c7c23ee6efa563aaf9a21facbad6463a389e530704c3fbe3"
            },
            "downloads": -1,
            "filename": "mplunitx-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3e61ea96d9bf1199a4935b435ca14361",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 10008,
            "upload_time": "2024-02-15T15:25:18",
            "upload_time_iso_8601": "2024-02-15T15:25:18.745758Z",
            "url": "https://files.pythonhosted.org/packages/6c/c0/0b7b0e8a2e047a3adb2326a985260dcf59f31c000a522a171a6a31a72fa3/mplunitx-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b71392697c4950277a7a176022c17ba2be8f78885051323bd3a3149973135203",
                "md5": "2b5be208886f93266b7442e81d09c94b",
                "sha256": "4ea1114e4e00d95e638040832ec832f79cbd65e8be06e098d860ffd8cdb744a8"
            },
            "downloads": -1,
            "filename": "mplunitx-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2b5be208886f93266b7442e81d09c94b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 9522,
            "upload_time": "2024-02-15T15:25:20",
            "upload_time_iso_8601": "2024-02-15T15:25:20.992734Z",
            "url": "https://files.pythonhosted.org/packages/b7/13/92697c4950277a7a176022c17ba2be8f78885051323bd3a3149973135203/mplunitx-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-15 15:25:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adryyan",
    "github_project": "mplunitx",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mplunitx"
}
        
Elapsed time: 2.50289s