diff --git a/README.md b/README.md index fcd6e1d92c15fe4d6e7dd611126867d76810f7ff..b0f59a94ae17deb6774927dd3850bbfa241f535a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,18 @@ 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. diff --git a/doc/fsl.data.atlases.rst b/doc/fsl.data.atlases.rst index b2bdd3803ebeadeb167c7f8e6bc7f0508221176d..9cd7ad3362d7da061b710c0a471cc5d69ea9e059 100644 --- a/doc/fsl.data.atlases.rst +++ b/doc/fsl.data.atlases.rst @@ -1,5 +1,5 @@ :orphan: - + fsl.data.atlases module ======================= diff --git a/doc/fsl.data.constants.rst b/doc/fsl.data.constants.rst index 4f869aaff45c85540d17116a3662471f9bd45181..96a40ad03a07d3245e913529089bab569db4d1df 100644 --- a/doc/fsl.data.constants.rst +++ b/doc/fsl.data.constants.rst @@ -1,5 +1,5 @@ :orphan: - + fsl.data.constants module ========================= diff --git a/doc/fsl.data.featimage.rst b/doc/fsl.data.featimage.rst index 9257ff68a16dbd755b35175af3519542cbd7bef4..f97692f41139c389218eac8616dcd99940629a39 100644 --- a/doc/fsl.data.featimage.rst +++ b/doc/fsl.data.featimage.rst @@ -1,5 +1,5 @@ :orphan: - + fsl.data.featimage module ========================= diff --git a/doc/fsl.data.featresults.rst b/doc/fsl.data.featresults.rst index af8f073cb998f9baa7e8f99cb22966dbc9b9b593..2459ec5232ad423741a8757c825b3c323b5f1c88 100644 --- a/doc/fsl.data.featresults.rst +++ b/doc/fsl.data.featresults.rst @@ -1,5 +1,5 @@ :orphan: - + fsl.data.featresults module =========================== diff --git a/doc/fsl.data.image.rst b/doc/fsl.data.image.rst index 168a695886913b090cd768ad177696c8ef5221ea..ae7549eba41d2dbf615836befcb72a798bae7310 100644 --- a/doc/fsl.data.image.rst +++ b/doc/fsl.data.image.rst @@ -1,5 +1,5 @@ :orphan: - + fsl.data.image module ===================== diff --git a/doc/fsl.data.melodicimage.rst b/doc/fsl.data.melodicimage.rst new file mode 100644 index 0000000000000000000000000000000000000000..448af591849be88f6be7ffff4f2926e8758b4362 --- /dev/null +++ b/doc/fsl.data.melodicimage.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.data.melodicimage module +============================ + +.. automodule:: fsl.data.melodicimage + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fsl.data.melodicresults.rst b/doc/fsl.data.melodicresults.rst new file mode 100644 index 0000000000000000000000000000000000000000..8c74240d3bafb2862264a1cb147bd3efca53d88d --- /dev/null +++ b/doc/fsl.data.melodicresults.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.data.melodicresults module +============================== + +.. automodule:: fsl.data.melodicresults + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fsl.data.model.rst b/doc/fsl.data.model.rst index 626c2f56684e9a2bccb2b0840b5dee8139a7b7b9..513fc47373acee41d27b53ef7d2d8155d975a49a 100644 --- a/doc/fsl.data.model.rst +++ b/doc/fsl.data.model.rst @@ -1,5 +1,5 @@ :orphan: - + fsl.data.model module ===================== diff --git a/doc/fsl.data.strings.rst b/doc/fsl.data.strings.rst deleted file mode 100644 index 2e3dc04efc101ee17fc90793b3a976f6f391a9ad..0000000000000000000000000000000000000000 --- a/doc/fsl.data.strings.rst +++ /dev/null @@ -1,9 +0,0 @@ -:orphan: - -fsl.data.strings module -======================= - -.. automodule:: fsl.data.strings - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/fsl.data.tensorimage.rst b/doc/fsl.data.tensorimage.rst new file mode 100644 index 0000000000000000000000000000000000000000..28b5cf50c72f6280bb52baddc9ebbe9368d740b4 --- /dev/null +++ b/doc/fsl.data.tensorimage.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.data.tensorimage module +=========================== + +.. automodule:: fsl.data.tensorimage + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fsl.rst b/doc/fsl.rst index 3a79585f82f99226210092b18ce20b57b7ac6c71..378faff43e99542ddb72385ada3ace232bf32525 100644 --- a/doc/fsl.rst +++ b/doc/fsl.rst @@ -1,5 +1,5 @@ -fslpy |version| -=============== +fsl package +=========== .. automodule:: fsl :members: diff --git a/doc/fsl.utils.async.rst b/doc/fsl.utils.async.rst new file mode 100644 index 0000000000000000000000000000000000000000..31d3ce0a8b5f7ca02d9190180e5e7bfbfdbb65fe --- /dev/null +++ b/doc/fsl.utils.async.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.utils.async module +====================== + +.. automodule:: fsl.utils.async + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fsl.utils.imagepanel.rst b/doc/fsl.utils.imagepanel.rst new file mode 100644 index 0000000000000000000000000000000000000000..8816d5f4456d575ccc38033ffae2ac59e29aa09e --- /dev/null +++ b/doc/fsl.utils.imagepanel.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.utils.imagepanel module +=========================== + +.. automodule:: fsl.utils.imagepanel + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fsl.utils.path.rst b/doc/fsl.utils.path.rst new file mode 100644 index 0000000000000000000000000000000000000000..8b9ed086942592cce2ab6aeb77f7659beda17799 --- /dev/null +++ b/doc/fsl.utils.path.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.utils.path module +===================== + +.. automodule:: fsl.utils.path + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fsl.utils.platform.rst b/doc/fsl.utils.platform.rst new file mode 100644 index 0000000000000000000000000000000000000000..2ea7c014fd7134dcc5cdc549842304396ad5ff98 --- /dev/null +++ b/doc/fsl.utils.platform.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.utils.platform module +========================= + +.. automodule:: fsl.utils.platform + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/images/atlasinfopanel.png b/doc/images/atlasinfopanel.png deleted file mode 100644 index 378f50c46797826f9552a5ee682c0d52ab4006d1..0000000000000000000000000000000000000000 Binary files a/doc/images/atlasinfopanel.png and /dev/null differ diff --git a/doc/images/atlasoverlaypanel.png b/doc/images/atlasoverlaypanel.png deleted file mode 100644 index dc39dc595a94d40bc8205720d2a690113d986046..0000000000000000000000000000000000000000 Binary files a/doc/images/atlasoverlaypanel.png and /dev/null differ diff --git a/doc/images/atlaspanel_overlay_names.png b/doc/images/atlaspanel_overlay_names.png deleted file mode 100644 index 287a92da98e61712d55ed7b46f5fedaa35824845..0000000000000000000000000000000000000000 Binary files a/doc/images/atlaspanel_overlay_names.png and /dev/null differ diff --git a/doc/images/canvassettingspanel.png b/doc/images/canvassettingspanel.png deleted file mode 100644 index 6a2d17378c83635af6d022bd4fef4ded588b6d0d..0000000000000000000000000000000000000000 Binary files a/doc/images/canvassettingspanel.png and /dev/null differ diff --git a/doc/images/clusterpanel.png b/doc/images/clusterpanel.png deleted file mode 100644 index 97188d1a4f62406cb97b52a4a00029c69a164975..0000000000000000000000000000000000000000 Binary files a/doc/images/clusterpanel.png and /dev/null differ diff --git a/doc/images/editor.png b/doc/images/editor.png deleted file mode 100644 index 0d6216b498267cdc093f26e4d9b1d7fc83a3e53f..0000000000000000000000000000000000000000 Binary files a/doc/images/editor.png and /dev/null differ diff --git a/doc/images/fsleyes.png b/doc/images/fsleyes.png deleted file mode 100644 index 7335a98013a646706ba50b678970a6e1561e0113..0000000000000000000000000000000000000000 Binary files a/doc/images/fsleyes.png and /dev/null differ diff --git a/doc/images/fsleyes_architecture.png b/doc/images/fsleyes_architecture.png deleted file mode 100644 index c1743823a509cf7acccd3544c9733fb724a61a92..0000000000000000000000000000000000000000 Binary files a/doc/images/fsleyes_architecture.png and /dev/null differ diff --git a/doc/images/fsleyes_architecture.xcf b/doc/images/fsleyes_architecture.xcf deleted file mode 100644 index 4c98e7f4def434c5e7b25e5610eed397c9cdd22e..0000000000000000000000000000000000000000 Binary files a/doc/images/fsleyes_architecture.xcf and /dev/null differ diff --git a/doc/images/fsleyestoolbar.png b/doc/images/fsleyestoolbar.png deleted file mode 100644 index bace19c6eddf20bd58b93b8ef4dbd407193ba493..0000000000000000000000000000000000000000 Binary files a/doc/images/fsleyestoolbar.png and /dev/null differ diff --git a/doc/images/histogramcontrolpanel.png b/doc/images/histogramcontrolpanel.png deleted file mode 100644 index f6ab2e0341e69cc8f004585edeac023e09f26fcf..0000000000000000000000000000000000000000 Binary files a/doc/images/histogramcontrolpanel.png and /dev/null differ diff --git a/doc/images/histogramlistpanel.png b/doc/images/histogramlistpanel.png deleted file mode 100644 index 365f343b7a1ed20dda066ff4bdd23a5995b98c5c..0000000000000000000000000000000000000000 Binary files a/doc/images/histogramlistpanel.png and /dev/null differ diff --git a/doc/images/histogrampanel.png b/doc/images/histogrampanel.png deleted file mode 100644 index 7277a8809dcaa10a97246644a6a18ba7a1517dc6..0000000000000000000000000000000000000000 Binary files a/doc/images/histogrampanel.png and /dev/null differ diff --git a/doc/images/lightboxpanel.png b/doc/images/lightboxpanel.png deleted file mode 100644 index 2d67b669f304aa7b08fb5da9c3ec5dd7ce7be8fe..0000000000000000000000000000000000000000 Binary files a/doc/images/lightboxpanel.png and /dev/null differ diff --git a/doc/images/lightboxtoolbar.png b/doc/images/lightboxtoolbar.png deleted file mode 100644 index 13241307998c01d8a195cb99b9eeee145b91fff8..0000000000000000000000000000000000000000 Binary files a/doc/images/lightboxtoolbar.png and /dev/null differ diff --git a/doc/images/locationpanel.png b/doc/images/locationpanel.png deleted file mode 100644 index a55a2be384f9df50ac8c020e1e1114621210d029..0000000000000000000000000000000000000000 Binary files a/doc/images/locationpanel.png and /dev/null differ diff --git a/doc/images/lookuptablepanel.png b/doc/images/lookuptablepanel.png deleted file mode 100644 index 524b9cf090674c2a71296c741468e5dd43f76165..0000000000000000000000000000000000000000 Binary files a/doc/images/lookuptablepanel.png and /dev/null differ diff --git a/doc/images/orthoedittoolbar.png b/doc/images/orthoedittoolbar.png deleted file mode 100644 index 86d54ece8fa45fcb5ed4274de2460966fa4b78b8..0000000000000000000000000000000000000000 Binary files a/doc/images/orthoedittoolbar.png and /dev/null differ diff --git a/doc/images/orthopanel.png b/doc/images/orthopanel.png deleted file mode 100644 index c01e24a8b81929b51a0af7ddb4f4983626011546..0000000000000000000000000000000000000000 Binary files a/doc/images/orthopanel.png and /dev/null differ diff --git a/doc/images/orthotoolbar.png b/doc/images/orthotoolbar.png deleted file mode 100644 index 3854d22a759ea73347637c01e5c3d1f9ae297f72..0000000000000000000000000000000000000000 Binary files a/doc/images/orthotoolbar.png and /dev/null differ diff --git a/doc/images/overlaydisplaypanel.png b/doc/images/overlaydisplaypanel.png deleted file mode 100644 index a6d703147a9a4ef715f19124a11ba4abb82c2a77..0000000000000000000000000000000000000000 Binary files a/doc/images/overlaydisplaypanel.png and /dev/null differ diff --git a/doc/images/overlaydisplaytoolbar.png b/doc/images/overlaydisplaytoolbar.png deleted file mode 100644 index 5c40d9003b76537eb1a009e5e9c24c9a0623ce79..0000000000000000000000000000000000000000 Binary files a/doc/images/overlaydisplaytoolbar.png and /dev/null differ diff --git a/doc/images/overlayinfopanel.png b/doc/images/overlayinfopanel.png deleted file mode 100644 index 8f8ce30d6951de94bd3750e3612b0fff52bd01c9..0000000000000000000000000000000000000000 Binary files a/doc/images/overlayinfopanel.png and /dev/null differ diff --git a/doc/images/overlaylistpanel.png b/doc/images/overlaylistpanel.png deleted file mode 100644 index 74bf7d1dba485353fea4ba6873646b94c89d92db..0000000000000000000000000000000000000000 Binary files a/doc/images/overlaylistpanel.png and /dev/null differ diff --git a/doc/images/timeseriescontrolpanel.png b/doc/images/timeseriescontrolpanel.png deleted file mode 100644 index 6876f4d8104e9be6f6ab1cb2edef2430e018838b..0000000000000000000000000000000000000000 Binary files a/doc/images/timeseriescontrolpanel.png and /dev/null differ diff --git a/doc/images/timeserieslistpanel.png b/doc/images/timeserieslistpanel.png deleted file mode 100644 index d60dedbb7873f796248eccb4a9e10753cc00b280..0000000000000000000000000000000000000000 Binary files a/doc/images/timeserieslistpanel.png and /dev/null differ diff --git a/doc/images/timeseriespanel.png b/doc/images/timeseriespanel.png deleted file mode 100644 index 6c0046c9290e7242dd90a45d34e392c6500ee3d6..0000000000000000000000000000000000000000 Binary files a/doc/images/timeseriespanel.png and /dev/null differ diff --git a/doc/images/x11_slicecanvas_show_bug.png b/doc/images/x11_slicecanvas_show_bug.png deleted file mode 100644 index 6dbc92468d1b47814e384ffbee4cc1a3352018c6..0000000000000000000000000000000000000000 Binary files a/doc/images/x11_slicecanvas_show_bug.png and /dev/null differ diff --git a/doc/index.rst b/doc/index.rst index b95355d9069bffb111605a54d667c50fdf2cf8fe..96904a8482a4428d07325bd0dd357df088251c61 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,13 +4,11 @@ .. toctree:: :hidden: - :maxdepth: 1 + :maxdepth: 2 fsl - fsl.tools fsl.data fsl.utils - fsl.fsleyes This is the ``fslpy`` API documentation. diff --git a/fsl/utils/__init__.py b/fsl/utils/__init__.py index 299bbaf0fd309b0a167ee4507e0136d4582a1c40..1091be9be125a6cf162d5c49d7d1f9c876269b2c 100644 --- a/fsl/utils/__init__.py +++ b/fsl/utils/__init__.py @@ -21,6 +21,7 @@ things. ~fsl.utils.webpage ~fsl.utils.status ~fsl.utils.memoize + ~fsl.utils.path ~fsl.utils.async ~fsl.utils.notifier """ diff --git a/fsl/utils/async.py b/fsl/utils/async.py index 672102102525664b0380c85a4fce09bc6a99bbe3..d42fd63201bb799006d9e33233d029810affc2c1 100644 --- a/fsl/utils/async.py +++ b/fsl/utils/async.py @@ -70,7 +70,7 @@ def run(task, onFinish=None, name=None): .. note:: If a ``wx`` application is not running, the ``task`` and ``onFinish`` functions will simply be called directly, and - the return value will be ``None``. + the return value will be ``None``. """ if name is None: diff --git a/fsl/version.py b/fsl/version.py index 78d9ac1425f75fb6169845181152303c96cf8708..28312e0a30c88271322027dc7e3ed4cf70009756 100644 --- a/fsl/version.py +++ b/fsl/version.py @@ -15,9 +15,9 @@ version number and information. .. todo:: Define a formal ``fslpy`` version number updating scheme. """ -__version__ = '0.9a' +__version__ = '<dev>' """Current version number, as a string. """ -__vcs_version__ = '0.9a' +__vcs_version__ = '<dev>' """VCS (Version Control System) version number, for internal use. """