diff --git a/README.md b/README.md index 099103e02a347e829939c53304ca5f8c8686e625..c12e4d0e43eee3e766b527d4efffe4ab3311058f 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Feel free to give feedback and feature requests or to take part in the developme **Requirements:** MATLAB R2021a or newer **First use:** -1. Put your PlotID folder in you [userpath](https://uk.mathworks.com/help/matlab/ref/userpath.html) on Windows this is +1. Put your PlotID folder in you [userpath](https://uk.mathworks.com/help/matlab/ref/userpath.html) on Windows this is `C:\Users\USERNAME\Documents\MATLAB`. \ When using a diffrent folder, make sure the folder is on your [search path](https://uk.mathworks.com/help/matlab/matlab_env/add-remove-or-reorder-folders-on-the-search-path.html). @@ -23,7 +23,7 @@ The **ProjectID** is your custom project number, it well be the prefix of the ID `PlotID` works in two Steps: 1. Tag the plot -`[figs, IDs] = PlotId.TagPlot(figs, options)` +`[figs, IDs] = PlotID.TagPlot(figs, options)` 2. Publish the plot and the associated data `PlotID.Publish(DataPaths,scriptPath, figure, options)` @@ -44,7 +44,7 @@ PlotID.Publish(rdata, script, fig); **Please take also a look on the examples provided in the Example folder**. - + # PlotID.TagPlot() `[figs, IDs] = TagPlot(figs, options)` @@ -57,15 +57,15 @@ The ID is placed visual on the figure window and as Tag (property of the figure) _options_ \ you find the options for TagPlot below. The data type is in curled braces and the default value follows the equal sign. -- ProjectID {mustBeText}= '' -- Fontsize {mustBeInteger} = 8 -- Color {mustBeNonnegative} = 0.65*[1 1 1] +- ProjectID {mustBeText}= '' +- Fontsize {mustBeInteger} = 8 +- Color {mustBeNonnegative} = 0.65*[1 1 1] - Location {mustBeText} = 'east' -- Position {mustBeVector} = [1,0.4] -- DistanceToAxis {mustBeReal} = .02 -- Rotation {mustBeInteger} = 0 -- PinToLegend {mustBeNumericOrLogical} = false -- QRcode {mustBeNumericOrLogical} = false +- Position {mustBeVector} = [1,0.4] +- DistanceToAxis {mustBeReal} = .02 +- Rotation {mustBeInteger} = 0 +- PinToLegend {mustBeNumericOrLogical} = false +- QRcode {mustBeNumericOrLogical} = false - QRsize {mustBeNonnegative} = 0.15 `options.ProjectID` is the project number (string or char), if empty the ID from the config file is used @@ -80,19 +80,19 @@ The ID is placed on the 'east' of the figure per default, if you want it somwher CreateID Creates an identifier (char). It creates an (sometimes unique) identifier based on the selected method, if no method is selected method 1 will be the default method. 1. **UNIX Time in seconds as HEX** \ -This is used by default due to its simplicity and it is human readable. +This is used by default due to its simplicity and it is human readable. 2. **random UUID from Java 128 bit.**\ Static factory to retrieve a type 4 (pseudo randomly generated) UUID. The UUID is generated using a cryptographically strong pseudo random number generator. -## friendlyID() +## friendlyID() `[IDf,PrjID, Str] = friendlyID(ID)` \ FriendlyID Changes the Hex Number to a human friendly *datetime* and *dateStr*. `IDf` returns the ID as DateTime Object, `PrjID` returns the ProjectID, `Str` returns the timestamp as String. \ **This only works with ID method 1.** -# PlotID.Publish() +# PlotID.Publish() `Publish(DataPaths,scriptPath, figure, options)` \ -Publishes saves plot, data and measuring script +Publishes saves plot, data and measuring script Location sets the storage location. 'local' sets the storage location to the current folder (an export folder will be created), 'manual' opens an explorer window, where you can choose the desired folder. If you define a export path in the config file, this will used per default (exportPath). Two Methods are implemented 'individual' stores the data for each plot while 'centralized' uses a data folder and uses reference links to the original data (hdf5 only). ParentFolder is the folder name where the exported data is stored if a path is used, PlotId will use this path a storagePath. @@ -160,7 +160,7 @@ You can change the options in the json file, but be carefull no argumentValidati <details><summary> Expand </summary> It is possible to use individual config files for each project (configP1.json, configP2.json, ...) \ -1. Create a new config file programatically +1. Create a new config file programatically ``` customConfigFileName = 'configP1.json'; configObj = PlotID.config(customConfigFileName); @@ -182,5 +182,6 @@ you need to provide the name of your custom config file to tagplot as well as to 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. # Known Issues -**Closed figure will cause error** Please do not cloase the figure, MATLAB deletes the object if you do so. +**Closed figure will cause error** Please do not cloase the figure, MATLAB deletes the object if you do so. \ +**Centralized Method does not work on Linux systems**