Skip to main content

This is a fork of scienceplots and provides a range of matplotlib styles for plotting physics...

Project description

Stoner Plots

GitHub version pytest Codacy Badge PyPI version Build Docs Conda Conda Version Not platform specific MIT Licensed DOI

Stoner Plots is a fork of Science Plots with additional features to make plotting of scientific plots easier.

Presentation Style Image

Usage

Before using the new styles you need to import stonerplots - but you will most likely also want to make use of one of the context managers - the SavedFigure class.

from stonerplots import SavedFigure

with SavedFigure("my_figure.pdf", style=["stoner","aps"]):
    plt.figure()
    plt.plot(x,y,label="Dataset")
    ...

There are three main parts to this package:

  1. A set of matplotlib style sheets for making plots with styles suitable for a variety of Physics related journals and formats such as presentations and posters as well as reports and theses.

  2. A set of Python Context managers designed to help with the process of preparing production quality figures in matplotlib.

  3. Some definitions of colours based on the Transport for London colour palette and inserted as named colours into the matplotlib colour tables.

The package is fully documented (see link below) and comes with a set of examples that also serve as unit tests.

Documentation

Documentation can be found on the github pages for this repository.

Available Styles

Core Styles

  • stoner - this is the base style sheet
  • poster - makes everything bigger for printing on a poster
  • notebook - makes things a little bigger for a Jupyter notebook - from the original scienceplots package
  • presentation - a style suitable for the main graph on a powerpoint slide
  • thesis - a style that tries to look like the CM Physics group LaTeX thesis template

Journal Styles

  • nature - for Nature group journals - from the original scienceplots package
  • aaas-science - Science single column style.
  • ieee - for IEEE Transactions journals - from the original scienceplots package
  • aps - for American Physical Society Journals (like Phys Rev Lett etc.)
  • aip - for AIP journals such as Applied Physics Letters - labels in Serif Fonts
  • iop - for Institute of Physics Journals.

Modifiers

  • aps1.5 - Switch to 1.5 column wide format
  • aps2.0 - Switch to 2 column wide format
  • aip2 - Switch to 2 column wide format for AIP journals
  • stoner-dark - Switch to a dark background a lighter plotting colours.
  • hi-res - Switches to 600dpi plotting (but using eps, pdf or svg is generally a better option)
  • med-res - like hi-res, but switches to 300dpi plotting.
  • presentation_sm - a style for making 1/2 width graphs.
  • presentation_dark - tweak the weight of elements for dark presentations.
  • science-2col, science-3col - Science 2 and 3 column width figures
  • thesis-sm - reduces the figure width to make the axes closer to 4/3 aspect ratio.

Context Managers

The package is designed to work by using python context managers to aid plotting. These include:

  • SavedFigure - apply style sheets and then save any resulting figures to disc in one or more formats
  • CentredAxes - makes a plot where the axes cross at the origin and there is no outside frame.
  • StackVertical - make a multi-panel plot where the panels are arranged in a vertical stack and pushed together so that the top-x-axis on one frame is the bottom of the next.
  • MultiPanel - a general-purpose multi-panel plotting helper.
  • InsetPlot - create an inset set of axes.
  • DoubleYAxis - setup the righthand y axis for a second scale and optional colour the y-axes differently and merge the legend into a single legend.

Colour Cycles

The default colour cycle is based on the London Underground map colour scheme (why not?) and goes

  • Northern
  • Central
  • Picadily
  • District
  • Metropolitan
  • Bakerloo
  • Jubilee
  • Overground
  • Victoria
  • Elizabeth
  • Circle

Reference

The package adds these as named colours in matplotlib, along with 90,50,70 and 10% shade variants of some of them. See the documentation page on colours for a full list.

This package draws heavily on scienceplots, so it seems only fair to cite the original work....

@software{john_garrett_2023_10206719,
  author       = {John Garrett and
                  Echedey Luis and
                  H.-H. Peng and
                  Tim Cera and
                  gobinathj and
                  Josh Borrow and
                  Mehmet Keçeci and
                  Splines and
                  Suraj Iyer and
                  Yuming Liu and
                  cjw and
                  Mikhail Gasanov},
  title        = {garrettj403/SciencePlots: 2.1.1},
  month        = nov,
  year         = 2023,
  publisher    = {Zenodo},
  version      = {2.1.1},
  doi          = {10.5281/zenodo.10206719},
  url          = {https://doi.org/10.5281/zenodo.10206719},
}

The doi and BibTex reference for stonerplots is: https://doi.org/10.5281/zenodo.14026874

@software{gavin_burnell_2024_14026874,
  author       = {Gavin Burnell},
  title        = {stonerlab/stonerplots},
  month        = May,
  year         = 2025,
  publisher    = {Zenodo},
  version      = {v1.7.1},
  doi          = {10.5281/zenodo.14026874},
  url          = {https://doi.org/10.5281/zenodo.14026874},

}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stonerplots-1.9.2.tar.gz (3.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stonerplots-1.9.2-py3-none-any.whl (55.2 kB view details)

Uploaded Python 3

File details

Details for the file stonerplots-1.9.2.tar.gz.

File metadata

  • Download URL: stonerplots-1.9.2.tar.gz
  • Upload date:
  • Size: 3.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for stonerplots-1.9.2.tar.gz
Algorithm Hash digest
SHA256 5bcb71504182f9cda5213f2cc83db2698265810cbafb6d489b6baddde345c67e
MD5 c3ecfa31fcef279f7e81857b12f9eb06
BLAKE2b-256 00600648631802732825ed91b71f2e15cd1a62e880075cf4371e1538a1591233

See more details on using hashes here.

File details

Details for the file stonerplots-1.9.2-py3-none-any.whl.

File metadata

  • Download URL: stonerplots-1.9.2-py3-none-any.whl
  • Upload date:
  • Size: 55.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for stonerplots-1.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a02e773ef197b57a0954dad7218e4a60f40265272e64722d7d492915b59e9829
MD5 25737530fbc037f3b4e337f8e2f78f9b
BLAKE2b-256 4e46484e7e034974d5dffb23a76d7835d688c8bfd2755c6e05ccc36debe8f46a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page