Skip to content

Latest commit

 

History

History
197 lines (124 loc) · 11 KB

README.md

File metadata and controls

197 lines (124 loc) · 11 KB
Raw

Science Plots

Warning : As of version 2.0.0, you need to add import scienceplots before setting the style (plt.style.use('science')).

PyPI version DOI

Matplotlib styles for scientific figures

This repo has Matplotlib styles to format your figures for scientific papers, presentations and theses.

You can find the full gallery of included styles here.

Getting Started

The easiest way to install SciencePlots is by using pip:

# to install the lastest release (from PyPI)
pip install SciencePlots

# to install the lastest release (using Conda)
conda install -c conda-forge scienceplots

# to install the latest commit (from GitHub)
pip install git+https://github.com/garrettj403/SciencePlots

# to clone and install from a local copy
git clone https://github.com/garrettj403/SciencePlots.git
cd SciencePlots
pip install -e .

From version v1.1.0 on, import scienceplots is needed on top of your scripts so Matplotlib can make use of the styles.

Notes:

Please see the FAQ for more information and troubleshooting.

Using the Styles

"science" is the primary style in this repo. Whenever you want to use it, simply add the following to the top of your python script:

import matplotlib.pyplot as plt
import scienceplots

plt.style.use('science')

You can also combine multiple styles together by:

plt.style.use(['science','ieee'])

In this case, the ieee style will override some of the parameters from the science style in order to configure the plot for IEEE papers (column width, fontsizes, etc.).

To use any of the styles temporarily, you can use:

with plt.style.context('science'):
    plt.figure()
    plt.plot(x, y)
    plt.show()

Examples

The basic science style is shown below:

It can be cascaded with other styles to fine-tune the appearance. For example, the science + notebook styles (intended for Jupyter notebooks):

Please see the project Wiki for a full list of available styles.

Specific Styles for Academic Journals

The science + ieee styles for IEEE papers:

  • IEEE requires figures to be readable when printed in black and white. The ieee style also sets the figure width to fit within one column of an IEEE paper.

The science + nature styles for Nature articles:

  • Nature recommends sans-serif fonts.

Other languages

SciencePlots currently supports:

Example: Traditional Chinese (science + no-latex + cjk-tc-font):

See the FAQ for information on installing CJK fonts.

Other color cycles

SciencePlots comes with a variety of different color cycles. For a full list, see the project Wiki. Two examples are shown below.

The bright color cycle (color blind safe):

The high-vis color cycle:

Help and Contributing

Please feel free to contribute to the SciencePlots repo! For example, it would be good to add new styles for different journals and add new color cycles. Before starting a new style or making any changes, please create an issue through the GitHub issue tracker. That way we can discuss if the changes are necessary and the best approach.

If you need any help with SciencePlots, please first check the FAQ and search through the previous GitHub issues. If you can't find an answer, create a new issue through the GitHub issue tracker.

You can checkout Matplotlib's documentation for more information on plotting settings.

FAQ

You can find the FAQ in the project Wiki.

SciencePlots in Academic Papers

The following papers use SciencePlots:

If you use SciencePlots in your paper/thesis, feel free to add it to the list!

Citing SciencePlots

You don't have to cite SciencePlots if you use it but it's nice if you do:

@article{SciencePlots,
  author       = {John D. Garrett},
  title        = {{garrettj403/SciencePlots}},
  month        = sep,
  year         = 2021,
  publisher    = {Zenodo},
  version      = {1.0.9},
  doi          = {10.5281/zenodo.4106649},
  url          = {http://doi.org/10.5281/zenodo.4106649}
}