diff options
Diffstat (limited to 'PKG-INFO')
| -rw-r--r-- | PKG-INFO | 87 |
1 files changed, 64 insertions, 23 deletions
@@ -1,6 +1,6 @@ Metadata-Version: 1.1 Name: silx -Version: 0.5.0 +Version: 0.6.0 Summary: Software library for X-Ray data analysis Home-page: https://github.com/silx-kit/silx Author: data analysis unit @@ -10,20 +10,30 @@ Description: silx toolkit ============ - The silx project aims at providing a collection of Python packages to support the development of data assessment, reduction and analysis applications at synchrotron radiation facilities. - It aims at providing reading/writing different file formats, data reduction routines and a set of Qt widgets to browse and visualize data. + The silx project aims at providing a collection of Python packages to support the + development of data assessment, reduction and analysis applications at synchrotron + radiation facilities. + It aims at providing reading/writing different file formats, data reduction routines + and a set of Qt widgets to browse and visualize data. - The current version provides : + The current version provides: - * reading `HDF5 <https://www.hdfgroup.org/HDF5/>`_ file format (with support of `SPEC <https://certif.com/spec.html>`_ file format) + * reading `HDF5 <https://www.hdfgroup.org/HDF5/>`_ file format (with support of + `SPEC <https://certif.com/spec.html>`_ file format and + `FabIO <http://www.silx.org/doc/fabio/dev/getting_started.html#list-of-file-formats-that-fabio-can-read-and-write>`_ + images) * histogramming * fitting - * 1D and 2D visualization using multiple backends (matplotlib or OpenGL) - * image plot widget with a set of associated tools (See `changelog file <https://github.com/silx-kit/silx/blob/master/CHANGELOG.rst>`_). - * Unified browser for HDF5, SPEC and image file formats supporting inspection and visualization of n-dimensional datasets. - * Unified viewer (silx view filename) for HDF5, SPEC and image file formats - * OpenGL-based widget to display 3D scalar field with isosurface and cutting plane. + * 1D and 2D visualization widgets using multiple backends (matplotlib or OpenGL) + * an OpenGL-based widget to display 3D scalar field with isosurface and cutting plane + * an image plot widget with a set of associated tools + * a unified browser for HDF5, SPEC and image file formats supporting inspection and + visualization of n-dimensional datasets. + * a unified viewer (*silx view filename*) for HDF5, SPEC and image file formats + * a unified converter to HDF5 format (*silx convert filename*) + * median filters on images (C and OpenCL implementations) * image alignement (sift - OpenCL implementation) + * filtered backprojection and forward projection for tomography Installation ------------ @@ -31,21 +41,36 @@ Description: To install silx, run:: pip install silx + + Or with Anaconda on Linux and MacOS:: + + conda install silx -c conda-forge To install silx locally, run:: pip install silx --user - On Linux, to install silx with pip, you must install numpy first. Unofficial packages for different distributions are available : + Unofficial packages for different distributions are available : - Unofficial Debian8 packages are available at http://www.silx.org/pub/debian/ - CentOS 7 rpm packages are provided by Max IV at the following url: http://pubrepo.maxiv.lu.se/rpm/el7/x86_64/ - Fedora 23 rpm packages are provided by Max IV at http://pubrepo.maxiv.lu.se/rpm/fc23/x86_64/ - Arch Linux (AUR) packages are also available: https://aur.archlinux.org/packages/python-silx - On Windows, pre-compiled binaries (aka Python wheels) are available for Python 2.7, 3.5 and 3.6. + Beside this, we provide a certain number of wheels (pre-compiled binary packages) to be installed + onto a pre-existing Python installation: + + - On Windows, binary wheels are available for Python 2.7, 3.5 and 3.6. + - On MacOS, binary wheels are available for Python 2.7, 3.4, 3.5 and 3.6. + - On Linux, manylinux1 binary wheels are available for Python 2.7, 3.4, 3.5 and 3.6. + + Those builds are made from "up-date" systems at the time of the release, i.e. they use + the latest stable version of numpy (and cython). + Hence your system should use a fairly recent version of numpy to be compatible with silx. + This can be achieved simply by:: + + pip install numpy --upgrade - On Mac OS X, pre-compiled binaries (aka Python wheels) are available for Python 2.7. The latest development version can be obtained from the git repository:: @@ -65,19 +90,28 @@ Description: * `matplotlib <http://matplotlib.org/>`_ for the silx.gui.plot package * `PyOpenGL <http://pyopengl.sourceforge.net/>`_ for the silx.gui.plot3d package - Most modules and functions dealing with `HDF5 <https://www.hdfgroup.org/HDF5/>`_ input/output depend on the following extra package: + Most modules and functions dealing with `HDF5 <https://www.hdfgroup.org/HDF5/>`_ input/output depend on: + * `h5py <http://www.h5py.org/>`_ - * `ipython <https://ipython.org/>`_ and `qtconsole <https://pypi.python.org/pypi/qtconsole>`_ is required by silx.gui.console.py + Parallel algorithms depend on: + + * `PyOpenCL <https://documen.tician.de/pyopencl/>`_ + + The console widgets depend on: + + * `ipython <https://ipython.org/>`_ + * `qtconsole <https://pypi.python.org/pypi/qtconsole>`_ + Supported platforms: Linux, Windows, Mac OS X. Documentation ------------- - Documentation of releases is available at https://pythonhosted.org/silx/ + Documentation of latest release is available at http://www.silx.org/doc/silx/latest/ - Latest documentation (nightly build) is available at http://www.silx.org/doc/silx/ + Documentation of previous releases and nightly build is available at http://www.silx.org/doc/silx/ To build the documentation from the source (requires `Sphinx <http://www.sphinx-doc.org>`_), run:: @@ -101,21 +135,28 @@ Description: Examples -------- - Some examples are available in the source code repository. For example:: - - python examples/{exampleName.py} + Some examples of sample code using silx are provided with the + `silx documentation <http://www.silx.org/doc/silx/dev/sample_code/index.html>`_. License ------- - The source code of silx is licensed under the MIT and LGPL licenses. - See the `copyright file <https://github.com/silx-kit/silx/blob/master/copyright>`_ for details. + The source code of silx is licensed under the MIT license. + See the `LICENSE <https://github.com/silx-kit/silx/blob/master/LICENSE>`_ and `copyright <https://github.com/silx-kit/silx/blob/master/copyright>`_ files for details. + + Citation + -------- + + silx releases can be cited by their DOI on Zenodo: |DOI:10.5281/zenodo.1000472| .. |Travis Status| image:: https://travis-ci.org/silx-kit/silx.svg?branch=master :target: https://travis-ci.org/silx-kit/silx .. |Appveyor Status| image:: https://ci.appveyor.com/api/projects/status/qgox9ei0wxwfagrb/branch/master?svg=true :target: https://ci.appveyor.com/project/ESRF/silx + .. |DOI:10.5281/zenodo.1000472| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1000472.svg + :target: https://doi.org/10.5281/zenodo.1000472 + Platform: UNKNOWN Classifier: Development Status :: 4 - Beta @@ -126,7 +167,6 @@ Classifier: Environment :: X11 Applications :: Qt Classifier: Intended Audience :: Education Classifier: Intended Audience :: Science/Research Classifier: License :: OSI Approved :: MIT License -Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+) Classifier: Natural Language :: English Classifier: Operating System :: MacOS Classifier: Operating System :: Microsoft :: Windows @@ -135,6 +175,7 @@ Classifier: Programming Language :: Cython Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3.4 Classifier: Programming Language :: Python :: 3.5 +Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Topic :: Scientific/Engineering :: Physics Classifier: Topic :: Software Development :: Libraries :: Python Modules |