PlotID is a program connected to Research Data Management (RDM). It has two main functionalities:
This is the python plotID project.
plotID is a program connected to Research Data Management (RDM). It has two main functionalities:
1. Tag your plot with an identifier.
2. Export the resulting file to a specified directory along the corresponding research data, the plot is based on. Additionally, the script that created the plot will also be copied to the directory.
**Note:** To run PlotID python version ≥ 3.10 is required.
**Note:** To run plotID python version ≥ 3.10 is required.
## Installation
Currently there are two options to run PlotID. Either install it via pip from the Python Package Index (PyPi) or install PlotID from the source code.
Currently there are two options to run plotID. Either install it via pip from the Python Package Index (PyPi) or install plotID from the source code.
### From PyPi with pip
1. [Optional] Create a virtual environment and activate it:
```bash
pip install venv
mkdir venv
python3 -m venv
source venv/bin/activate
python3 -m venv venv
source venv/bin/activate # Unix
```
```cmd
venv\Scripts\activate.bat # Windows Command Prompt
2. Export the resulting file to a specified directory along the corresponding research data, the plot is based on. Additionally, the script that created the plot will also be copied to the directory.
...
...
@@ -46,7 +46,7 @@ PlotID has two main functionalities:
Tag your figure/plot with an ID.
`tagplot(figures, plot_engine)`
The variable "figures" can be a single figure or a list of multiple figures.
The argument "plot_engine" defines which plot engine was used to create the figures. It also determines which plot engine PlotID uses to place the ID on the plot. Currently supported plot engines are:
The argument "plot_engine" defines which plot engine was used to create the figures. It also determines which plot engine plotID uses to place the ID on the plot. Currently supported plot engines are:
- 'matplotlib'
tagplot returns a list that contains two lists each with as many entries as figures were given. The first list contains the tagged figures. The second list contains the corresponding IDs as strings
author = Institut Fluidsystemtechnik within nfdi4ing at TU Darmstadt
author_email = nfdi4ing@fst.tu-darmstadt.de
description = The plotID toolkit supports researchers in tracking and storing relevant data in plots. Plots are labelled with an ID and the corresponding data is stored.