Skip to content
Snippets Groups Projects
Commit 3bcc7c09 authored by Leštáková, Michaela's avatar Leštáková, Michaela
Browse files

Merge branch '21-doc' into 'main'

fix docs

Closes #21

See merge request !23
parents 9c81dd9f 348ab784
Branches
Tags
1 merge request!23fix docs
Pipeline #1454015 passed
......@@ -47,7 +47,8 @@ Any good diagram will contain axis labels, and, optionally, a plot title. We can
.. code-block:: python
plt.rcParams['text.usetex'] = True
import matplotlib.pyplot as plt # only for LaTeX rendering
plt.rcParams['text.usetex'] = True # only for LaTeX rendering
axs.set_xlabel(r'driving angular frequency $\omega$ in $1/\mathrm{s}$')
axs.set_ylabel(r'oscillation amplitude $A$ in $\mathrm{m}$')
......@@ -174,7 +175,7 @@ This will not be caught upon by PlotSerializer and the change will be ignored.
Plot Serializer currently supports the following plot types. Supported arguments that will get serialized are noted below.
See `here <https://matplotlib.org/stable/plot_types/index.html>`_ for an explanation of these parameters.
Axes
Plot
^^^^
Serialized by default:
* title
......
User Guide
==========
Plot Serializer (PloSe) is a tool for converting scientific diagrams into (FAIR) data.
Many scientific publications are based on data. To fight the reproducibility crisis in science,
many researchers are adopting the practice of sharing data. This is more and more often required
by journals, conferences and funding bodies.
The PloSe team considers scientific diagrams an entry point to the research objects behind a publication.
Typically, the data depicted in a diagram within a scientific publication is of great interest to the reader.
The diagrams sometimes contain experimental or simulation results, in other cases secondary, processed data.
PloSe enables to quickly extract the data from the diagram, describe it with customizable metadata
(which can, for example, link to the primary dataset) and share it with the scientific community.
Hence, PloSe can assist you in making your data FAIR!
PloSe currently allows for serialization from matplotlib to JSON and RO-Crate. It is still **under development**, limited to certain
plot types.
PloSe also allows for deserialization of JSON-ized plots into matplotlib.
.. toctree::
:maxdepth: 1
:hidden:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment