| Name | scientific-plots JSON |
| Version |
1.8.3
JSON |
| download |
| home_page | None |
| Summary | Useful methods for plots used in science |
| upload_time | 2024-06-06 14:28:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. |
| keywords |
plotting
science
library
utilities
styling
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Scientific Plots
Create and save plots in scientific style
## Table of Contents
[[_TOC_]]
## Overview
This python module includes useful methods and definitions for various python
projects.
The focus lies of on the automatic creation of a set of plots, which are
designed to be used in scientific journals, dissertations and presentations.
The most important components are the definitions of types compatible
for numpy, located in `types_.py`, and the typing stubs in `stubs/`. These
typing stubs are also distributed in this package.
## Plotting
The easiest way to implement the plotting features provided by this library, is
to use one of the predefined function in `scientific_plots.default_plots`.
Alternatively, any plotting functions can be decorated by using the
`apply_styles` decorator in `scientific_plots.plot_settings`.
For example, this could look like this:
```
import matplotlib.pyplot as plt
from scientific_plots.plot_settings import apply_styles
@apply_styles
def plot_something() -> None:
"""Example function."""
plt.plot(...)
...
plt.savefig("subfolder/your_plot_name.pdf")
```
The script will create a bunch of plots and place them in the given location
next to your given path. Thus, it is advisable to create a different subfolder
for new plots.
For three-dimensional plots, it is recommended to set the optional argument
*three_d* of the decorator to true:
```
@apply_styles(three_d=True)
def plot_function():
...
```
Alternatively, this package provides default plot settings in the submodule
*default_plots*. The provided function apply a default design, which should
look good in most situations.
```
from scientific_plots.default_plots import plot
plot(x, y, "x_label", "y_label", "subfolder/filename.pdf")
```
Besides this simple plot, this library also provides the following default
plots:
`plot_fit`: Plot data and a fit of this data.
```
def fit_function(x):
...
# fit some data
...
return y
plot_fit(
x, y, fit_function, "x_label", "y_label",
"subfolder"/"filename.pdf")`
```
`two_plots`: Plot two curves sharing a single y-axis.
```
two_plots(
x1, y1, "label1",
x2, y2, "label2",
"xlabel", "ylabel", "subfolder"/"filename".pdf)
```
`two_axis_plots`: Plot two curves with two y-axis in a single graph.
```
two_axis_plots(
x1, y1, "label1",
x2, y2, "label2",
"xlabel", "ylabel1", "ylabel2",
"subfolder"/"filename".pdf)
```
All of those functions have the following command-line arguments:
- `logscale`: Plot the data double logarithmic.
- `single_log`: Plot the x-axis logarithmic.
- `single_log_y`: Plot the y-axis logarithmic.
- `xlim`: Set the limits on the x-axis manually.
- `ylim`: Set the limits on the y-axis manually.
### Preview-Mode
It is possible to only create a single plot for every called plot function
to save computation time. This 'preview' mode can be called by setting the
following global variable in `scientific_plots.plot_settings` to true:
```
import scientifc_plots.plot_settings
scientifc_plots.plot_settings.PREVIEW = True
```
## Types
Additional Vector like types for numpy-arrays are provided in
`scientifc_plots.types_`. These types can be used for static type checking
using mypy.
## Typing Stubs
Addtional typing stubs for scipy, matplotlib and numba are provided and
installed by this package. These packages do not provide type hints on their
own.
Raw data
{
"_id": null,
"home_page": null,
"name": "scientific-plots",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Plotting, science, library, utilities, styling",
"author": null,
"author_email": "Felix Fischer <f.fischer@ifas.rwth-aachen.de>",
"download_url": "https://files.pythonhosted.org/packages/7b/fd/a16ab080da8145360d4d970a3ca0b99040be055cce845257f1ac85689ce5/scientific_plots-1.8.3.tar.gz",
"platform": null,
"description": "# Scientific Plots\nCreate and save plots in scientific style\n\n## Table of Contents\n[[_TOC_]]\n\n## Overview\nThis python module includes useful methods and definitions for various python\nprojects.\nThe focus lies of on the automatic creation of a set of plots, which are\ndesigned to be used in scientific journals, dissertations and presentations.\nThe most important components are the definitions of types compatible\nfor numpy, located in `types_.py`, and the typing stubs in `stubs/`. These\ntyping stubs are also distributed in this package.\n\n## Plotting\nThe easiest way to implement the plotting features provided by this library, is\nto use one of the predefined function in `scientific_plots.default_plots`.\nAlternatively, any plotting functions can be decorated by using the\n`apply_styles` decorator in `scientific_plots.plot_settings`.\n\nFor example, this could look like this:\n```\nimport matplotlib.pyplot as plt\nfrom scientific_plots.plot_settings import apply_styles\n\n@apply_styles\ndef plot_something() -> None:\n \"\"\"Example function.\"\"\"\n plt.plot(...)\n ...\n plt.savefig(\"subfolder/your_plot_name.pdf\")\n```\n\nThe script will create a bunch of plots and place them in the given location\nnext to your given path. Thus, it is advisable to create a different subfolder\nfor new plots.\n\nFor three-dimensional plots, it is recommended to set the optional argument\n*three_d* of the decorator to true:\n```\n@apply_styles(three_d=True)\ndef plot_function():\n ...\n```\n\nAlternatively, this package provides default plot settings in the submodule\n*default_plots*. The provided function apply a default design, which should\nlook good in most situations.\n\n```\nfrom scientific_plots.default_plots import plot\n\nplot(x, y, \"x_label\", \"y_label\", \"subfolder/filename.pdf\")\n```\n\nBesides this simple plot, this library also provides the following default\nplots:\n`plot_fit`: Plot data and a fit of this data.\n```\ndef fit_function(x):\n ...\n # fit some data\n ...\n return y\n\nplot_fit(\n x, y, fit_function, \"x_label\", \"y_label\",\n \"subfolder\"/\"filename.pdf\")`\n```\n\n`two_plots`: Plot two curves sharing a single y-axis.\n```\ntwo_plots(\n x1, y1, \"label1\",\n x2, y2, \"label2\",\n \"xlabel\", \"ylabel\", \"subfolder\"/\"filename\".pdf)\n```\n\n`two_axis_plots`: Plot two curves with two y-axis in a single graph.\n```\ntwo_axis_plots(\n x1, y1, \"label1\",\n x2, y2, \"label2\",\n \"xlabel\", \"ylabel1\", \"ylabel2\",\n \"subfolder\"/\"filename\".pdf)\n```\n\nAll of those functions have the following command-line arguments:\n- `logscale`: Plot the data double logarithmic.\n- `single_log`: Plot the x-axis logarithmic.\n- `single_log_y`: Plot the y-axis logarithmic.\n- `xlim`: Set the limits on the x-axis manually.\n- `ylim`: Set the limits on the y-axis manually.\n\n### Preview-Mode\nIt is possible to only create a single plot for every called plot function\nto save computation time. This 'preview' mode can be called by setting the\nfollowing global variable in `scientific_plots.plot_settings` to true:\n```\nimport scientifc_plots.plot_settings\nscientifc_plots.plot_settings.PREVIEW = True\n```\n\n## Types\nAdditional Vector like types for numpy-arrays are provided in\n`scientifc_plots.types_`. These types can be used for static type checking\nusing mypy.\n\n## Typing Stubs\nAddtional typing stubs for scipy, matplotlib and numba are provided and\ninstalled by this package. These packages do not provide type hints on their\nown.\n",
"bugtrack_url": null,
"license": "GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, \"this License\" refers to version 3 of the GNU Lesser General Public License, and the \"GNU GPL\" refers to version 3 of the GNU General Public License. \"The Library\" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An \"Application\" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A \"Combined Work\" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the \"Linked Version\". The \"Minimal Corresponding Source\" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The \"Corresponding Application Code\" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License \"or any later version\" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. ",
"summary": "Useful methods for plots used in science",
"version": "1.8.3",
"project_urls": {
"Bug Tracker": "https://git.rwth-aachen.de/pneumatics/python_module/-/issues",
"Homepage": "https://git.rwth-aachen.de/pneumatics/python_module"
},
"split_keywords": [
"plotting",
" science",
" library",
" utilities",
" styling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "48cbdd191b92512cf1a7bbf56a11703bc06b3bb5cb9acb908f1ba23e2669453a",
"md5": "a6fad7cb58ca388b0dfbb5d2b2f65d61",
"sha256": "828d848e4e6e9cd5f18832c86382d3d455d5330eea1ee29caeb271057e0e759b"
},
"downloads": -1,
"filename": "scientific_plots-1.8.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6fad7cb58ca388b0dfbb5d2b2f65d61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 37906,
"upload_time": "2024-06-06T14:28:20",
"upload_time_iso_8601": "2024-06-06T14:28:20.064783Z",
"url": "https://files.pythonhosted.org/packages/48/cb/dd191b92512cf1a7bbf56a11703bc06b3bb5cb9acb908f1ba23e2669453a/scientific_plots-1.8.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7bfda16ab080da8145360d4d970a3ca0b99040be055cce845257f1ac85689ce5",
"md5": "e3462c9e1b370ae0cdb7c6efed93c8b6",
"sha256": "7a9b836a41a190ab5d0e123f9551ed13ee6c2c99d57df60eed0b63a230971238"
},
"downloads": -1,
"filename": "scientific_plots-1.8.3.tar.gz",
"has_sig": false,
"md5_digest": "e3462c9e1b370ae0cdb7c6efed93c8b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 34499,
"upload_time": "2024-06-06T14:28:21",
"upload_time_iso_8601": "2024-06-06T14:28:21.983735Z",
"url": "https://files.pythonhosted.org/packages/7b/fd/a16ab080da8145360d4d970a3ca0b99040be055cce845257f1ac85689ce5/scientific_plots-1.8.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-06 14:28:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "scientific-plots"
}
