README.md 3.66 KB
Newer Older
Yori Fournier's avatar
Yori Fournier committed
1 2 3 4 5 6 7 8
# Summary
1. [Motivation](#1-motivation)
2. [The Power of myplotlib](#2-the-power-of-myplotlib)
3. [Install from source](#3-install-from-source-without-an-account-at-gitlabaipde)
4. [Install with git](#4-install-with-git-with-an-account-at-gitlabaipde)
5. [Get started](#5-get-started)

# 1. Motivation
Yori Fournier's avatar
Yori Fournier committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

>>>
As a scientist you need to produce plots.

The question is how to plot? 
>>>

**plot and compare subsets of large data sets**

>>>
You usually face large data sets,
which you want to process in different manner
to extract and plot a single aspect of this data set.

But you may also want to compare a single aspect 
of different data sets, or on the contrary different aspects 
of a single data set.
>>>

**plot fast and interactively**

>>>
And you may want to do in a fast and interactive 
manner.
>>>

**be sure what you plot**

>>>
But the most important for a scientist is to control what 
you do and be sure of what you plot.
>>>

**clear and transparent way to plot**

>>>
Plots are the key value of your work. 
You want to spend time on the quality of the content and form. 
Not on the technical aspect of how to plot what.
>>>

**reuse, improve, and combine your plots**

>>>
After spending time on designing the content and the 
form of a single plot you want to be able to use it for 
various data sets without loosing consistence between 
versions of the plot. 
>>>

 **keep track of your plots over long periods**

>>>
Finally, when you come back on some former work, 
you don't want to rethink about the technique, 
you want to start from the same point as before 
from another point of view.
>>>

**These are the basic features of `myplotlib` and much more.**



Yori Fournier's avatar
Yori Fournier committed
72
# 2. The power of `myplotlib`
Yori Fournier's avatar
Yori Fournier committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101

`myplotlib` allows you to design a plot, that consist 
of a single file. 
It can then plotted alone or combined with any other plot.

This plot contains it own data processing method and 
can be used for any compatible raw data you provide. 

A plot can be called interactively from a python interpreter, 
or from the command line. 

The same plot can be drawn on screen or directly in a file 
making sure that what you see is what you get.

Producing files of the same aspect of large number of 
data sets is possible thanks to the scripting mode.

Because a plot is in a unique file, any changes will 
be spread, allowing fast and consistent corrections.



## `myplotlib` can:

   - interactive mode
   - script mode
   - consistent corrections
   - versatile dataset
   - full user control on IOs and data processing 
Yori Fournier's avatar
Yori Fournier committed
102 103 104 105
     making it fast and safe



Yori Fournier's avatar
Yori Fournier committed
106
# 3. Install from source **(without an account at gitlab.aip.de)**
Yori Fournier's avatar
Yori Fournier committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

### STEP 1: download source of the module myplotlib

- [zip](https://gitlab.aip.de/yfournier/myplotlib/repository/archive.zip?ref=v3.0.1a)
- [tar.gz](https://gitlab.aip.de/yfournier/myplotlib/repository/archive.tar.gz?ref=v3.0.1a)

extract and rename like `/home/user/src/python/myplotlib`

### STEP 2: Install

Set the python path
```
export PYTHONPATH="/home/user/src/python/"
```

Create your config file (in `/home/user/src/python/myplotlib/`)
```
cp config-default.py config.py
```

### STEP 3: testing

in `/home/user/src/python/`

```
python2.6 -m myplotlib.__main__ -t
python2.7 -m myplotlib -t
python3 -m myplotlib -t
```

This will execute a series of tests, they should all be successful.

> **REMARK**: If you get some errors, try the minimal configuration: replace config.py with myplotlib/.configs/minimal-config.py

Yori Fournier's avatar
Yori Fournier committed
141 142 143 144 145
# 4. Install with git (with an account at gitlab.aip.de)

> comming soon

# 5. Get started
Yori Fournier's avatar
Yori Fournier committed
146

Yori Fournier's avatar
Yori Fournier committed
147 148
- [first plot](https://gitlab.aip.de/yfournier/myplotlib/wikis/how-to-use-interactively)
- [how to use myplotlib](https://gitlab.aip.de/yfournier/myplotlib/wikis/how-to-use-myplotlib)