Metadata-Version: 2.4
Name: plot_serializer
Version: 0.2.3
Summary: A simple tool for serializing scientific diagram to (FAIR) data.
Author-email: Michaela Lestakova <michaela.lestakova@tu-darmstadt.de>, Ning Xia <ning.xia@tu-darmstadt.de>
License: MIT License
        
        Copyright (c) 2023 Michaela Leštáková, Ning Xia, TU Darmstadt
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://git.rwth-aachen.de/rdm-tools/plot-serializer
Project-URL: documentation, https://plot-serializer.readthedocs.io/en/latest/
Keywords: rdm,plot
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: matplotlib>=3.9
Requires-Dist: rdflib
Requires-Dist: pydantic
Requires-Dist: rocrate
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=7.1.2; extra == "test"
Requires-Dist: pytest-cov>=3.0.0; extra == "test"
Requires-Dist: mypy>=0.971; extra == "test"
Requires-Dist: pandas-stubs>=1.4.3.220822; extra == "test"
Requires-Dist: types-tqdm>=4.64.5; extra == "test"
Requires-Dist: types-pytz>=2022.2.1.0; extra == "test"
Provides-Extra: doc
Requires-Dist: sphinx>=5.1.1; extra == "doc"
Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "doc"
Requires-Dist: sphinx-autoapi; extra == "doc"
Dynamic: license-file

# Overview
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.

[[_TOC_]]

## Installation
Install PlotSerializer by running

```cmd
pip install plot-serializer
```

## Documentation

View Plot Serializer's documentation on [Read the Docs](https://plot-serializer.readthedocs.io/en/latest/)

## License
View used License on [Show License](https://plot-serializer.readthedocs.io/en/latest/license.html)

## Citing
Plot Serializer comes with a citation file: [CITATION.cff](https://git.rwth-aachen.de/rdm-tools/plot-serializer/-/blob/main/CITATION.cff).
Find out how to use it [here](https://book.the-turing-way.org/communication/citable/citable-cff.html#how-to-cite-using-citation-cff>).
<br>
Please cite:
Leštáková, M., & Xia, N. (2024, September 18). Plot Serializer. NFDI4ing Conference 2024, virtual. Zenodo. https://doi.org/10.5281/zenodo.13785916

## Acknowledgements
The Authors would like to thank the Federal Government and the Heads of Government of the Länder,
as well as the Joint Science Conference (GWK), for their funding and support within the framework
of the NFDI4Ing consortium. Funded by the German Research Foundation (DFG) - project number 442146713.

Many thanks to the contributors listed in [CONTRIBUTORS.md](https://git.rwth-aachen.de/rdm-tools/plot-serializer/-/blob/main/CONTRIBUTORS.md).

## Contributing
An introduction and rules for contributing can be found in [CONTRIBUTING.md](https://git.rwth-aachen.de/rdm-tools/plot-serializer/-/blob/main/CONTRIBUTING.md).
