plotter


Nameplotter JSON
Version 1.3.20 PyPI version JSON
download
home_pagehttps://plotter-doc.xyz
SummaryPlotting library with descriptive approach
upload_time2022-11-16 09:56:08
maintainer
docs_urlNone
authorThomas Trouchkine
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Plotter

## Generate this README
- in html: `make html-readme` then open `README.html` in web browser, `firefox README.html` for instance.
- in pdf: `make pdf-readme`

## Description
Plotter is a plotting library based on `matplotlib`. It intends to simplify the plotting of data in Python by creating a descriptive approach for plots. The plots can be static or dynamic.

## Source code location
[https://github.com/T-TROUCHKINE/plotter](https://github.com/T-TROUCHKINE/plotter)

## Prerequisities
### Linux packages
- tk :
  - ArchLinux : `pacman -S tk`
  - Debian : `apt install tk`

### Python modules
- matplotlib : `pip install matplotlib`
- tikzplotlib : `pip install tikzplotlib`
- numpy : `pip install numpy`

**GTK3**  
For using GTK3 modules: see PyGObject documentation:
[https://pygobject.readthedocs.io/en/latest/index.html](https://pygobject.readthedocs.io/en/latest/index.html)

## Installation
### From PIP
`pip install plotter`

### From source
`python3 setup.py install`

## Examples
### Simplest example:
The code:
```python
import numpy as np
from plotter import Plotter

x = np.linspace(-np.pi, np.pi, 201)

to_plot = [{
    "title": "Example",
    "type": "plot",
    "data": [x, np.sin(x)]
}]

pl = Plotter(to_plot)
pl.show()
```
Gives:

![First example](img/ex1.png)

### Multi-plot:
The code:
```python
import numpy as np
from plotter import Plotter

x = np.linspace(-np.pi, np.pi, 201)

to_plot = [{
    "title": "Example 1",
    "type": "plot",
    "data": [x, np.sin(x)]
},
{
    "title": "Example 2",
    "type": "matrix",
    "data": np.random.random((100,100))
}]

pl = Plotter(to_plot, figsuptitle="Multi-plot")
pl.show()
```
Gives:

![Second example](img/ex2.png)

## Documentation
Online documentation at [https://plotter-doc.xyz](https://plotter-doc.xyz)

### Build documentation locally

#### Requirements
- jekyll ([https://jekyllrb.com/](https://jekyllrb.com/))
- bundler ([https://bundler.io/](https://bundler.io/))

#### Command
```sh
cd doc
bundle exec jekyll build
```

Then the documentation is accessible in the `doc/_site/` directory. Usable using
a web browser for instance: `firefox doc/_site/index.html`

            

Raw data

            {
    "_id": null,
    "home_page": "https://plotter-doc.xyz",
    "name": "plotter",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Thomas Trouchkine",
    "author_email": "thomas.trouchkine@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b4/6d/2909ed953c678dbc3f756e74d951fe81b0a5301f3df6ac52680a6d1c81e6/plotter-1.3.20.tar.gz",
    "platform": null,
    "description": "# Plotter\n\n## Generate this README\n- in html: `make html-readme` then open `README.html` in web browser, `firefox README.html` for instance.\n- in pdf: `make pdf-readme`\n\n## Description\nPlotter is a plotting library based on `matplotlib`. It intends to simplify the plotting of data in Python by creating a descriptive approach for plots. The plots can be static or dynamic.\n\n## Source code location\n[https://github.com/T-TROUCHKINE/plotter](https://github.com/T-TROUCHKINE/plotter)\n\n## Prerequisities\n### Linux packages\n- tk :\n  - ArchLinux : `pacman -S tk`\n  - Debian : `apt install tk`\n\n### Python modules\n- matplotlib : `pip install matplotlib`\n- tikzplotlib : `pip install tikzplotlib`\n- numpy : `pip install numpy`\n\n**GTK3**  \nFor using GTK3 modules: see PyGObject documentation:\n[https://pygobject.readthedocs.io/en/latest/index.html](https://pygobject.readthedocs.io/en/latest/index.html)\n\n## Installation\n### From PIP\n`pip install plotter`\n\n### From source\n`python3 setup.py install`\n\n## Examples\n### Simplest example:\nThe code:\n```python\nimport numpy as np\nfrom plotter import Plotter\n\nx = np.linspace(-np.pi, np.pi, 201)\n\nto_plot = [{\n    \"title\": \"Example\",\n    \"type\": \"plot\",\n    \"data\": [x, np.sin(x)]\n}]\n\npl = Plotter(to_plot)\npl.show()\n```\nGives:\n\n![First example](img/ex1.png)\n\n### Multi-plot:\nThe code:\n```python\nimport numpy as np\nfrom plotter import Plotter\n\nx = np.linspace(-np.pi, np.pi, 201)\n\nto_plot = [{\n    \"title\": \"Example 1\",\n    \"type\": \"plot\",\n    \"data\": [x, np.sin(x)]\n},\n{\n    \"title\": \"Example 2\",\n    \"type\": \"matrix\",\n    \"data\": np.random.random((100,100))\n}]\n\npl = Plotter(to_plot, figsuptitle=\"Multi-plot\")\npl.show()\n```\nGives:\n\n![Second example](img/ex2.png)\n\n## Documentation\nOnline documentation at [https://plotter-doc.xyz](https://plotter-doc.xyz)\n\n### Build documentation locally\n\n#### Requirements\n- jekyll ([https://jekyllrb.com/](https://jekyllrb.com/))\n- bundler ([https://bundler.io/](https://bundler.io/))\n\n#### Command\n```sh\ncd doc\nbundle exec jekyll build\n```\n\nThen the documentation is accessible in the `doc/_site/` directory. Usable using\na web browser for instance: `firefox doc/_site/index.html`\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Plotting library with descriptive approach",
    "version": "1.3.20",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7e5fb233e730ff0c0d32290a10a31ecbf5ae9b2528b7bb3c01b65badb650cb57",
                "md5": "98cef94fa249604c29dbed772d5f774f",
                "sha256": "821a933a237415bd42ffe34ce5ec1c35c1ba2ddf318d97f05170c0f7cede9fac"
            },
            "downloads": -1,
            "filename": "plotter-1.3.20-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "98cef94fa249604c29dbed772d5f774f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 11822,
            "upload_time": "2022-11-16T09:56:06",
            "upload_time_iso_8601": "2022-11-16T09:56:06.905260Z",
            "url": "https://files.pythonhosted.org/packages/7e/5f/b233e730ff0c0d32290a10a31ecbf5ae9b2528b7bb3c01b65badb650cb57/plotter-1.3.20-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b46d2909ed953c678dbc3f756e74d951fe81b0a5301f3df6ac52680a6d1c81e6",
                "md5": "3c4109d2dfeff3f049b87427e53c683c",
                "sha256": "3a93cd1c4a775c6fb0176cb1c067bd01b4a645918e429924858edb4cadc574b2"
            },
            "downloads": -1,
            "filename": "plotter-1.3.20.tar.gz",
            "has_sig": false,
            "md5_digest": "3c4109d2dfeff3f049b87427e53c683c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12012,
            "upload_time": "2022-11-16T09:56:08",
            "upload_time_iso_8601": "2022-11-16T09:56:08.753628Z",
            "url": "https://files.pythonhosted.org/packages/b4/6d/2909ed953c678dbc3f756e74d951fe81b0a5301f3df6ac52680a6d1c81e6/plotter-1.3.20.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-11-16 09:56:08",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "plotter"
}
        
Elapsed time: 0.13416s