plotastro 1.0.1__tar.gz → 1.1.0__tar.gz

{plotastro-1.0.1 → plotastro-1.1.0}/.gitignore

@@ -9,3 +9,5 @@ build/
 docs/_build/
 docs/_figures/
 docs/tutorial.ipynb
+.vscode/
+.DS_Store

plotastro-1.1.0/CHANGELOG.md

@@ -0,0 +1,133 @@
+# Changelog
+
+## 1.1.0 — 2026-10-06
+
+The stable release of the 1.1 series: everything in the 1.1.0b1 and
+1.1.0b2 betas below, plus documentation. `pip install plotastro` now
+gives this version. No change in behaviour since 1.1.0b2.
+
+### Added
+- Install instructions for conda-forge
+  (`conda install -c conda-forge plotastro`, Python 3.11 or newer).
+- The API reference is split into one page per topic (styles, colours,
+  CMasher, markers, authors, accessibility). The colours page has a
+  longer guide to colormaps: which map suits which kind of data, lines
+  coloured by a parameter with a colour bar, diverging and cyclic data,
+  and common errors. The tutorial notebook runs the same examples.
+- The docstrings of `lighten`, `darken`, `check_colors`,
+  `current_journal`, `subplots`, `set_size`, `style_cycler`,
+  `show_colors`, `show_markers` and `show_linestyles` now list their
+  parameters and return values.
+- A test checks that every public name is in the API reference and that
+  the constants it shows match the code.
+
+## 1.1.0b2 — 2026-10-06 (beta)
+
+A pre-release: `pip install plotastro` still gives the stable 1.0.1. To try
+this beta, use `pip install --pre plotastro` (or `pip install
+"plotastro==1.1.0b2"`).
+
+### Changed
+- Legends now sit on a translucent white background (70 % opaque, no
+  border) instead of none, so they stay readable over data and grid
+  lines. The `euclid` style keeps niceplots' framed legends.
+
+## 1.1.0b1 — 2026-10-06 (beta)
+
+A pre-release: `pip install plotastro` still gives the stable 1.0.1. To try
+this beta, use `pip install --pre plotastro` (or `pip install
+"plotastro==1.1.0b1"`).
+
+### Added
+- `euclid` style (alias `ec`) for Euclid Consortium papers, adapted from
+  the Euclid Consortium Editorial Board's
+  [niceplots](https://gitlab.euclid-sgs.uk/ECEB/niceplots) (GPL-3.0,
+  Euclid-internal): sans-serif 10 pt text with Computer Modern maths, no
+  grid or minor ticks, framed legends, Petroff-8 colours, and niceplots'
+  4 × 3 in figure convention (LaTeX scales the figure into the A&A
+  column). The settings are re-expressed in plotastro's own template;
+  nothing is copied from niceplots.
+- Palettes `PETROFF8` and `TOL_VIBRANT`, and `euclid_colors(scheme, n=)`
+  giving niceplots' five colour schemes under their niceplots names.
+- `set_style(..., palette=...)` swaps the colour cycle for any named
+  palette or list of colours.
+- Optional [CMasher](https://cmasher.readthedocs.io) support, for discrete
+  colours and colormaps: `cmasher_colors(cmap, n=8, cmap_range=(0.15, 0.85))`
+  samples colours from a CMasher map, `cmasher_cmap(cmap, cmap_range=, n=)`
+  returns the map (optionally cut, or split into `n` levels), and
+  `set_style` accepts `palette="cmr.<name>"`. CMasher is **not** a
+  dependency: install it with `pip install "plotastro[cmasher]"` (or
+  `pip install cmasher`). plotastro imports it only when one of these is
+  used, and without it they raise an `ImportError` saying how to install it.
+- `set_style(..., cmap=...)` sets the default colormap: any matplotlib
+  name, or `"cmr.<name>"` for CMasher.
+
+### Changed
+- `figsize()` / `subplots()`: the default `aspect` now comes from the
+  journal (golden ratio everywhere except `euclid`, which uses 4:3).
+- `authorlist(..., journal="euclid")` uses the A&A format (Euclid's
+  `aaEC` class).
+
+### Fixed
+- Switching styles in one session no longer carries settings over.
+  matplotlib only overwrites the rcParams a style names, and the styles
+  named different ones: after `euclid`, for example, `set_style("mnras")`
+  or `plt.style.use("mnras")` kept Euclid's tick padding. Every style now
+  sets the same rcParams, using matplotlib's defaults where they apply,
+  and a test checks this.
+
+## 1.0.1 — 2026-09-01
+
+### Added
+- Documentation site (Sphinx + Furo on Read the Docs) with the rendered
+  tutorial notebook and a full API reference:
+  <https://plotastro.readthedocs.io>.
+
+No changes to the package code itself.
+
+## 1.0.0 — 2026-09-01
+
+First release as an installable package, `plotastro`.
+
+### Added
+- `pip install plotastro`; importing it registers all styles with
+  matplotlib, so `plt.style.use("mnras")` works everywhere.
+- Journal styles: **MNRAS**, **RASTI**, **A&A**, **ApJ/ApJL (AASTeX)**,
+  **Open Journal of Astrophysics**, **PRD/PRL (REVTeX)**, **JCAP**, and
+  **Nature Astronomy** (sans-serif variant), plus `thesis`/`beamer`
+  width presets. All generated from one template
+  (`tools/generate_styles.py`) so they stay consistent.
+- Helpers: `set_style`, `figsize`, `subplots`, `savefig`,
+  `style_cycler`, `lighten`/`darken`, `label_panels` (journal-style
+  (a)/(b)/(c) panel labels), reference charts
+  (`show_colors`/`show_markers`/`show_linestyles`).
+- Colour-vision-deficiency checking: `simulate_cvd`, `check_colors`,
+  and `check_figure` (Machado et al. 2009 model; no extra dependencies).
+- Palettes: the default colour-blind-friendly cycle (`COLORS`), Okabe &
+  Ito (`OKABE_ITO`), Petroff-10 (`PETROFF10`) and light/dark pairs
+  (`PAIRED`).
+- Author-list generator: `authorlist("authors.csv", journal=...)` and the
+  `plotastro-authors` command-line tool turn a CSV of names/affiliations/
+  ORCIDs/emails into the journal's LaTeX author block (MNRAS, A&A,
+  AASTeX, REVTeX, JCAP and generic formats), with automatic affiliation
+  numbering and sharing. Reads real collaboration lists as-is
+  (`Authorname`/`Firstname`+`Lastname` columns, one row per affiliation,
+  embedded LaTeX accents, extra columns ignored).
+- Zero-learning-curve mode: importing plotastro registers every style
+  with matplotlib, so `plt.style.use("mnras")` + ordinary matplotlib is
+  the entire integration (`pa.use(...)` is an alias of `set_style`).
+- `requirements.txt` / `requirements-dev.txt` for pip users; NumPy 1.x
+  and 2.x both supported and tested in CI.
+- Tests (pytest), CI and PyPI-publishing GitHub Actions workflows,
+  executed tutorial notebook, MIT license.
+
+### Changed
+- Styles no longer require LaTeX: portable STIX mathtext by default,
+  with `set_style(..., usetex=True)` to opt in (newtx fonts).
+- Submission-safe saving defaults: PDF, tight bbox, 450 dpi,
+  TrueType font embedding (`pdf.fonttype 42`).
+
+### Migration from the original repo
+- `MNRAS_Style.mplstyle` → `plt.style.use("mnras")` (after `import plotastro`).
+- `myfigsize.set_size(...)` → `plotastro.set_size(...)` still works, but
+  prefer `plotastro.figsize(...)` / `plotastro.subplots(...)`.

plotastro-1.1.0/CITATION.cff

@@ -0,0 +1,25 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: plotastro
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Behnood
+    family-names: Bandi
+    email: b.bandi@sussex.ac.uk
+    affiliation: University of Sussex
+    orcid: 'https://orcid.org/0000-0001-5838-3903'
+repository-code: 'https://github.com/BehnoodBandi/plotastro'
+url: 'https://plotastro.readthedocs.io/'
+keywords:
+  - Astronomy
+  - Python
+  - Plots
+  - Cosmology
+  - Journals
+  - matplotlib
+license: MIT

{plotastro-1.0.1 → plotastro-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: plotastro
-Version: 1.0.1
+Version: 1.1.0
 Summary: Publication-quality matplotlib styles and helpers for astronomy journals (MNRAS, A&A, ApJ, OJA, PRD, JCAP, Nature Astronomy)
 Project-URL: Homepage, https://github.com/BehnoodBandi/plotastro
 Project-URL: Issues, https://github.com/BehnoodBandi/plotastro/issues
@@ -17,23 +17,34 @@ Classifier: Topic :: Scientific/Engineering :: Astronomy
 Classifier: Topic :: Scientific/Engineering :: Visualization
 Requires-Python: >=3.9
 Requires-Dist: matplotlib>=3.5
+Provides-Extra: cmasher
+Requires-Dist: cmasher>=1.7; extra == 'cmasher'
 Provides-Extra: dev
+Requires-Dist: cmasher>=1.7; extra == 'dev'
 Requires-Dist: numpy; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # plotastro
 
+[![PyPI](https://img.shields.io/pypi/v/plotastro.svg)](https://pypi.org/project/plotastro/)
+[![conda-forge](https://img.shields.io/conda/vn/conda-forge/plotastro.svg)](https://anaconda.org/conda-forge/plotastro)
+[![Python versions](https://img.shields.io/pypi/pyversions/plotastro.svg)](https://pypi.org/project/plotastro/)
+[![CI](https://github.com/BehnoodBandi/plotastro/actions/workflows/ci.yml/badge.svg)](https://github.com/BehnoodBandi/plotastro/actions/workflows/ci.yml)
+[![Docs](https://readthedocs.org/projects/plotastro/badge/?version=latest)](https://plotastro.readthedocs.io)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
 **Publication-quality matplotlib figures for astronomy journals.**
 
 One `pip install` gives you journal-matched styles for **MNRAS**, **RASTI**,
 **A&A**, **ApJ/ApJL**, the **Open Journal of Astrophysics**, **PRD/PRL**,
-**JCAP** and **Nature Astronomy** — figures at exactly the right physical
-size, a colour-blind-friendly palette, and helpers that make the tedious
-parts (sizing, panel labels, accessibility checks, saving) one-liners.
+**JCAP**, **Nature Astronomy** and **Euclid Consortium** papers — figures
+at exactly the right physical size, a colour-blind-friendly palette, and
+helpers that make the tedious parts (sizing, panel labels, accessibility
+checks, saving) one-liners.
 
 ```bash
-pip install plotastro
+pip install plotastro                      # or: conda install -c conda-forge plotastro
 ```
 
 **Simplest usage — no new API to learn.** Importing plotastro registers the
@@ -86,9 +97,11 @@ Two problems ruin most paper figures:
 
 The styles share one visual language — Times-like serif fonts at ~9 pt with
 ~8 pt tick lettering, inward ticks on all four sides with minors, a subtle
-grid, frameless legends — and differ only in figure width (plus the
+grid, legends on a translucent white background — and differ only in figure width (plus the
 sans-serif fonts Nature requires), so your plots stay **consistent between
-papers** no matter where you submit.
+papers** no matter where you submit. The one exception is `euclid`, which
+deliberately matches the Euclid Consortium's own niceplots look instead
+(see below).
 
 ## Supported journals
 
@@ -105,6 +118,7 @@ papers** no matter where you submit.
 | `prd` (`prl`, `revtex`) | Physical Review D | 246.0 pt = 3.40 in | 510.0 pt = 7.06 in |
 | `jcap` | J. Cosmology & Astroparticle Phys. | single-column ≈455 pt = 6.30 in | — |
 | `natastro` (`nature`) | Nature Astronomy (sans-serif!) | 253.2 pt = 3.50 in (89 mm) | 520.7 pt = 7.20 in (183 mm) |
+| `euclid` (`ec`) | Euclid Consortium papers (A&A; niceplots look, sans-serif) | drawn 4.00 in = 289.1 pt, LaTeX scales it to 88 mm | 8.00 in = 578.2 pt (2 × column) |
 | `thesis` | A4 thesis text width | 426.8 pt = 5.91 in | — |
 | `beamer` | Beamer slide text width | 307.3 pt = 4.25 in | — |
 
@@ -113,8 +127,37 @@ document, put `\the\columnwidth` or `\the\textwidth` in your `.tex` body,
 compile, read the value off the page, and pass it directly:
 `pa.figsize(width=345.0)`.
 
+### Euclid Consortium papers
+
+`pa.set_style("euclid")` reproduces the look of
+[niceplots](https://gitlab.euclid-sgs.uk/ECEB/niceplots), the Euclid
+Consortium Editorial Board's matplotlib style for Euclid papers
+(Euclid-internal, GPL-3.0; set up by Lukas Hergt, with tweaks by Laila
+Linke). The style and its colour schemes are **adapted from that
+repository**: the settings are re-expressed in plotastro's own template and
+nothing is copied from it. How it differs from the other styles:
+
+- sans-serif text at 10 pt with Computer Modern maths, no grid, no minor
+  ticks, framed legends, and `axes.xmargin = 0`;
+- the default cycle is Petroff's 8-colour palette (`pa.PETROFF8`);
+  niceplots' other schemes are available under their niceplots names —
+  `pa.set_style("euclid", palette="categorical3")` or
+  `pa.euclid_colors("sequential", n=6)` (see *The colour palette* below);
+- **sizing follows niceplots rather than the exact-size approach**: figures
+  are drawn 4 × 3 in (two-column: 8 × 6 in) and LaTeX scales them into the
+  88 mm A&A column, so the 10 pt lettering prints at ≈ 8.7 pt. Include them
+  with `\includegraphics[width=\columnwidth]{fig.pdf}`. For a figure at
+  its exact printed size with the Euclid look, size it for A&A instead:
+  `pa.subplots(journal="aanda")`.
+
+`pa.set_style("euclid", usetex=True)` gives niceplots' LaTeX rendering
+(Computer Modern Sans text). Euclid papers use A&A's `aaEC` class, so
+`pa.authorlist(..., journal="euclid")` produces the A&A author block.
+
 The only hard dependency is matplotlib; plotastro works with both NumPy 1.x
-and 2.x (CI tests each). Running the examples from a clone?
+and 2.x (CI tests each). [CMasher](https://cmasher.readthedocs.io) colours
+and colormaps are an optional extra (`pip install "plotastro[cmasher]"`; see
+below). Running the examples from a clone?
 `pip install -r requirements-dev.txt`.
 
 ## Tutorial
@@ -166,20 +209,77 @@ ax.fill_between(x, lo, hi, color=pa.lighten(pa.COLORS["blue"], 0.7))
 pa.darken(pa.COLORS["orange"], 0.3)     # the other direction
 ```
 
-Three more palettes ship with the package:
+More palettes ship with the package:
 
 - `pa.OKABE_ITO` — [Okabe & Ito (2008)](https://jfly.uni-koeln.de/color/),
   *the* classic CVD-safe recommendation for categorical colours in science;
 - `pa.PETROFF10` — [Petroff (2021)](https://arxiv.org/abs/2107.02270), the
   CVD-optimised 10-colour cycle used across particle physics;
+- `pa.PETROFF8` — Petroff's 8-colour sibling, the default cycle of the
+  Euclid Consortium's [niceplots](https://gitlab.euclid-sgs.uk/ECEB/niceplots)
+  (and of the `euclid` style here);
+- `pa.TOL_VIBRANT` — [Paul Tol's](https://personal.sron.nl/~pault/) *vibrant*
+  qualitative scheme, 7 CVD-safe colours;
 - `pa.PAIRED` — light/dark pairs for data/model or before/after comparisons:
   `pa.PAIRED["blue"]` → `("#a6cee3", "#1f78b4")`.
 
+Any of them can become the active cycle when you activate a style —
+`pa.set_style("mnras", palette="okabe_ito")` — or pass your own list of
+colours. The colour schemes of the Euclid Consortium's niceplots are also
+available under their niceplots names (adapted from that repository):
+`pa.euclid_colors()` takes `"categorical1"` (Petroff-8), `"categorical2"`
+(Okabe & Ito), `"categorical3"` (black + Tol vibrant), `"sequential"` (`n`
+colours from `copper`) or `"diverging"` (`n` colours from `coolwarm`):
+
+```python
+pa.set_style("euclid", palette="diverging")                    # by name
+ax.set_prop_cycle(color=pa.euclid_colors("sequential", n=6))   # per axes
+```
+
 **Colormaps:** the styles default to `viridis` (perceptually uniform,
 CVD-safe). Good picks: `viridis`/`magma`/`cividis` for sequential data,
 `RdBu_r` or `coolwarm` for diverging data (red–*blue*, not red–green). Avoid
-`jet`/`rainbow`. For more astro-friendly maps see
-[cmasher](https://cmasher.readthedocs.io) and [cmocean](https://matplotlib.org/cmocean/).
+`jet`/`rainbow`. Change the default with `pa.set_style("mnras", cmap="cividis")`.
+For many more maps, use CMasher (next section) or
+[cmocean](https://matplotlib.org/cmocean/).
+
+### CMasher colours and colormaps (optional)
+
+![CMasher colours and colormaps](examples/figures/cmasher.png)
+
+[CMasher](https://cmasher.readthedocs.io) (van der Velden 2020,
+[JOSS 5, 2004](https://doi.org/10.21105/joss.02004)) is a collection of
+perceptually uniform scientific colormaps (sequential, diverging and
+cyclic), most of them colour-vision-deficiency friendly. plotastro can use
+it for both discrete colours and colormaps, but it is **not a dependency**.
+Install it only if you want it (`pip install cmasher`, or
+`pip install "plotastro[cmasher]"`); plotastro imports it only when you ask
+for a CMasher colour. Names start with `cmr.`, as in CMasher itself:
+
+```python
+pa.set_style("mnras", palette="cmr.rainforest")    # 8-colour cycle from a CMasher map
+pa.set_style("mnras", cmap="cmr.ocean")            # default colormap for imshow etc.
+
+ax.set_prop_cycle(color=pa.cmasher_colors("torch", n=5))       # n discrete colours
+ax.imshow(img, cmap=pa.cmasher_cmap("rainforest"))             # the colormap
+ax.contourf(x, y, z, levels=6, cmap=pa.cmasher_cmap("iceburn", n=6))  # 6 levels
+```
+
+Discrete colours are sampled from `cmap_range=(0.15, 0.85)` by default.
+This follows CMasher's advice, since most of its sequential maps run from
+black to white and those ends vanish on the page. For lines that must be
+easy to tell apart, CMasher suggests `apple`, `chroma`, `neon`,
+`rainforest` or `torch`; for steps of one quantity, a single-hue map such
+as `flamingo`, `freeze`, `gothic`, `jungle` or `ocean`. To span the whole
+map with a fixed number of lines, sample exactly that many:
+`pa.cmasher_colors("rainforest", n=len(models))`. Please cite CMasher if
+you use it (`cmasher.get_bibtex()`).
+
+The [colours page of the documentation](https://plotastro.readthedocs.io/en/latest/colors.html)
+has more: which map suits which kind of data, lines coloured by a
+parameter with a colour bar, diverging and cyclic data, and common
+errors. The [tutorial notebook](examples/tutorial.ipynb) runs the same
+examples.
 
 ### Checking accessibility yourself
 
@@ -271,9 +371,10 @@ your manuscript (custom macros, real kerning):
 pa.set_style("mnras", usetex=True)   # needs latex + dvipng + ghostscript
 ```
 
-This loads the `newtx` Times fonts (matching the MNRAS/A&A house font), or
-Helvetica for Nature Astronomy. Develop with `usetex=False`, flip it on for
-the final version — LaTeX rendering is slow.
+This loads the `newtx` Times fonts (matching the MNRAS/A&A house font),
+Helvetica for Nature Astronomy, or plain Computer Modern Sans for the Euclid
+style (as niceplots does). Develop with `usetex=False`, flip it on for the
+final version — LaTeX rendering is slow.
 
 ### Saving figures
 
@@ -355,14 +456,16 @@ complete example.
 
 | | |
 |---|---|
-| `set_style(journal, usetex=, grid=, **rc)` | activate a journal's style (alias: `use`) |
+| `set_style(journal, usetex=, grid=, palette=, cmap=, **rc)` | activate a journal's style (alias: `use`) |
 | `authorlist(csv, journal=)` | LaTeX author/affiliation block from a CSV (CLI: `plotastro-authors`) |
 | `figsize(width, journal=, fraction=, aspect=, ...)` | journal-correct figure dimensions |
 | `subplots(...)` | `plt.subplots` with the size computed for you |
 | `savefig(name, formats=("pdf",))` | save one figure in several formats |
 | `label_panels(axes, ...)` | (a), (b), (c) panel labels |
 | `style_cycler(markers=, linestyles=)` | redundant-encoding property cycle |
-| `COLORS`, `CYCLE`, `OKABE_ITO`, `PETROFF10`, `PAIRED` | palettes |
+| `COLORS`, `CYCLE`, `OKABE_ITO`, `PETROFF8`, `PETROFF10`, `TOL_VIBRANT`, `PAIRED` | palettes |
+| `euclid_colors(scheme, n=)` | the Euclid niceplots colour schemes, by name |
+| `cmasher_colors(cmap, n=, cmap_range=)`, `cmasher_cmap(cmap, cmap_range=, n=)` | CMasher colours / colormaps (optional `cmasher` package) |
 | `lighten(c, f)`, `darken(c, f)` | matched shades without transparency |
 | `simulate_cvd`, `check_colors`, `check_figure` | colour-vision-deficiency checks |
 | `MARKERS`, `LINESTYLES` | curated marker / dash-pattern sequences |
@@ -403,7 +506,7 @@ python tools/generate_styles.py     # regenerate styles/ after editing the templ
 python examples/make_reference_figures.py   # regenerate README figures
 ```
 
-The `.mplstyle` files are generated from a single template in
+The `.mplstyle` files are generated from the templates in
 [tools/generate_styles.py](tools/generate_styles.py) — edit that, not the
 files (CI checks they stay in sync). Releases: bump the version in
 `pyproject.toml` and `CHANGELOG.md`, then push a `v*` tag — the
@@ -418,7 +521,15 @@ files (CI checks they stay in sync). Releases: bump the version in
   [Thøger Rivera-Thorsen](https://gist.github.com/thriveth/8560036);
   light colours from Tableau *Color Blind 10*
 - Palettes: [Okabe & Ito](https://jfly.uni-koeln.de/color/),
-  [Petroff (2021)](https://arxiv.org/abs/2107.02270), ColorBrewer *Paired*
+  [Petroff (2021)](https://arxiv.org/abs/2107.02270),
+  [Paul Tol](https://personal.sron.nl/~pault/), ColorBrewer *Paired*
+- Optional colormaps: [CMasher](https://cmasher.readthedocs.io)
+  (E. van der Velden 2020, JOSS 5, 2004; BSD-3-Clause), used as an optional
+  dependency, not bundled
+- Euclid style and colour schemes adapted from the Euclid Consortium
+  Editorial Board's [niceplots](https://gitlab.euclid-sgs.uk/ECEB/niceplots)
+  (Lukas Hergt and Laila Linke; GPL-3.0, Euclid-internal) — settings
+  re-expressed in plotastro's own template, nothing copied
 - CVD model: Machado, Oliveira & Fernandes (2009), IEEE TVCG 15(6)
 - Figure-size approach after
   [Jack Walton's guide](https://jwalton.info/Embed-Publication-Matplotlib-Latex/)

{plotastro-1.0.1 → plotastro-1.1.0}/README.md

@@ -1,15 +1,23 @@
 # plotastro
 
+[![PyPI](https://img.shields.io/pypi/v/plotastro.svg)](https://pypi.org/project/plotastro/)
+[![conda-forge](https://img.shields.io/conda/vn/conda-forge/plotastro.svg)](https://anaconda.org/conda-forge/plotastro)
+[![Python versions](https://img.shields.io/pypi/pyversions/plotastro.svg)](https://pypi.org/project/plotastro/)
+[![CI](https://github.com/BehnoodBandi/plotastro/actions/workflows/ci.yml/badge.svg)](https://github.com/BehnoodBandi/plotastro/actions/workflows/ci.yml)
+[![Docs](https://readthedocs.org/projects/plotastro/badge/?version=latest)](https://plotastro.readthedocs.io)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
 **Publication-quality matplotlib figures for astronomy journals.**
 
 One `pip install` gives you journal-matched styles for **MNRAS**, **RASTI**,
 **A&A**, **ApJ/ApJL**, the **Open Journal of Astrophysics**, **PRD/PRL**,
-**JCAP** and **Nature Astronomy** — figures at exactly the right physical
-size, a colour-blind-friendly palette, and helpers that make the tedious
-parts (sizing, panel labels, accessibility checks, saving) one-liners.
+**JCAP**, **Nature Astronomy** and **Euclid Consortium** papers — figures
+at exactly the right physical size, a colour-blind-friendly palette, and
+helpers that make the tedious parts (sizing, panel labels, accessibility
+checks, saving) one-liners.
 
 ```bash
-pip install plotastro
+pip install plotastro                      # or: conda install -c conda-forge plotastro
 ```
 
 **Simplest usage — no new API to learn.** Importing plotastro registers the
@@ -62,9 +70,11 @@ Two problems ruin most paper figures:
 
 The styles share one visual language — Times-like serif fonts at ~9 pt with
 ~8 pt tick lettering, inward ticks on all four sides with minors, a subtle
-grid, frameless legends — and differ only in figure width (plus the
+grid, legends on a translucent white background — and differ only in figure width (plus the
 sans-serif fonts Nature requires), so your plots stay **consistent between
-papers** no matter where you submit.
+papers** no matter where you submit. The one exception is `euclid`, which
+deliberately matches the Euclid Consortium's own niceplots look instead
+(see below).
 
 ## Supported journals
 
@@ -81,6 +91,7 @@ papers** no matter where you submit.
 | `prd` (`prl`, `revtex`) | Physical Review D | 246.0 pt = 3.40 in | 510.0 pt = 7.06 in |
 | `jcap` | J. Cosmology & Astroparticle Phys. | single-column ≈455 pt = 6.30 in | — |
 | `natastro` (`nature`) | Nature Astronomy (sans-serif!) | 253.2 pt = 3.50 in (89 mm) | 520.7 pt = 7.20 in (183 mm) |
+| `euclid` (`ec`) | Euclid Consortium papers (A&A; niceplots look, sans-serif) | drawn 4.00 in = 289.1 pt, LaTeX scales it to 88 mm | 8.00 in = 578.2 pt (2 × column) |
 | `thesis` | A4 thesis text width | 426.8 pt = 5.91 in | — |
 | `beamer` | Beamer slide text width | 307.3 pt = 4.25 in | — |
 
@@ -89,8 +100,37 @@ document, put `\the\columnwidth` or `\the\textwidth` in your `.tex` body,
 compile, read the value off the page, and pass it directly:
 `pa.figsize(width=345.0)`.
 
+### Euclid Consortium papers
+
+`pa.set_style("euclid")` reproduces the look of
+[niceplots](https://gitlab.euclid-sgs.uk/ECEB/niceplots), the Euclid
+Consortium Editorial Board's matplotlib style for Euclid papers
+(Euclid-internal, GPL-3.0; set up by Lukas Hergt, with tweaks by Laila
+Linke). The style and its colour schemes are **adapted from that
+repository**: the settings are re-expressed in plotastro's own template and
+nothing is copied from it. How it differs from the other styles:
+
+- sans-serif text at 10 pt with Computer Modern maths, no grid, no minor
+  ticks, framed legends, and `axes.xmargin = 0`;
+- the default cycle is Petroff's 8-colour palette (`pa.PETROFF8`);
+  niceplots' other schemes are available under their niceplots names —
+  `pa.set_style("euclid", palette="categorical3")` or
+  `pa.euclid_colors("sequential", n=6)` (see *The colour palette* below);
+- **sizing follows niceplots rather than the exact-size approach**: figures
+  are drawn 4 × 3 in (two-column: 8 × 6 in) and LaTeX scales them into the
+  88 mm A&A column, so the 10 pt lettering prints at ≈ 8.7 pt. Include them
+  with `\includegraphics[width=\columnwidth]{fig.pdf}`. For a figure at
+  its exact printed size with the Euclid look, size it for A&A instead:
+  `pa.subplots(journal="aanda")`.
+
+`pa.set_style("euclid", usetex=True)` gives niceplots' LaTeX rendering
+(Computer Modern Sans text). Euclid papers use A&A's `aaEC` class, so
+`pa.authorlist(..., journal="euclid")` produces the A&A author block.
+
 The only hard dependency is matplotlib; plotastro works with both NumPy 1.x
-and 2.x (CI tests each). Running the examples from a clone?
+and 2.x (CI tests each). [CMasher](https://cmasher.readthedocs.io) colours
+and colormaps are an optional extra (`pip install "plotastro[cmasher]"`; see
+below). Running the examples from a clone?
 `pip install -r requirements-dev.txt`.
 
 ## Tutorial
@@ -142,20 +182,77 @@ ax.fill_between(x, lo, hi, color=pa.lighten(pa.COLORS["blue"], 0.7))
 pa.darken(pa.COLORS["orange"], 0.3)     # the other direction
 ```
 
-Three more palettes ship with the package:
+More palettes ship with the package:
 
 - `pa.OKABE_ITO` — [Okabe & Ito (2008)](https://jfly.uni-koeln.de/color/),
   *the* classic CVD-safe recommendation for categorical colours in science;
 - `pa.PETROFF10` — [Petroff (2021)](https://arxiv.org/abs/2107.02270), the
   CVD-optimised 10-colour cycle used across particle physics;
+- `pa.PETROFF8` — Petroff's 8-colour sibling, the default cycle of the
+  Euclid Consortium's [niceplots](https://gitlab.euclid-sgs.uk/ECEB/niceplots)
+  (and of the `euclid` style here);
+- `pa.TOL_VIBRANT` — [Paul Tol's](https://personal.sron.nl/~pault/) *vibrant*
+  qualitative scheme, 7 CVD-safe colours;
 - `pa.PAIRED` — light/dark pairs for data/model or before/after comparisons:
   `pa.PAIRED["blue"]` → `("#a6cee3", "#1f78b4")`.
 
+Any of them can become the active cycle when you activate a style —
+`pa.set_style("mnras", palette="okabe_ito")` — or pass your own list of
+colours. The colour schemes of the Euclid Consortium's niceplots are also
+available under their niceplots names (adapted from that repository):
+`pa.euclid_colors()` takes `"categorical1"` (Petroff-8), `"categorical2"`
+(Okabe & Ito), `"categorical3"` (black + Tol vibrant), `"sequential"` (`n`
+colours from `copper`) or `"diverging"` (`n` colours from `coolwarm`):
+
+```python
+pa.set_style("euclid", palette="diverging")                    # by name
+ax.set_prop_cycle(color=pa.euclid_colors("sequential", n=6))   # per axes
+```
+
 **Colormaps:** the styles default to `viridis` (perceptually uniform,
 CVD-safe). Good picks: `viridis`/`magma`/`cividis` for sequential data,
 `RdBu_r` or `coolwarm` for diverging data (red–*blue*, not red–green). Avoid
-`jet`/`rainbow`. For more astro-friendly maps see
-[cmasher](https://cmasher.readthedocs.io) and [cmocean](https://matplotlib.org/cmocean/).
+`jet`/`rainbow`. Change the default with `pa.set_style("mnras", cmap="cividis")`.
+For many more maps, use CMasher (next section) or
+[cmocean](https://matplotlib.org/cmocean/).
+
+### CMasher colours and colormaps (optional)
+
+![CMasher colours and colormaps](examples/figures/cmasher.png)
+
+[CMasher](https://cmasher.readthedocs.io) (van der Velden 2020,
+[JOSS 5, 2004](https://doi.org/10.21105/joss.02004)) is a collection of
+perceptually uniform scientific colormaps (sequential, diverging and
+cyclic), most of them colour-vision-deficiency friendly. plotastro can use
+it for both discrete colours and colormaps, but it is **not a dependency**.
+Install it only if you want it (`pip install cmasher`, or
+`pip install "plotastro[cmasher]"`); plotastro imports it only when you ask
+for a CMasher colour. Names start with `cmr.`, as in CMasher itself:
+
+```python
+pa.set_style("mnras", palette="cmr.rainforest")    # 8-colour cycle from a CMasher map
+pa.set_style("mnras", cmap="cmr.ocean")            # default colormap for imshow etc.
+
+ax.set_prop_cycle(color=pa.cmasher_colors("torch", n=5))       # n discrete colours
+ax.imshow(img, cmap=pa.cmasher_cmap("rainforest"))             # the colormap
+ax.contourf(x, y, z, levels=6, cmap=pa.cmasher_cmap("iceburn", n=6))  # 6 levels
+```
+
+Discrete colours are sampled from `cmap_range=(0.15, 0.85)` by default.
+This follows CMasher's advice, since most of its sequential maps run from
+black to white and those ends vanish on the page. For lines that must be
+easy to tell apart, CMasher suggests `apple`, `chroma`, `neon`,
+`rainforest` or `torch`; for steps of one quantity, a single-hue map such
+as `flamingo`, `freeze`, `gothic`, `jungle` or `ocean`. To span the whole
+map with a fixed number of lines, sample exactly that many:
+`pa.cmasher_colors("rainforest", n=len(models))`. Please cite CMasher if
+you use it (`cmasher.get_bibtex()`).
+
+The [colours page of the documentation](https://plotastro.readthedocs.io/en/latest/colors.html)
+has more: which map suits which kind of data, lines coloured by a
+parameter with a colour bar, diverging and cyclic data, and common
+errors. The [tutorial notebook](examples/tutorial.ipynb) runs the same
+examples.
 
 ### Checking accessibility yourself
 
@@ -247,9 +344,10 @@ your manuscript (custom macros, real kerning):
 pa.set_style("mnras", usetex=True)   # needs latex + dvipng + ghostscript
 ```
 
-This loads the `newtx` Times fonts (matching the MNRAS/A&A house font), or
-Helvetica for Nature Astronomy. Develop with `usetex=False`, flip it on for
-the final version — LaTeX rendering is slow.
+This loads the `newtx` Times fonts (matching the MNRAS/A&A house font),
+Helvetica for Nature Astronomy, or plain Computer Modern Sans for the Euclid
+style (as niceplots does). Develop with `usetex=False`, flip it on for the
+final version — LaTeX rendering is slow.
 
 ### Saving figures
 
@@ -331,14 +429,16 @@ complete example.
 
 | | |
 |---|---|
-| `set_style(journal, usetex=, grid=, **rc)` | activate a journal's style (alias: `use`) |
+| `set_style(journal, usetex=, grid=, palette=, cmap=, **rc)` | activate a journal's style (alias: `use`) |
 | `authorlist(csv, journal=)` | LaTeX author/affiliation block from a CSV (CLI: `plotastro-authors`) |
 | `figsize(width, journal=, fraction=, aspect=, ...)` | journal-correct figure dimensions |
 | `subplots(...)` | `plt.subplots` with the size computed for you |
 | `savefig(name, formats=("pdf",))` | save one figure in several formats |
 | `label_panels(axes, ...)` | (a), (b), (c) panel labels |
 | `style_cycler(markers=, linestyles=)` | redundant-encoding property cycle |
-| `COLORS`, `CYCLE`, `OKABE_ITO`, `PETROFF10`, `PAIRED` | palettes |
+| `COLORS`, `CYCLE`, `OKABE_ITO`, `PETROFF8`, `PETROFF10`, `TOL_VIBRANT`, `PAIRED` | palettes |
+| `euclid_colors(scheme, n=)` | the Euclid niceplots colour schemes, by name |
+| `cmasher_colors(cmap, n=, cmap_range=)`, `cmasher_cmap(cmap, cmap_range=, n=)` | CMasher colours / colormaps (optional `cmasher` package) |
 | `lighten(c, f)`, `darken(c, f)` | matched shades without transparency |
 | `simulate_cvd`, `check_colors`, `check_figure` | colour-vision-deficiency checks |
 | `MARKERS`, `LINESTYLES` | curated marker / dash-pattern sequences |
@@ -379,7 +479,7 @@ python tools/generate_styles.py     # regenerate styles/ after editing the templ
 python examples/make_reference_figures.py   # regenerate README figures
 ```
 
-The `.mplstyle` files are generated from a single template in
+The `.mplstyle` files are generated from the templates in
 [tools/generate_styles.py](tools/generate_styles.py) — edit that, not the
 files (CI checks they stay in sync). Releases: bump the version in
 `pyproject.toml` and `CHANGELOG.md`, then push a `v*` tag — the
@@ -394,7 +494,15 @@ files (CI checks they stay in sync). Releases: bump the version in
   [Thøger Rivera-Thorsen](https://gist.github.com/thriveth/8560036);
   light colours from Tableau *Color Blind 10*
 - Palettes: [Okabe & Ito](https://jfly.uni-koeln.de/color/),
-  [Petroff (2021)](https://arxiv.org/abs/2107.02270), ColorBrewer *Paired*
+  [Petroff (2021)](https://arxiv.org/abs/2107.02270),
+  [Paul Tol](https://personal.sron.nl/~pault/), ColorBrewer *Paired*
+- Optional colormaps: [CMasher](https://cmasher.readthedocs.io)
+  (E. van der Velden 2020, JOSS 5, 2004; BSD-3-Clause), used as an optional
+  dependency, not bundled
+- Euclid style and colour schemes adapted from the Euclid Consortium
+  Editorial Board's [niceplots](https://gitlab.euclid-sgs.uk/ECEB/niceplots)
+  (Lukas Hergt and Laila Linke; GPL-3.0, Euclid-internal) — settings
+  re-expressed in plotastro's own template, nothing copied
 - CVD model: Machado, Oliveira & Fernandes (2009), IEEE TVCG 15(6)
 - Figure-size approach after
   [Jack Walton's guide](https://jwalton.info/Embed-Publication-Matplotlib-Latex/)

plotastro-1.1.0/docs/api/accessibility.md

@@ -0,0 +1,16 @@
+# Colour-vision-deficiency checks
+
+Simulate how colours, palettes and whole figures look to readers with a
+colour-vision deficiency, and in greyscale print. The simulations use the
+Machado, Oliveira & Fernandes (2009) model and need no extra packages. See
+{doc}`../colors` for the guide.
+
+```{eval-rst}
+.. currentmodule:: plotastro
+
+.. autofunction:: simulate_cvd
+
+.. autofunction:: check_colors
+
+.. autofunction:: check_figure
+```