Skip to main content

Scientific theme of Matplotlib for publication

Project description

scimorph: theme_publication

PyPI version PyPI version
conda-forge version conda-forge version

Warning : The scimorph library requires LaTeX for math formatting. Install it using: sudo apt install texlive texlive-latex-extra texlive-fonts-recommended cm-super dvipng. : Starting with version 1.0.0, you must add import scimorph before setting the style with theme_publication('publication').

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 tutorials of scimorph here.

Getting Started

The easiest way to install scimorph is by using pip:

# to install the latest release (from PyPI)
pip install scimorph

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

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

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

Notes:

  • scimorph-theme_publication requires matplotlib or seaborn

Using the Styles

"publication" 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 scimorph

theme_publication('publication')

Examples

import matplotlib.pyplot as plt
import numpy as np
from pathlib import Path
from scimorph.theme_publication import theme_publication
dir = Path.cwd()
print('parent dir: ',dir)

x = np.linspace(0, 2 * np.pi, 500)
y = np.sin(x)
# df = pd.DataFrame({'x': x, 'y': y})

theme_publication('publication', 
                    figsize='medium', 
                    fontsize=None, 
                    grid=True,
                    border=True)
plt.plot(x, y)
plt.xlabel('x')
plt.ylabel('y')
plt.savefig(f'{dir}/examples/plots/fig01a.jpg')
plt.show()

The basic publication style is shown below:

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

Citing scimorph:

@article{scimorph,
  author       = {Haihui Zhang et al},
  title        = {haihuilab/scimorph},
  month        = Jan,
  year         = 2025,
  publisher    = {github},
  version      = {1.0.0},      
  url          = {https://github.com/haihuilab/scimorph}
}

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

scimorph-1.0.2.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

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

scimorph-1.0.2-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file scimorph-1.0.2.tar.gz.

File metadata

  • Download URL: scimorph-1.0.2.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.2

File hashes

Hashes for scimorph-1.0.2.tar.gz
Algorithm Hash digest
SHA256 6fe8030761608a17f194876af7f4f434f91aff4ddf3d0e0bffc98ce4a4df0263
MD5 be74551d3bb90adc422319c722f62ba0
BLAKE2b-256 ccb102fc525b32dbd2aa75b363011cf8fcad844558069751bd4eb5ac17bf7e12

See more details on using hashes here.

File details

Details for the file scimorph-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: scimorph-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.2

File hashes

Hashes for scimorph-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 faa70cea4f3236ef2483a795134c1418a2e7dd6d9053b66fbf054e445a4e0598
MD5 71c120ca947dd349d9e866a5a2d109a2
BLAKE2b-256 0b728c0c5820aa251d954c234aff23507646f29de203880b291a6f7f315f3150

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