|
|
## PlotID (en)
|
|
|
|
|
|
You can find the slides of the presentation held on 28th September 2021, at the NFDI4Ing-Conference here:
|
|
|
(soonTM)
|
|
|
|
|
|
You can find the slides of the presentation held on 28th September 2021, at the NFDI4Ing-Conference here: <https://zenodo.org/record/5714480#.YZfVWLoxlhE>
|
|
|
|
|
|
### explain the idea behind
|
|
|
A majority of information and important data in engineering and other STEM fields is found within plots and data represantitions in general. Connecting these representations with the data (pools) they're based on and the programs and code that was used to arrive at the presented figures is a huge step in making information ~f~indable and ~a~ccessible
|
|
|
|
|
|
### method
|
|
|
A majority of information and important data in engineering and other STEM fields is found within plots and data represantitions in general. Connecting these representations with the data (pools) they're based on and the programs and code that was used to arrive at the presented figures is a huge step in making information \~f\~indable and \~a\~ccessible
|
|
|
|
|
|
### method
|
|
|
|
|
|
PlotID strives to keep the process as simple as possible with these two provided functions:
|
|
|
|
|
|
1. Tag the figure with an ID, make the ID part of the plotted data and if possibles append the ID as metadata
|
... | ... | @@ -16,27 +16,33 @@ PlotID strives to keep the process as simple as possible with these two provided |
|
|
These relate to the two core functions:
|
|
|
|
|
|
### core functions
|
|
|
|
|
|
#### TagPlot
|
|
|
TagPlot is to be called upon finishing the original plotting process
|
|
|
Inputs:
|
|
|
|
|
|
TagPlot is to be called upon finishing the original plotting process Inputs:
|
|
|
|
|
|
- figure object - the object to be marked with the ID
|
|
|
- (optional) ProjectID prefix - to group different plots or show the relation to a project, this is handled in a config file ('config.json')
|
|
|
- (optional) options argument for rotation, fontsize, position or a special ID
|
|
|
Working defaults are implemented in every case.
|
|
|
- (optional) options argument for rotation, fontsize, position or a special ID\
|
|
|
Working defaults are implemented in every case.
|
|
|
|
|
|
Outputs:
|
|
|
|
|
|
Outputs:
|
|
|
- figure object fitted with the ID
|
|
|
|
|
|
#### Publish
|
|
|
|
|
|
Inputs:
|
|
|
|
|
|
- figure - the figure object (that was fitted with an ID before - although figures without ID can also be used)
|
|
|
- ID - the identification under which the different objects will be collected
|
|
|
- DataPaths - a variable containing the paths to all relevant data and code files (code files can be derived programmatically - see example file)
|
|
|
- options - storage location, data storage method, ... (see documentation for more details)
|
|
|
- options - storage location, data storage method, ... (see documentation for more details)
|
|
|
|
|
|
Output:
|
|
|
- a folder containing the figure, data files and code used to create the plot, named with the ID
|
|
|
|
|
|
- a folder containing the figure, data files and code used to create the plot, named with the ID
|
|
|
|
|
|
## PlotID (de)
|
|
|
lorem ipsum
|
|
|
|
|
|
lorem ipsum |
|
|
\ No newline at end of file |