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
dc07c99c
Commit
dc07c99c
authored
2 years ago
by
Hock, Martin
Browse files
Options
Downloads
Patches
Plain Diff
Adjust code blocks in readme
parent
7dcbd1e5
No related branches found
No related tags found
3 merge requests
!12
v.0.1 for alpha release
,
!11
Draft: Merge version0.1 changes into dev
,
!10
Version0.1
Pipeline
#740126
passed
2 years ago
Stage: linting
Stage: testing
Changes
1
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+25
-17
25 additions, 17 deletions
README.md
with
25 additions
and
17 deletions
README.md
+
25
−
17
View file @
dc07c99c
...
...
@@ -12,10 +12,12 @@ Currently there are two options to run PlotID. Either install it via pip from th
### From PyPi with pip
1.
*Optional*
Create a virtual environment and activate it:
`pip install venv`
`mkdir venv`
`python3 -m venv`
`source venv/bin/activate`
```
bash
pip
install
venv
mkdir
venv
python3
-m
venv
source
venv/bin/activate
```
2.
Install PlotID
`pip install --upgrade --index-url https://test.pypi.org/simple/ example-package-plotid-test`
...
...
@@ -24,10 +26,12 @@ Currently there are two options to run PlotID. Either install it via pip from th
`git clone https://git.rwth-aachen.de/plotid/plotid_python.git`
`cd plotid_python`
2.
[Optional] Create a virtual environment:
`pip install venv`
`mkdir venv`
`python3 -m venv`
`source venv/bin/activate`
```
bash
pip
install
venv
mkdir
venv
python3
-m
venv
source
venv/bin/activate
```
3.
Install dependencies
`pip install -r requirements.txt`
4.
Install PlotID
...
...
@@ -56,10 +60,12 @@ Optional parameters can be used to customize the tag process.
Location for ID to be displayed on the plot. Default is 'east'.
Example:
```
python
FIG1
=
plt
.
figure
()
FIG2
=
plt
.
figure
()
FIGS_AS_LIST
=
[
FIG1
,
FIG2
]
[
TAGGED_FIGS
,
ID
]
=
tagplot
(
FIGS_AS_LIST
,
'
matplotlib
'
,
prefix
=
'
XY23_
'
,
id_method
=
'
random
'
,
location
=
'
west
'
)
```
### publish()
...
...
@@ -85,10 +91,12 @@ If you want to build PlotID yourself, follow these steps:
`
git clone https://git.rwth-aachen.de/plotid/plotid_python.git
`
`
cd plotid_python
`
2. [Optional] Create a virtual environment:
`
pip install venv
`
`
mkdir venv
`
`
python3 -m venv
`
`
source venv/bin/activate
`
```bash
pip install venv
mkdir venv
python3 -m venv
source venv/bin/activate
```
3. [Optional] Run unittests and coverage:
`
python3 tests/runner_tests.py
`
4. Build the package
...
...
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