Skip to content
Snippets Groups Projects
Commit 8bb2e120 authored by Paul McCarthy's avatar Paul McCarthy
Browse files

README/documentation updates.

parent 064608c6
No related branches found
No related tags found
No related merge requests found
Showing
with 79 additions and 53 deletions
fslpy
=====
The `fslpy` project is a collection of
[FSL](http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/) tools written in Python. Most
importantly, it is the home of *FSLeyes*, the FSL image viewer.
The `fslpy` project is a [FSL](http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/)
programming library written in Python. It is used by
[FSLeyes](https://git.fmrib.ox.ac.uk/paulmc/fsleyes/).
Documentation
-------------
Check out the [Installation instructions](https://git.fmrib.ox.ac.uk/paulmc/fslpy/wikis/home)
for details on getting started.
The [Documentation for users](http://users.fmrib.ox.ac.uk/~paulmc/fsleyes/index.html)
provides a comprehensive overview of how to use *FSLeyes*.
Take a look at the [Documentation for developers](http://users.fmrib.ox.ac.uk/~paulmc/fslpy/index.html)
if you want to program with `fslpy`.
Take a look at the [Documentation for
developers](http://users.fmrib.ox.ac.uk/~paulmc/fslpy/index.html) if you want
to program with `fslpy`.
Dependencies
......@@ -33,48 +25,19 @@ Dependencies
| Library | Version |
| ------------------------------------------------- | ------- |
| [props](https://git.fmrib.ox.ac.uk/paulmc/props/) | Latest |
| [PyOpenGL](http://pyopengl.sourceforge.net/) | 3.1.0 |
| [numpy](http://www.numpy.org/) | 1.8.1 |
| [scipy](http://www.scipy.org/) | 0.14.0 |
| [matplotlib](http://matplotlib.org/) | 1.4.3 |
| [nibabel](http://nipy.org/nibabel/) | 1.3.0 |
| [Pillow](https://python-pillow.github.io/) | 2.5.3 |
| [PyParsing](http://pyparsing.wikispaces.com/) | 2.1.0 |
| [Jinja2](http://jinja.pocoo.org/) | 2.8 |
| [wxPython](http://wxpython.org/) | 3.0.2.0 |
| [OSMesa](http://mesa3d.org/) | 8.0.5 |
| [six](https://pythonhosted.org/six/) | 1.10.0 |
| [Sphinx](http://www.sphinx-doc.org/en/stable/) | 1.3.5 |
| [wxPython](http://wxpython.org/) | 3.0.2.0 |
> Notes:
> - Sphinx is only needed for building the documentation.
>
> - OSMesa is only needed for the off-screen `render` program.
>
> - Pillow is only needed for saving screenshots in formats other than PNG.
>
> - If you are installing `fslpy` manually, don't worry too much about
> having the exact version of each of the packages - just try with
> the latest version, and roll-back if you have problems.
Being an OpenGL application, *FSLeyes* can only be used on computers
with graphics hardware that supports one of the following versions:
- OpenGL 1.4, with the following extensions:
- `ARB_vertex_program`
- `ARB_fragment_program`
- `EXT_framebuffer_object`
- OpenGL 2.1, with the following extensions:
- `EXT_framebuffer_object`
- `ARB_instanced_arrays`
- `ARB_draw_instanced`
Credits
-------
Some of the icons are derived from the Freeline icon set, by Enes Dal,
available at https://www.iconfinder.com/Enesdal, and released under the
Creative Commons (Attribution 3.0 Unported) license.
:orphan:
fsl.data.atlases module
=======================
......
:orphan:
fsl.data.constants module
=========================
......
:orphan:
fsl.data.featimage module
=========================
......
:orphan:
fsl.data.featresults module
===========================
......
:orphan:
fsl.data.image module
=====================
......
:orphan:
fsl.data.melodicimage module
============================
.. automodule:: fsl.data.melodicimage
:members:
:undoc-members:
:show-inheritance:
:orphan:
fsl.data.melodicresults module
==============================
.. automodule:: fsl.data.melodicresults
:members:
:undoc-members:
:show-inheritance:
:orphan:
fsl.data.model module
=====================
......
:orphan:
fsl.data.tensorimage module
===========================
.. automodule:: fsl.data.tensorimage
:members:
:undoc-members:
:show-inheritance:
fslpy |version|
===============
fsl package
===========
.. automodule:: fsl
:members:
......
:orphan:
fsl.data.strings module
=======================
.. automodule:: fsl.data.strings
fsl.utils.async module
======================
.. automodule:: fsl.utils.async
:members:
:undoc-members:
:show-inheritance:
:orphan:
fsl.utils.imagepanel module
===========================
.. automodule:: fsl.utils.imagepanel
:members:
:undoc-members:
:show-inheritance:
:orphan:
fsl.utils.path module
=====================
.. automodule:: fsl.utils.path
:members:
:undoc-members:
:show-inheritance:
:orphan:
fsl.utils.platform module
=========================
.. automodule:: fsl.utils.platform
:members:
:undoc-members:
:show-inheritance:
doc/images/atlasinfopanel.png

109 KiB

doc/images/atlasoverlaypanel.png

92.9 KiB

doc/images/atlaspanel_overlay_names.png

50.5 KiB

doc/images/canvassettingspanel.png

118 KiB

doc/images/clusterpanel.png

74.6 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment