From 4631d7ad5019d695e2de43835a7f98368f2187cc Mon Sep 17 00:00:00 2001 From: "Mayr, Hannes" <hannes.mayr@stud.tu-darmstadt.de> Date: Tue, 14 Mar 2023 14:27:32 +0100 Subject: [PATCH] Improve documentation. --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a2cf2ac..fb68023 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ plotID is a program connected to Research Data Management (RDM). It has two main ## 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. -**Installation is the same for Windows and Unix systems, except** for the **optional** first set of setting up a virtual environment. +**Installation is the same for Windows and Unix systems, except** for the **optional** first step of setting up a virtual environment. 1. [Optional] Create a virtual environment and activate it: ```bash @@ -90,13 +90,14 @@ Save plot, data and measuring script. Modules that are imported in the script wh Optional parameters can be used to customize the publish process. - *data_storage*: str, optional Method how the data should be stored. Available options: - - *centralized*: The raw data will copied only once. All other plots will reference this data via sym link. - - *individual*: The complete raw data will be copied to a folder for every plot, respectively. + - *centralized* (not implemented yet): The raw data will copied only once. All other plots will reference this data via sym link. + - *individual* (default): The complete raw data will be copied to a folder for every plot, respectively. - *plot_names* : str or list of str, optional - Name for the exported plot. If not provided, the corresponding IDs will be used. + name for the exported plot. If not provided, the corresponding IDs will be used. Example: -`publish(figs_and_ids, "/home/user/Documents/research_data", "/home/user/Documents/exported_data", plot_names=["EnergyOverTime-Plot", "TimeOverEnergy-Plot")` - +```python +publish(FIGS_AND_IDS, "/home/user/Documents/research_data", "/home/user/Documents/exported_data", plot_names=["EnergyOverTime-Plot", "TimeOverEnergy-Plot")` +``` ## Build If you want to build plotID yourself, follow these steps: 1. Download the source code from [Gitlab](https://git.rwth-aachen.de/plotid/plotid_python): -- GitLab