You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+8-5Lines changed: 8 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -37,11 +37,11 @@ Getting Started
37
37
38
38
Install getdist using pip::
39
39
40
-
$ sudo pip install getdist
40
+
$ pip install getdist
41
41
42
42
or from source files using::
43
43
44
-
$ sudo python setup.py install
44
+
$ python setup.py install
45
45
46
46
You can test if things are working using the unit test by running::
47
47
@@ -50,6 +50,8 @@ You can test if things are working using the unit test by running::
50
50
Check the dependencies listed in the next section are installed. You can then use the getdist module from your scripts, or
51
51
use the GetDist GUI (*getdist-gui* command).
52
52
53
+
Once installed, the best way to get up to speed is probably to read through
54
+
the `Plot Gallery and tutorial <http://getdist.readthedocs.org/en/latest/plot_gallery.html>`_.
53
55
54
56
Dependencies
55
57
=============
@@ -104,7 +106,7 @@ The .ranges file gives hard bounds for the parameters, e.g.::
104
106
105
107
Note that not all parameters need to be specified, and "N" can be used to denote that a particular upper or lower limit is unbounded. The ranges are used to determine densities and plot bounds if there are samples near the boundary; if there are no samples anywhere near the boundary the ranges have no affect on plot bounds, which are chosen appropriately for the range of the samples.
106
108
107
-
There can also optionally be a .properties.ini file, which can specify *burn_removed=T* to ensure no burn in is removed, or *ignore_rows=x" to ignore the first
109
+
There can also optionally be a .properties.ini file, which can specify *burn_removed=T* to ensure no burn in is removed, or *ignore_rows=x* to ignore the first
108
110
fraction *x* of the file rows (or if *x > 1*, the specified number of rows).
109
111
110
112
Loading samples
@@ -130,10 +132,11 @@ from two chains with root names *xxx* and *yyy*::
130
132
131
133
from getdist import plots
132
134
g = plots.get_single_plotter(chain_dir='/path/to/', analysis_settings={'ignore_rows':0.3})
133
-
g.plot_2d(['xxx','yyy], ['x', 'y'])
135
+
g.plot_2d(['xxx','yyy'], ['x', 'y'])
134
136
135
137
136
-
MCSamples objects can also be constructed directly from numpy arrays in memory, see the example in the `Plot Gallery <http://getdist.readthedocs.org/en/latest/plot_gallery.html>`_.
138
+
MCSamples objects can also be constructed directly from numpy arrays in memory, see the example
139
+
in the `Plot Gallery <http://getdist.readthedocs.org/en/latest/plot_gallery.html>`_.
0 commit comments