update doc

cmbant · May 26, 2021 · eeb0030 · eeb0030
1 parent a1aa45d
commit eeb0030
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 13 deletions.
diff --git a/docs/source/gui.rst b/docs/source/gui.rst
@@ -7,7 +7,7 @@ It allows you to open a folder of chain files, then easily select, open, plot an
 
 .. image:: https://cdn.cosmologist.info/antony/getdist/gui_planck2018.png
 
-It can open chain files under a selected directry structure (and also `paramgrid <https://cosmologist.info/cosmomc/readme_grids.html>`_ directories as show above).
+It can open chain files under a selected directory structure (and also `paramgrid <https://cosmologist.info/cosmomc/readme_grids.html>`_ directories as show above).
 See the `intro <https://getdist.readthedocs.io/en/latest/intro.html>`_ for a description of chain file formats.  A grid of sample chains files can be
 downloaded `here <http://pla.esac.esa.int/pla/#cosmology>`_, after downloading a file just unzip and open the main directory in the GUI.
 
@@ -48,16 +48,17 @@ Installation
 To run the GUI you need PySide2. This is not included in default dependencies
 because it is only needed for the GUI and on some systems installation from pip may not work easily.
 
-Install PySide2 from pip using::
+The most reliable way to get PySide2 working is to use `Anaconda <https://www.anaconda.com/distribution/>`_, making a consistent new environment from conda-forge (which includes PySide2)  e.g. ::
 
- pip install PySide2
+  conda create -n py39forge -c conda-forge python=3.9 scipy pandas matplotlib PyYAML PySide2
+
+(note that PySide2 is currently not included in the default Anaconda packages). You can also install PySide2 from conda-forge in an existing environment.
 
-You can also use `Anaconda <https://www.anaconda.com/distribution/>`_,
-making a consistent new environment from conda-forge (which includes PySide2) using::
+You can also install PySide2 from pip using::
 
-  conda create -n py39forge -c conda-forge python=3.9 scipy pandas matplotlib PySide2
+ pip install PySide2
 
-(note that PySide2 is currently not included in the default Anaconda packages).
+However on some configurations this appears not to work very reliably.
 
 Once PySide2 is set up, (re)install getdist and you should then be able to use the getdist-gui script on your path.
 On a Mac the installation will also make a GetDist GUI Mac app, which you can find using Spotlight.

diff --git a/docs/source/types.rst b/docs/source/types.rst
@@ -5,8 +5,3 @@ getdist.types
 
 .. automodule:: getdist.types
    :members:
-
-
-
-
-
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
 numpy
 matplotlib>=2.2.0
-scipy>=1.0.0
+scipy>=1.5.0
+PyYAML>=5.1