Skip to content

Commit ecfea86

Browse files
committed
setup citation
1 parent 253dd7f commit ecfea86

File tree

3 files changed

+83
-0
lines changed

3 files changed

+83
-0
lines changed

.zenodo.json

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"title": "UltraPlot: A succinct wrapper for Matplotlib",
3+
"upload_type": "software",
4+
"description": "UltraPlot provides a compact and extensible API on top of Matplotlib, inspired by ProPlot. It simplifies the creation of scientific plots with consistent layout, colorbars, and shared axes.",
5+
"creators": [
6+
{
7+
"name": "van Elteren, Casper",
8+
"orcid": "0000-0001-9862-8936",
9+
"affiliation": "University of Amsterdam, Polder Center, Institute for Advanced Study Amsterdam"
10+
},
11+
{
12+
"name": "Becker, Matthew",
13+
"orcid": "0000-0001-7774-2246",
14+
"affiliation": "Argonne National Laboratory: Lemont, US"
15+
}
16+
],
17+
"license": "MIT",
18+
"keywords": [
19+
"matplotlib",
20+
"scientific visualization",
21+
"plotting",
22+
"wrapper",
23+
"python"
24+
],
25+
"related_identifiers": [
26+
{
27+
"relation": "isDerivedFrom",
28+
"identifier": "https://github.com/lukelbd/proplot",
29+
"scheme": "url"
30+
},
31+
{
32+
"relation": "isDerivedFrom",
33+
"identifier": "https://matplotlib.org/",
34+
"scheme": "url"
35+
}
36+
],
37+
"version": "1.57",
38+
"publication_date": "2025-01-01" // need to fix
39+
}

CITATON.cff

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
cff-version: 1.2.0
2+
message: "If you use UltraPlot in your work, please cite it using the following metadata."
3+
title: "UltraPlot"
4+
authors:
5+
- family-names: "van Elteren"
6+
given-names: "Casper"
7+
orcid: "https://orcid.org/0000-0001-9862-8936"
8+
- family-names: "Becker"
9+
given-names: "Matthew"
10+
orcid: "https://orcid.org/0000-0001-7774-2246"
11+
date-released: "2025-01-01"
12+
version: "1.57"
13+
doi: "10.5281/zenodo.XXXXXXX" # need to add
14+
repository-code: "https://github.com/Ultraplot/UltraPlot"
15+
license: "MIT"
16+
keywords:
17+
- plotting
18+
- matplotlib
19+
- scientific visualization
20+
- wrapper
21+
references:
22+
- type: software
23+
name: "ProPlot"
24+
authors:
25+
- family-names: "Davis"
26+
given-names: "Luke"
27+
url: "https://github.com/lukelbd/proplot"
28+
- type: software
29+
name: "Matplotlib"
30+
authors:
31+
- family-names: "Hunter"
32+
given-names: "John D."
33+
url: "https://matplotlib.org/"

README.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,17 @@ To install a development version of UltraPlot, you can use
116116
or clone the repository and run ``pip install -e .``
117117
inside the ``ultraplot`` folder.
118118

119+
```bibtex
120+
@software{vanElteren2025,
121+
author = {Casper van Elteren and Matthew Becker},
122+
title = {UltraPlot: A succinct wrapper for Matplotlib},
123+
year = {2025},
124+
version = {1.5.7},
125+
publisher = {GitHub},
126+
url = {https://github.com/Ultraplot/UltraPlot}
127+
}
128+
```
129+
119130

120131
.. |build-status| image:: https://github.com/ultraplot/ultraplot/actions/workflows/build-ultraplot.yml/badge.svg
121132

0 commit comments

Comments
 (0)