Skip to content

Commit 8294d4f

Browse files
committed
readme typos
1 parent 6b78244 commit 8294d4f

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ Getting Started
3737

3838
Install getdist using pip::
3939

40-
$ sudo pip install getdist
40+
$ pip install getdist
4141

4242
or from source files using::
4343

44-
$ sudo python setup.py install
44+
$ python setup.py install
4545

4646
You can test if things are working using the unit test by running::
4747

@@ -50,6 +50,8 @@ You can test if things are working using the unit test by running::
5050
Check the dependencies listed in the next section are installed. You can then use the getdist module from your scripts, or
5151
use the GetDist GUI (*getdist-gui* command).
5252

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>`_.
5355

5456
Dependencies
5557
=============
@@ -104,7 +106,7 @@ The .ranges file gives hard bounds for the parameters, e.g.::
104106

105107
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.
106108

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
108110
fraction *x* of the file rows (or if *x > 1*, the specified number of rows).
109111

110112
Loading samples
@@ -130,10 +132,11 @@ from two chains with root names *xxx* and *yyy*::
130132

131133
from getdist import plots
132134
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'])
134136

135137

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>`_.
137140

138141
GetDist script
139142
===================

0 commit comments

Comments
 (0)