Changeset 2087 for trunk/docs


Ignore:
Timestamp:
Dec 8, 2015 6:02:57 PM (6 years ago)
Author:
toby
Message:

change error handling if h5py not installed; add new condition variable to importers (self.UseReader?); changes to docs to reflect this and consolidate description of package requirements

Location:
trunk/docs/source
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/source/imports.rst

    r2068 r2087  
    6060    method when ``strictExtension`` is False.
    6161  * ``formatName``: a string to be used in the menu. Should be short.
    62   * ``longFormatName``: a longer string to be used to describe the format in help.
     62  * ``longFormatName``: a longer string to be used to describe the
     63    format in help.
     64
     65Note that if an importer detects a condition which prevents its use,
     66for example because a required Python package is not present, it can
     67set the value of ``self.UseReader`` to False. Another possible use for
     68this would be an importer that requires a network connection to a
     69remote site. Setting ``self.UseReader`` to False must be done in the
     70``__init__`` method and will prevent the
     71importer from being used or included in the expected menu.
    6372
    6473Reader()
  • trunk/docs/source/index.rst

    r2027 r2087  
    3232* NumPy (http://docs.scipy.org/doc/numpy/reference/),
    3333* SciPy (http://docs.scipy.org/doc/scipy/reference/),
    34 * matplotlib (http://matplotlib.org/contents.html) 
    35 * PIL or Pillow (https://pillow.readthedocs.org) and
     34* matplotlib (http://matplotlib.org/contents.html)  and
    3635* PyOpenGL (http://pyopengl.sourceforge.net/documentation)
    3736
    38 These packages are not distributed as part of the Python standard
     37Two packages are used by some parts of the code, but are not required:
     38* PIL (http://www.pythonware.com/products/pil/) or Pillow (https://pillow.readthedocs.org). This is used to save
     39  and read certain types of images.
     40* h5py is the HDF5 support package. This is (not surprisingly) required
     41  to import images from HDF5 files. If this library is not present,
     42  the HDF5 importer(s) will not appear in the import menu and a
     43  warning message appears on GSAS-II startup.
     44
     45Note that the packages listed above are not distributed as part of the Python standard
    3946library and must be obtained separately (or in a bundled Python
    40 package such as the Enthought Python Distribution/Canopy or
    41 Continuum.io's anaconda).  The PyOpenGL package will be installed into
     47package such as the Enthought Inc.'s Canopy or
     48Continuum.io's anaconda; we also use the older Enthought Python
     49Distribution). 
     50One exception is the PyOpenGL package. This will be installed into
    4251Python by GSAS-II if not found, so it does not need to be included in
    4352the Python bundle, but the setuptools package
Note: See TracChangeset for help on using the changeset viewer.