Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
plotID_python
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
plotID
plotID_python
Commits
4631d7ad
You need to sign in or sign up before continuing.
Commit
4631d7ad
authored
2 years ago
by
Mayr, Hannes
Browse files
Options
Downloads
Patches
Plain Diff
Improve documentation.
parent
fe42f2fe
No related branches found
No related tags found
1 merge request
!73
Small documentation improvements and dependency updates
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+7
-6
7 additions, 6 deletions
README.md
with
7 additions
and
6 deletions
README.md
+
7
−
6
View file @
4631d7ad
...
...
@@ -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 s
e
t of setting up a virtual environment.
**Installation is the same for Windows and Unix systems, except**
for the
**optional**
first st
ep
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
N
ame for the exported plot. If not provided, the corresponding IDs will be used.
n
ame 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
)
:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment