aesthetic 0.10__py3-none-any.whl

aesthetic/__init__.py

@@ -0,0 +1,23 @@
+"""Public API for aesthetic.
+
+Delay heavy imports so that packaging hooks can import this module without
+requiring matplotlib/numpy to already be installed.
+"""
+
+from __future__ import annotations
+
+__all__ = ["set_style", "savefig"]
+
+
+def set_style(*args, **kwargs):
+    """Proxy to ``plot.set_style`` with a lazy import."""
+    from .plot import set_style as _set_style
+
+    return _set_style(*args, **kwargs)
+
+
+def savefig(*args, **kwargs):
+    """Proxy to ``plot.savefig`` with a lazy import."""
+    from .plot import savefig as _savefig
+
+    return _savefig(*args, **kwargs)

aesthetic/paper.py

@@ -0,0 +1,50 @@
+from collections import OrderedDict
+
+def abbreviate_the_bibliography(input_bib, output_bib):
+    """
+    Zotero generates long journal names. Abbreviate them in bulk to conform to
+    the AAS style guide, and to have a shorter bibliography.
+
+    Args:
+        input_bib (str): path with long names, e.g., '/foo/bar/bibliography.bib'
+        output bib (str): path to be created, e.g., '/foo/bar/abbrev.bib'
+    """
+
+    mdict = OrderedDict({})
+
+    mdict['The Astrophysical Journal Letters'] = r'\apjl'
+    mdict['The Astrophysical Journal Supplement Series'] = r'\apjs'
+    mdict['The Astronomical Journal'] = r'\aj'
+    mdict['Annual Review of Astronomy and Astrophysics'] = r'\araa'
+    mdict['The Astrophysical Journal'] = r'\apj'
+    mdict['Publications of the Astronomical Society of the Pacific'] = r'\pasp'
+    mdict['Astronomy and Astrophysics'] = r'\aap'
+    mdict['Astronomy & Astrophysics'] = r'\aap'
+    mdict['Astronomy \& Astrophysics'] = r'\aap'
+    mdict['Monthly Notices of the Royal Astronomical Society: Letters'] = r'\mnras:l'
+    mdict['Monthly Notices of the Royal Astronomical Society'] = r'\mnras'
+    mdict['Nature'] = r'\nat'
+
+    # Sometimes, zotero randomly adds the arXiv ID as a note, even for
+    # published papers.
+    fdict = OrderedDict({})
+    fdict['note = {arXiv:'] = ''
+
+    with open(input_bib, 'r') as f:
+        lines = f.readlines()
+
+    for k,v in mdict.items():
+        for ix, l in enumerate(lines):
+            if k in l:
+                _newline = l.replace(k, v)
+                lines[ix] = _newline
+
+    for k in fdict.keys():
+        for ix, l in enumerate(lines):
+            if k in l:
+                lines.pop(ix)
+
+    with open(output_bib, 'w') as f:
+        f.writelines(lines)
+
+    print(f'made {output_bib}')

aesthetic/plot.py

@@ -0,0 +1,56 @@
+"""
+Plotting utilities that I re-use.
+
+Contents:
+    set_style
+    set_style_grid
+    savefig
+    format_ax
+"""
+import os as _os
+import numpy as np, matplotlib.pyplot as plt, matplotlib.style as _mplstyle, pandas as pd
+from datetime import datetime
+
+_styles_dir = _os.path.join(_os.path.dirname(__file__), 'styles')
+if _styles_dir not in _mplstyle.core.USER_LIBRARY_PATHS:
+    _mplstyle.core.USER_LIBRARY_PATHS.append(_styles_dir)
+    _mplstyle.reload_library()
+
+def set_style(stylelist=['science']):
+    """
+    Set styles using https://github.com/garrettj403/SciencePlots
+
+    Allowed in list:
+        'science', 'grid', 'ieee', 'scatter', 'notebook', 'no-latex',
+        'dark_background' + any matplotlib default styles (seaborn, etc).
+
+    Color cycles:
+        'high-vis', 'bright', 'vibrant', 'muted', 'retro'.
+    """
+    if isinstance(stylelist, str):
+        stylelist = [stylelist]
+    plt.style.use(stylelist)
+
+
+def savefig(fig, figpath, writepdf=True, dpi=450):
+    """
+    Wrapper to matplotlib's fig.savefig that i) makes both a png and a pdf, and
+    ii) prints the time at which the file was saved.
+    """
+    fig.savefig(figpath, dpi=dpi, bbox_inches='tight')
+    print(f'{datetime.utcnow().isoformat()}: made {figpath}')
+
+    if writepdf:
+        pdffigpath = figpath.replace('.png','.pdf')
+        fig.savefig(pdffigpath, bbox_inches='tight', dpi=dpi, pad_inches=0.05)
+        print(f'{datetime.utcnow().isoformat()}: made {pdffigpath}')
+
+    plt.close('all')
+
+
+def format_ax(ax):
+    ax.yaxis.set_ticks_position('both')
+    ax.xaxis.set_ticks_position('both')
+    ax.get_yaxis().set_tick_params(which='both', direction='in')
+    ax.get_xaxis().set_tick_params(which='both', direction='in')
+    ax.tick_params(axis='both', which='major', labelsize='small')

aesthetic/styles/clean.mplstyle

@@ -0,0 +1,56 @@
+# Matplotlib style for clean figures.
+
+# Figure size
+figure.figsize : 3.3, 2.5  # max width is 3.5 for single column
+
+# Set x axis
+xtick.direction : in
+#xtick.major.size : 3
+xtick.major.width : 0.65
+#xtick.minor.size : 1.5
+xtick.minor.width : 0.5
+xtick.minor.visible : False
+xtick.bottom : True
+
+# Set y axis
+ytick.direction : in
+#ytick.major.size : 3
+ytick.major.width : 0.65
+#ytick.minor.size : 1.5
+ytick.minor.width : 0.5
+ytick.minor.visible : False
+ytick.left : True
+
+## Font sizes
+#axes.labelsize: 8
+#xtick.labelsize: 7
+#ytick.labelsize: 7
+#legend.fontsize: 7
+#font.size: 7
+
+# Font Family
+font.family      : Arial
+mathtext.fontset : custom
+mathtext.rm      : Arial
+mathtext.it      : Arial:italic
+mathtext.bf      : Arial:bold
+mathtext.sf      : Arial
+
+## Always save as 'tight'
+#savefig.bbox : tight
+#savefig.pad_inches : 0.01  # Use virtually all space when we specify figure dimensions
+
+# LaTeX packages
+text.latex.preamble : \usepackage{amsmath} \usepackage{amssymb} \usepackage{sfmath}
+
+# Axis spines
+axes.spines.top:    False
+axes.spines.right:  False
+axes.spines.left:   True  # display axis spines
+axes.spines.bottom: True
+
+#axes.labelweight: bold
+# Set line widths
+axes.linewidth : 0.65
+grid.linewidth : 0.5
+lines.linewidth : 1.

aesthetic/styles/clean_wob.mplstyle

@@ -0,0 +1,71 @@
+# Matplotlib style: clean white on black.
+# In general, they advocate for all fonts to be sans serif
+# and all font sizes in a figure to be 7 pt and panel labels to be 8 pt bold.
+
+# Figure size
+figure.figsize : 3.3, 2.5  # max width is 3.5 for single column
+
+# Set x axis
+xtick.direction : in
+#xtick.major.size : 3
+xtick.major.width : 0.65
+#xtick.minor.size : 1.5
+xtick.minor.width : 0.5
+xtick.minor.visible : False
+xtick.bottom : True
+xtick.color : White
+
+# Set y axis
+ytick.direction : in
+#ytick.major.size : 3
+ytick.major.width : 0.65
+#ytick.minor.size : 1.5
+ytick.minor.width : 0.5
+ytick.minor.visible : False
+ytick.left : True
+ytick.color : White
+
+## Font sizes
+#axes.labelsize: 8
+#xtick.labelsize: 7
+#ytick.labelsize: 7
+#legend.fontsize: 7
+#font.size: 7
+
+# Font Family
+font.family      : Arial
+mathtext.fontset : custom
+mathtext.rm      : Arial
+mathtext.it      : Arial:italic
+mathtext.bf      : Arial:bold
+mathtext.sf      : Arial
+
+# Font color
+text.color: white
+axes.labelcolor: white
+
+# Background color
+figure.facecolor: black
+axes.facecolor: black
+
+## Always save as 'tight'
+#savefig.bbox : tight
+#savefig.pad_inches : 0.01  # Use virtually all space when we specify figure dimensions
+
+# LaTeX packages
+text.latex.preamble : \usepackage{amsmath} \usepackage{amssymb} \usepackage{sfmath}
+
+# Axis spines
+axes.spines.top:    False
+axes.spines.right:  False
+axes.spines.left:   True  # display axis spines
+axes.spines.bottom: True
+axes.edgecolor : white
+
+# Some might like to set:
+#axes.labelweight: bold
+
+# Set line widths
+axes.linewidth : 0.65
+grid.linewidth : 0.5
+lines.linewidth : 1.

aesthetic/styles/grid.mplstyle

@@ -0,0 +1,22 @@
+# Add grid lines and turn the legend frame on
+
+# Grid lines
+axes.grid : True
+grid.linestyle : :
+grid.color : k
+grid.alpha : 0.5
+grid.linewidth : 0.5
+
+# Legend
+legend.frameon : True
+legend.framealpha : 1.0
+legend.fancybox : True
+legend.numpoints : 1
+
+# Font Family
+font.family      : Arial
+mathtext.fontset : custom
+mathtext.rm      : Arial
+mathtext.it      : Arial:italic
+mathtext.bf      : Arial:bold
+mathtext.sf      : Arial

aesthetic/styles/notebook.mplstyle

@@ -0,0 +1,41 @@
+# Matplotlib style for Jupyter notebooks
+
+# # Set default figure size
+# figure.figsize : 8, 6
+
+# Set x axis
+xtick.major.size : 6
+xtick.major.width : 1
+xtick.minor.size : 3
+xtick.minor.width : 1
+
+# Set y axis
+ytick.major.size : 6
+ytick.major.width : 1
+ytick.minor.size : 3
+ytick.minor.width : 1
+
+# # Fontsizes
+# xtick.labelsize : 16
+# ytick.labelsize : 16
+# legend.fontsize : 16
+# legend.title_fontsize : 16
+# axes.titlesize : 16
+# axes.labelsize : 16
+
+# Set line widths
+axes.linewidth : 1
+grid.linewidth : 1
+lines.linewidth : 2.
+
+
+# Font Family
+font.family      : Arial
+mathtext.fontset : custom
+mathtext.rm      : Arial
+mathtext.it      : Arial:italic
+mathtext.bf      : Arial:bold
+mathtext.sf      : Arial
+
+# # Use LaTeX for math formatting
+# text.usetex : False

aesthetic/styles/scatter.mplstyle

@@ -0,0 +1,15 @@
+# Matplotlib style for scatter plots
+
+# Set markers (style, color, no lines)
+axes.prop_cycle : (cycler('marker', ['o', 's', '^', 'v', '<', '>', 'd']) + cycler('color', ['0C5DA5', '00B945', 'FF9500', 'FF2C00', '845B97', '474747', '9e9e9e']) + cycler('ls', [' ', ' ', ' ', ' ', ' ', ' ', ' ']))
+
+# # Set marker size
+# lines.markersize : 3
+
+# Font Family
+font.family      : Arial
+mathtext.fontset : custom
+mathtext.rm      : Arial
+mathtext.it      : Arial:italic
+mathtext.bf      : Arial:bold
+mathtext.sf      : Arial

aesthetic/styles/science.mplstyle

@@ -0,0 +1,66 @@
+# Matplotlib style for scientific plotting
+# This is the base style for "SciencePlots"
+# see: https://github.com/garrettj403/SciencePlots
+
+# Set color cycle: blue, green, yellow, red, violet, gray
+#axes.prop_cycle : cycler('color', ['0C5DA5', '00B945', 'FF9500', 'FF2C00', '845B97', '474747', '9e9e9e'])
+
+# # Set default figure size
+# figure.figsize : 3.5, 2.625
+
+# Set x axis
+xtick.direction : in
+xtick.major.size : 3
+xtick.major.width : 0.5
+xtick.minor.size : 1.5
+xtick.minor.width : 0.5
+xtick.minor.visible : True
+xtick.top : True
+
+# Set y axis
+ytick.direction : in
+ytick.major.size : 3
+ytick.major.width : 0.5
+ytick.minor.size : 1.5
+ytick.minor.width : 0.5
+ytick.minor.visible : True
+ytick.right : True
+
+# Set line widths
+axes.linewidth : 0.5
+grid.linewidth : 0.5
+lines.linewidth : 1.
+
+# Axis spines
+axes.spines.top:    True
+axes.spines.right:  True
+axes.spines.left:   True  # display axis spines
+axes.spines.bottom: True
+
+# Restore <=mpl 3.6 default font sizes
+# font.size: 7  # Default font size for text elements
+# axes.labelsize: 8  # Font size for axis labels
+# xtick.labelsize: 7  # Font size for x-tick labels
+# ytick.labelsize: 7  # Font size for y-tick labels
+# legend.fontsize: 6  # Font size for legend labels
+# figure.titlesize: 8  # Font size for figure titles
+# axes.titlesize: 8  # Font size for axes titles
+
+# # Remove legend frame
+# legend.frameon : False
+
+# # Always save as 'tight'
+# savefig.bbox : tight
+# savefig.pad_inches : 0.05
+
+# Font Family
+font.family      : Arial
+mathtext.fontset : custom
+mathtext.rm      : Arial
+mathtext.it      : Arial:italic
+mathtext.bf      : Arial:bold
+mathtext.sf      : Arial
+
+# # Use LaTeX for math formatting
+# text.usetex : True
+# text.latex.preamble : \usepackage{amsmath}

aesthetic/styles/science_wob.mplstyle

@@ -0,0 +1,68 @@
+# Matplotlib style for scientific plotting
+# This is the base style for "SciencePlots"
+# see: https://github.com/garrettj403/SciencePlots
+
+# Set color cycle: blue, green, yellow, red, violet, gray
+#axes.prop_cycle : cycler('color', ['0C5DA5', '00B945', 'FF9500', 'FF2C00', '845B97', '474747', '9e9e9e'])
+
+# # Set default figure size
+# figure.figsize : 3.5, 2.625
+
+# Set x axis
+xtick.direction : in
+xtick.major.size : 3
+xtick.major.width : 0.5
+xtick.minor.size : 1.5
+xtick.minor.width : 0.5
+xtick.minor.visible : True
+xtick.top : True
+xtick.color : White
+
+# Set y axis
+ytick.direction : in
+ytick.major.size : 3
+ytick.major.width : 0.5
+ytick.minor.size : 1.5
+ytick.minor.width : 0.5
+ytick.minor.visible : True
+ytick.right : True
+ytick.color : White
+
+# Set line widths
+axes.linewidth : 0.5
+grid.linewidth : 0.5
+lines.linewidth : 1.
+
+# Axis spines
+axes.spines.top:    True
+axes.spines.right:  True
+axes.spines.left:   True  # display axis spines
+axes.spines.bottom: True
+axes.edgecolor : white
+
+# Font color
+text.color: white
+axes.labelcolor: white
+
+# Background color
+figure.facecolor: black
+axes.facecolor: black
+
+# # Remove legend frame
+# legend.frameon : False
+
+# # Always save as 'tight'
+# savefig.bbox : tight
+# savefig.pad_inches : 0.05
+
+# Font Family
+font.family      : Arial
+mathtext.fontset : custom
+mathtext.rm      : Arial
+mathtext.it      : Arial:italic
+mathtext.bf      : Arial:bold
+mathtext.sf      : Arial
+
+# # Use LaTeX for math formatting
+# text.usetex : True
+# text.latex.preamble : \usepackage{amsmath}

aesthetic-0.10.dist-info/METADATA

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: aesthetic
+Version: 0.10
+Summary: a e s t h e t i c
+Home-page: https://github.com/lgbouma/aesthetic
+Download-URL: https://github.com/lgbouma/aesthetic/archive/refs/tags/v09.tar.gz
+Author: Luke Bouma
+Author-email: bouma.luke@gmail.com
+License: MIT
+Keywords: astronomy,matplotlib-style-sheets
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Provides-Extra: tests
+Requires-Dist: pytest==3.8.2; extra == "tests"
+Dynamic: download-url
+Dynamic: license-file
+
+# a e s t h e t i c
+
+Luke's matplotlib style sheets.
+Remixed from John Garrett's [SciencePlots](https://github.com/garrettj403/SciencePlots).
+
+Preferences:
+* Avoid constantly repeating matplotlib calls to prettify plots.
+* Default font: Arial (not DejaVu Sans, which many systems don't have installed by default)
+* Don't draw right and top axis spines unless they provide function.
+* White on black reduces eye strain; make generating white on black figures easy by using `*_wob` style sheets.
+
+__install__
+
+_...via pip_: `pip install aesthetic`
+
+_...via local clone_: `git clone git@github.com:lgbouma/aesthetic.git;  cd aesthetic;  pip install -e . `
+
+__examples__
+
+for plot styles, see the [test driver](https://github.com/lgbouma/aesthetic/blob/master/tests/make_test_plot.py).
+the general syntax follows:
+
+```
+from aesthetic import set_style
+set_style("clean")
+```
+
+<img src="https://raw.githubusercontent.com/lgbouma/aesthetic/refs/heads/master/results/plot_clean.png?v=2" width="500">
+
+
+```
+set_style("clean_wob")
+```
+
+<img src="https://raw.githubusercontent.com/lgbouma/aesthetic/refs/heads/master/results/plot_clean_wob.png?v=2" width="500">
+
+```
+set_style("science")
+```
+
+<img src="https://raw.githubusercontent.com/lgbouma/aesthetic/refs/heads/master/results/plot_science.png" width="500">
+
+```
+set_style("science_wob")
+```
+
+<img src="https://raw.githubusercontent.com/lgbouma/aesthetic/refs/heads/master/results/plot_science_wob.png?v=2" width="500">
+
+
+So if you wanted to make four different versions of the same plot with responsive colors:
+
+```
+from aesthetic.plot import set_style
+
+import numpy as np, matplotlib.pyplot as plt, matplotlib as mpl
+
+def make_plot(style):
+    x = np.linspace(0,10,1000)
+    y = (x/100)**3 + 5*np.sin(x)
+    _x, _y = np.arange(2, 8, 0.5), np.arange(2, 8, 0.5)
+
+    fig, ax = plt.subplots(figsize=(3,2.5))
+    cs = [None]*3 if '_wob' not in style else ['cyan','lime','yellow']
+    ax.plot(x, y, label=f'style: {style}', color=cs[0])
+    ax.plot(x, y+3, color=cs[1])
+    ax.plot(x, y+6, color=cs[2])
+    _yerr = np.abs(np.random.normal(2, 1, _x.size))
+    c = 'k' if '_wob' not in style else 'w'
+    ax.errorbar(_x, _y, yerr=_yerr, marker='o', elinewidth=0.5, lw=0, c=c, markersize=2)
+    ax.update({ 'xlabel': r'x [units]', 'ylabel': r'y [units]' })
+    ax.legend(fontsize='small')
+    return fig
+
+if __name__ == '__main__':
+    styles = ['clean', 'science', 'clean_wob', 'science_wob']
+    for style in styles:
+        set_style(style)
+        fig = make_plot(style)
+        fig.savefig(f'../results/plot_{style}.png', bbox_inches='tight', dpi=400)
+        mpl.rc_file_defaults()
+```

aesthetic-0.10.dist-info/RECORD

@@ -0,0 +1,16 @@
+aesthetic/__init__.py,sha256=6ZnJqIw2D2SEYphDkVmbL-gzvpEia3ReeG2N1H9Jv7s,579
+aesthetic/paper.py,sha256=RofiYUC0DAarvaS7RG-FUoi1ihBiUfzyeH3HQRqHoH8,1769
+aesthetic/plot.py,sha256=YbO9H52r9LYUcifb0HLjeSrj1LjSbOX-7I2hw1X3yts,1778
+aesthetic/styles/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aesthetic/styles/clean.mplstyle,sha256=u4SsFK7c6I6svZpuHUhSzih_Nvr1Vr24oLLdGUJiSdw,1243
+aesthetic/styles/clean_wob.mplstyle,sha256=fZmN9jGA1dDI7d4cYb5V0ja8eBdq9CXyANdoVRzSkf4,1595
+aesthetic/styles/grid.mplstyle,sha256=jITL2nHxflp_-tbhmK1Yzf1HRFRP-CNCWJQmw5L3Hv4,427
+aesthetic/styles/notebook.mplstyle,sha256=SUqiinag3bUEigXJ9SAubUIR8fu1FRwfpOjcXQ8r_i4,765
+aesthetic/styles/scatter.mplstyle,sha256=mOD-F86j3URzxgsLjrGqXl93WkRY-28GZxIhjHcQQ1k,515
+aesthetic/styles/science.mplstyle,sha256=d3OuBjyIJfvRYby1BQ8ZP3JYPYHGJWkLsPypat-lRrU,1736
+aesthetic/styles/science_wob.mplstyle,sha256=bF1mqqrIbQ6AXMNHImhBZaxdyiuNINMmDVRkmjwKJtA,1519
+aesthetic-0.10.dist-info/licenses/LICENSE,sha256=r4vpg5DQXHA-GyficrQf4DggjKN8QTAPRc88o_Jdn8E,1091
+aesthetic-0.10.dist-info/METADATA,sha256=h56oQgjBQYs4vTN5dkJqJpB31CEpxfwAMa5L4Ga45VM,3446
+aesthetic-0.10.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+aesthetic-0.10.dist-info/top_level.txt,sha256=ZoWm4gB1s0Mqao5seehnGWxfxVBspfqYFDX7w9YIMKA,10
+aesthetic-0.10.dist-info/RECORD,,

aesthetic-0.10.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

aesthetic-0.10.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-today Luke Bouma, and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aesthetic-0.10.dist-info/top_level.txt

@@ -0,0 +1 @@
+aesthetic