Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
Plot Serializer
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
RDM Tools
Plot Serializer
Commits
3bcc7c09
Commit
3bcc7c09
authored
10 months ago
by
Leštáková, Michaela
Browse files
Options
Downloads
Plain Diff
Merge branch '21-doc' into 'main'
fix docs Closes
#21
See merge request
!23
parents
9c81dd9f
348ab784
No related branches found
No related tags found
1 merge request
!23
fix docs
Pipeline
#1454015
passed
10 months ago
Stage: test
Changes
2
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc/howitworks.rst
+4
-3
4 additions, 3 deletions
doc/howitworks.rst
doc/user_guide.rst
+19
-0
19 additions, 0 deletions
doc/user_guide.rst
with
23 additions
and
3 deletions
doc/howitworks.rst
+
4
−
3
View file @
3bcc7c09
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
doc/user_guide.rst
+
19
−
0
View file @
3bcc7c09
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:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment