Metadata-Version: 2.4
Name: bessaplots
Version: 0.4.0
Summary: Plottting utilities for scientific papers within the Bessa Group
Author-email: Martin van der Schelling <m.p.vanderschelling@tudelft.nl>
Maintainer-email: Martin van der Schelling <m.p.vanderschelling@tudelft.nl>
License: BSD-3-Clause
Project-URL: bugs, https://github.com/mpvanderschelling/bessaplots/issues
Project-URL: homepage, https://github.com/mpvanderschelling/bessaplots
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib>=3.10.8
Provides-Extra: dev
Requires-Dist: setuptools>=43.0.0; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: wheel; extra == "dev"
Requires-Dist: pre-commit>=4.4.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs-gen-files>=0.5.0; extra == "docs"
Requires-Dist: mkdocs-include-exclude-files>=0.1.0; extra == "docs"
Requires-Dist: mkdocs-ipynb>=0.1.1; extra == "docs"
Requires-Dist: mkdocs-material>=9.6.20; extra == "docs"
Requires-Dist: mkdocstrings>=0.30.1; extra == "docs"
Requires-Dist: mkdocstrings-python>=1.18.2; extra == "docs"
Requires-Dist: pymdown-extensions>=10.16.1; extra == "docs"
Provides-Extra: tests
Requires-Dist: pytest>=8.4.1; extra == "tests"
Requires-Dist: pytest-cov>=6.2.1; extra == "tests"
Dynamic: license-file

![Bessa Research Group](img/bessa_group_logo.png)

# Bessa Plots

| [**GitHub**](https://github.com/mpvanderschelling/bessaplots)
| [**Documentation**](https://bessaplots.readthedocs.io/en/latest/)

Plottting utilities for scientific papers within the Bessa Group

**First publication:** February 3, 2026

***

## Summary

<!-- Write here a longer description of the package, what it does, and why it is useful. -->

## Statement of need

<!-- Write here the statement of need for this package -->

## Authorship

**Authors**:
- Martin van der Schelling ([m.p.vanderschelling@tudelft.nl](mailto:m.p.vanderschelling@tudelft.nl))

**Authors afilliation:**
- Delft University of Technology (Bessa Research Group)

**Maintainer:**
- Martin van der Schelling ([m.p.vanderschelling@tudelft.nl](mailto:m.p.vanderschelling@tudelft.nl))

**Maintainer afilliation:**
- Delft University of Technology (Bessa Research Group)


## Getting started

<!-- Write here how users should get started with this package -->

## Usage

Here is a minimal example of how to use `savefig` to generate publication-ready figures:

```python
import matplotlib.pyplot as plt
import bessaplots
from bessaplots.savefig import savefig

# Use the specific bessaplots style
plt.style.use('bessaplots')

# Create a plot
fig, ax = plt.subplots()
ax.plot([1, 2, 3], [1, 4, 9])
ax.set_xlabel("Time [s]")
ax.set_ylabel("Displacement [mm]")

# Save the figure specifying the paper size
# This will save 'my_figure.pdf' optimized for A4 paper
savefig(fig, "my_figure", paper_size="a4")
```

## Credits

- This package heavily inspired by [SciencePlots](https://github.com/garrettj403/SciencePlots).

## Community Support

If you find any **issues, bugs or problems** with this package, please use the [GitHub issue tracker](https://github.com/mpvanderschelling/bessaplots/issues) to report them.

## License

Copyright (c) 2026, Martin van der Schelling

All rights reserved.

This project is licensed under the BSD 3-Clause License. See [LICENSE](https://github.com/mpvanderschelling/bessaplots/blob/main/LICENSE) for the full license text.

