Commit 24e57980 authored by Martin Reinecke's avatar Martin Reinecke

cosmetics

parent 6a59fbc8
Pipeline #23800 passed with stage
in 5 minutes and 14 seconds
...@@ -7,12 +7,12 @@ As a consequence, it does not install as package "nifty", but rather as ...@@ -7,12 +7,12 @@ As a consequence, it does not install as package "nifty", but rather as
avoid any conflicts. avoid any conflicts.
NIFTY - Numerical Information Field Theory NIFTy - Numerical Information Field Theory
========================================== ==========================================
[![build status](https://gitlab.mpcdf.mpg.de/ift/NIFTy/badges/nifty2go/build.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/nifty2go) [![build status](https://gitlab.mpcdf.mpg.de/ift/NIFTy/badges/nifty2go/build.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/nifty2go)
[![coverage report](https://gitlab.mpcdf.mpg.de/ift/NIFTy/badges/nifty2go/coverage.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/nifty2go) [![coverage report](https://gitlab.mpcdf.mpg.de/ift/NIFTy/badges/nifty2go/coverage.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/nifty2go)
**NIFTY** project homepage: **NIFTy** project homepage:
[http://www.mpa-garching.mpg.de/ift/nifty/](http://www.mpa-garching.mpg.de/ift/nifty/) [http://www.mpa-garching.mpg.de/ift/nifty/](http://www.mpa-garching.mpg.de/ift/nifty/)
Summary Summary
...@@ -20,29 +20,29 @@ Summary ...@@ -20,29 +20,29 @@ Summary
### Description ### Description
**NIFTY**, "**N**umerical **I**nformation **F**ield **T**heor<strong>y</strong>", is **NIFTy**, "**N**umerical **I**nformation **F**ield **T**heor<strong>y</strong>", is
a versatile library designed to enable the development of signal a versatile library designed to enable the development of signal
inference algorithms that operate regardless of the underlying spatial inference algorithms that operate regardless of the underlying spatial
grid and its resolution. Its object-oriented framework is written in grid and its resolution. Its object-oriented framework is written in
Python, although it accesses libraries written in C++ and C for Python, although it accesses libraries written in C++ and C for
efficiency. efficiency.
NIFTY offers a toolkit that abstracts discretized representations of NIFTy offers a toolkit that abstracts discretized representations of
continuous spaces, fields in these spaces, and operators acting on continuous spaces, fields in these spaces, and operators acting on
fields into classes. Thereby, the correct normalization of operations on fields into classes. Thereby, the correct normalization of operations on
fields is taken care of automatically without concerning the user. This fields is taken care of automatically without concerning the user. This
allows for an abstract formulation and programming of inference allows for an abstract formulation and programming of inference
algorithms, including those derived within information field theory. algorithms, including those derived within information field theory.
Thus, NIFTY permits its user to rapidly prototype algorithms in 1D, and Thus, NIFTy permits its user to rapidly prototype algorithms in 1D, and
then apply the developed code in higher-dimensional settings of real then apply the developed code in higher-dimensional settings of real
world problems. The set of spaces on which NIFTY operates comprises world problems. The set of spaces on which NIFTy operates comprises
point sets, *n*-dimensional regular grids, spherical spaces, their point sets, *n*-dimensional regular grids, spherical spaces, their
harmonic counterparts, and product spaces constructed as combinations of harmonic counterparts, and product spaces constructed as combinations of
those. those.
### Class & Feature Overview ### Class & Feature Overview
The NIFTY library features three main classes: **spaces** that represent The NIFTy library features three main classes: **spaces** that represent
certain grids, **fields** that are defined on spaces, and **operators** certain grids, **fields** that are defined on spaces, and **operators**
that apply to fields. that apply to fields.
...@@ -108,34 +108,34 @@ command in the repository root: ...@@ -108,34 +108,34 @@ command in the repository root:
For a quick start, you can browse through the [informal For a quick start, you can browse through the [informal
introduction](http://www.mpa-garching.mpg.de/ift/nifty/start.html) or introduction](http://www.mpa-garching.mpg.de/ift/nifty/start.html) or
dive into NIFTY by running one of the demonstrations, e.g.: dive into NIFTy by running one of the demonstrations, e.g.:
python demos/wiener_filter_via_curvature.py python demos/wiener_filter_via_curvature.py
Acknowledgement Acknowledgement
--------------- ---------------
Please acknowledge the use of NIFTY in your publication(s) by using a Please acknowledge the use of NIFTy in your publication(s) by using a
phrase such as the following: phrase such as the following:
> *"Some of the results in this publication have been derived using the > *"Some of the results in this publication have been derived using the
> NIFTY package [Selig et al., 2013]."* > NIFTy package [Selig et al., 2013]."*
### References ### References
Release Notes Release Notes
------------- -------------
The NIFTY package is licensed under the The NIFTy package is licensed under the
[GPLv3](http://www.gnu.org/licenses/gpl.html) and is distributed [GPLv3](http://www.gnu.org/licenses/gpl.html) and is distributed
*without any warranty*. *without any warranty*.
* * * * * * * * * *
**NIFTY** project homepage: **NIFTy** project homepage:
[](http://www.mpa-garching.mpg.de/ift/nifty/) [](http://www.mpa-garching.mpg.de/ift/nifty/)
[1] Selig et al., "NIFTY - Numerical Information Field Theory - a [1] Selig et al., "NIFTy - Numerical Information Field Theory - a
versatile Python library for signal inference", [A&A, vol. 554, id. versatile Python library for signal inference", [A&A, vol. 554, id.
A26](http://dx.doi.org/10.1051/0004-6361/201321236), 2013; A26](http://dx.doi.org/10.1051/0004-6361/201321236), 2013;
[arXiv:1301.4499](http://www.arxiv.org/abs/1301.4499) [arXiv:1301.4499](http://www.arxiv.org/abs/1301.4499)
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# #
# NIFTY documentation build configuration file, created by # NIFTy documentation build configuration file, created by
# sphinx-quickstart on Tue May 16 10:22:50 2017. # sphinx-quickstart on Tue May 16 10:22:50 2017.
# #
# This file is execfile()d with the current directory set to its # This file is execfile()d with the current directory set to its
...@@ -79,7 +79,7 @@ source_suffix = '.rst' ...@@ -79,7 +79,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'NIFTY2go' project = u'NIFTy2go'
copyright = u'2013-2017, Max-Planck-Society' copyright = u'2013-2017, Max-Planck-Society'
author = u'Theo Steininger / Martin Reinecke' author = u'Theo Steininger / Martin Reinecke'
...@@ -240,7 +240,7 @@ html_domain_indices = False ...@@ -240,7 +240,7 @@ html_domain_indices = False
#html_search_scorer = 'scorer.js' #html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'NIFTYdoc' htmlhelp_basename = 'NIFTydoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
...@@ -262,8 +262,8 @@ htmlhelp_basename = 'NIFTYdoc' ...@@ -262,8 +262,8 @@ htmlhelp_basename = 'NIFTYdoc'
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
#latex_documents = [ #latex_documents = [
# (master_doc, 'NIFTY.tex', u'NIFTY Documentation', # (master_doc, 'NIFTy.tex', u'NIFTy Documentation',
# u'NIFTY', 'manual'), # u'NIFTy', 'manual'),
#] #]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
...@@ -292,7 +292,7 @@ htmlhelp_basename = 'NIFTYdoc' ...@@ -292,7 +292,7 @@ htmlhelp_basename = 'NIFTYdoc'
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
#man_pages = [ #man_pages = [
# (master_doc, 'nifty', u'NIFTY Documentation', # (master_doc, 'nifty', u'NIFTy Documentation',
# [author], 1) # [author], 1)
#] #]
...@@ -306,8 +306,8 @@ htmlhelp_basename = 'NIFTYdoc' ...@@ -306,8 +306,8 @@ htmlhelp_basename = 'NIFTYdoc'
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
#texinfo_documents = [ #texinfo_documents = [
# (master_doc, 'NIFTY', u'NIFTY Documentation', # (master_doc, 'NIFTy', u'NIFTy Documentation',
# author, 'NIFTY', 'One line description of project.', # author, 'NIFTy', 'One line description of project.',
# 'Miscellaneous'), # 'Miscellaneous'),
#] #]
......
NIFTY -- Numerical Information Field Theory NIFTy -- Numerical Information Field Theory
=========================================== ===========================================
**NIFTY** [1]_, "\ **N**\umerical **I**\nformation **F**\ield **T**\heor\ **y**\ ", is a versatile library designed to enable the development of signal inference algorithms that operate regardless of the underlying spatial grid and its resolution. Its object-oriented framework is written in Python, although it accesses libraries written in Cython, C++, and C for efficiency. **NIFTy** [1]_, "\ **N**\umerical **I**\nformation **F**\ield **T**\heor\ **y**\ ", is a versatile library designed to enable the development of signal inference algorithms that operate regardless of the underlying spatial grid and its resolution. Its object-oriented framework is written in Python, although it accesses libraries written in Cython, C++, and C for efficiency.
NIFTY offers a toolkit that abstracts discretized representations of continuous spaces, fields in these spaces, and operators acting on fields into classes. Thereby, the correct normalization of operations on fields is taken care of automatically without concerning the user. This allows for an abstract formulation and programming of inference algorithms, including those derived within information field theory. Thus, NIFTY permits its user to rapidly prototype algorithms in 1D and then apply the developed code in higher-dimensional settings of real world problems. The set of spaces on which NIFTY operates comprises point sets, *n*-dimensional regular grids, spherical spaces, their harmonic counterparts, and product spaces constructed as combinations of those. NIFTy offers a toolkit that abstracts discretized representations of continuous spaces, fields in these spaces, and operators acting on fields into classes. Thereby, the correct normalization of operations on fields is taken care of automatically without concerning the user. This allows for an abstract formulation and programming of inference algorithms, including those derived within information field theory. Thus, NIFTy permits its user to rapidly prototype algorithms in 1D and then apply the developed code in higher-dimensional settings of real world problems. The set of spaces on which NIFTy operates comprises point sets, *n*-dimensional regular grids, spherical spaces, their harmonic counterparts, and product spaces constructed as combinations of those.
References References
---------- ----------
.. [1] Selig et al., "NIFTY -- Numerical Information Field Theory -- a versatile Python library for signal inference", `A&A, vol. 554, id. A26 <http://dx.doi.org/10.1051/0004-6361/201321236>`_, 2013; `arXiv:1301.4499 <http://www.arxiv.org/abs/1301.4499>`_ .. [1] Selig et al., "NIFTy -- Numerical Information Field Theory -- a versatile Python library for signal inference", `A&A, vol. 554, id. A26 <http://dx.doi.org/10.1051/0004-6361/201321236>`_, 2013; `arXiv:1301.4499 <http://www.arxiv.org/abs/1301.4499>`_
Documentation Documentation
------------- -------------
Welcome to NIFTY's documentation! Welcome to NIFTy's documentation!
Indices and tables Indices and tables
......
...@@ -30,7 +30,7 @@ __all__ = ["Field", "sqrt", "exp", "log", "conjugate"] ...@@ -30,7 +30,7 @@ __all__ = ["Field", "sqrt", "exp", "log", "conjugate"]
class Field(object): class Field(object):
""" The discrete representation of a continuous field over multiple spaces. """ The discrete representation of a continuous field over multiple spaces.
In NIFTY, Fields are used to store data arrays and carry all the needed In NIFTy, Fields are used to store data arrays and carry all the needed
metainformation (i.e. the domain) for operators to be able to work on them. metainformation (i.e. the domain) for operators to be able to work on them.
Parameters Parameters
......
...@@ -26,9 +26,9 @@ from .. import dobj ...@@ -26,9 +26,9 @@ from .. import dobj
class DiagonalOperator(EndomorphicOperator): class DiagonalOperator(EndomorphicOperator):
""" NIFTY class for diagonal operators. """ NIFTy class for diagonal operators.
The NIFTY DiagonalOperator class is a subclass derived from the The NIFTy DiagonalOperator class is a subclass derived from the
EndomorphicOperator. It multiplies an input field pixel-wise with its EndomorphicOperator. It multiplies an input field pixel-wise with its
diagonal. diagonal.
......
...@@ -20,9 +20,9 @@ from .linear_operator import LinearOperator ...@@ -20,9 +20,9 @@ from .linear_operator import LinearOperator
class EndomorphicOperator(LinearOperator): class EndomorphicOperator(LinearOperator):
""" NIFTY class for endomorphic operators. """ NIFTy class for endomorphic operators.
The NIFTY EndomorphicOperator class is a class derived from the The NIFTy EndomorphicOperator class is a class derived from the
LinearOperator. By definition, domain and target are the same in LinearOperator. By definition, domain and target are the same in
EndomorphicOperator. EndomorphicOperator.
......
...@@ -24,9 +24,9 @@ from .endomorphic_operator import EndomorphicOperator ...@@ -24,9 +24,9 @@ from .endomorphic_operator import EndomorphicOperator
class ScalingOperator(EndomorphicOperator): class ScalingOperator(EndomorphicOperator):
""" NIFTY class for an operator which multiplies a Field with a scalar. """ NIFTy class for an operator which multiplies a Field with a scalar.
The NIFTY ScalingOperator class is a subclass derived from the The NIFTy ScalingOperator class is a subclass derived from the
EndomorphicOperator. It multiplies an input field with a given factor. EndomorphicOperator. It multiplies an input field with a given factor.
Parameters Parameters
......
...@@ -22,7 +22,7 @@ from .space import Space ...@@ -22,7 +22,7 @@ from .space import Space
class GLSpace(Space): class GLSpace(Space):
"""NIFTY subclass for Gauss-Legendre pixelizations [#]_ of the two-sphere. """NIFTy subclass for Gauss-Legendre pixelizations [#]_ of the two-sphere.
Parameters Parameters
---------- ----------
......
...@@ -22,7 +22,7 @@ from .space import Space ...@@ -22,7 +22,7 @@ from .space import Space
class HPSpace(Space): class HPSpace(Space):
"""NIFTY subclass for HEALPix discretizations of the two-sphere [#]_. """NIFTy subclass for HEALPix discretizations of the two-sphere [#]_.
Parameters Parameters
---------- ----------
......
...@@ -24,7 +24,7 @@ from .. import dobj ...@@ -24,7 +24,7 @@ from .. import dobj
class LMSpace(Space): class LMSpace(Space):
"""NIFTY subclass for spherical harmonics components, for representations """NIFTy subclass for spherical harmonics components, for representations
of fields on the two-sphere. of fields on the two-sphere.
Parameters Parameters
......
...@@ -22,7 +22,7 @@ from .. import dobj ...@@ -22,7 +22,7 @@ from .. import dobj
class PowerSpace(Space): class PowerSpace(Space):
"""NIFTY class for spaces of power spectra. """NIFTy class for spaces of power spectra.
Parameters Parameters
---------- ----------
......
...@@ -26,7 +26,7 @@ from .. import dobj ...@@ -26,7 +26,7 @@ from .. import dobj
class RGSpace(Space): class RGSpace(Space):
"""NIFTY subclass for spaces of regular Cartesian grids. """NIFTy subclass for spaces of regular Cartesian grids.
Parameters Parameters
---------- ----------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment