Commit cb4c84d7 authored by Mihai Baltac's avatar Mihai Baltac
Browse files

added code documenatation separated in concepts

parent af558fb1
Pipeline #24776 passed with stages
in 3 minutes and 41 seconds
NIFTy Code
==========
The NIFTy code is divided in the concepts Spaces, Fields, Operators and Minimization
.. toctree::
:maxdepth: 1
:caption: Concepts
:glob:
Spaces <concepts/spaces>
Fields <concepts/field>
Operators <concepts/operators>
Minimization <concepts/minimization>
Fields
======
Description of Fields
.. toctree::
:caption: Types of Fields
Field <../mod/nifty4.field>
Minimization
============
Description of Minimization
.. toctree::
:caption: Minimization Concepts
Conjugate Gradient <../mod/nifty4.minimization.conjugate_gradient>
Descent Minimizer <../mod/nifty4.minimization.descent_minimizer>
Energy <../mod/nifty4.minimization.energy>
Iteration Controller <../mod/nifty4.minimization.iteration_controller>
Line Energy <../mod/nifty4.minimization.line_energy>
Line Search <../mod/nifty4.minimization.line_search>
Line Search Strong Wolfe <../mod/nifty4.minimization.line_search_strong_wolfe>
Minimizer <../mod/nifty4.minimization.minimizer>
Nonlinear Cg <../mod/nifty4.minimization.nonlinear_cg>
Quadratic Energy <../mod/nifty4.minimization.quadratic_energy>
Relaxed Newton <../mod/nifty4.minimization.relaxed_newton>
Scipy Minimizer <../mod/nifty4.minimization.scipy_minimizer>
Steepest Descent <../mod/nifty4.minimization.steepest_descent>
VL BFGS <../mod/nifty4.minimization.vl_bfgs>
Gradient Norm Controller <../mod/nifty4.minimization.gradient_norm_controller>
Operators
=========
Description of Operators
.. toctree::
:caption: Types of Operators
Adjoint <../mod/nifty4.operators.adjoint_operator>
Chain <../mod/nifty4.operators.chain_operator>
Diagonal <../mod/nifty4.operators.diagonal_operator>
DOF Projection <../mod/nifty4.operators.dof_projection_operator>
Direct Smoothing <../mod/nifty4.operators.direct_smoothing_operator>
Endomorphic <../mod/nifty4.operators.endomorphic_operator>
FFT <../mod/nifty4.operators.fft_operator>
FFT Smoothing <../mod/nifty4.operators.fft_smoothing_operator>
Geometry Remover <../mod/nifty4.operators.geometry_remover>
Harmonic Transform <../mod/nifty4.operators.harmonic_transform_operator>
Inverse <../mod/nifty4.operators.inverse_operator>
Inversion Enabler <../mod/nifty4.operators.inversion_enabler>
Laplace <../mod/nifty4.operators.linear_operator>
Linear <../mod/nifty4.operators.power_projection_operator>
Power Projection <../mod/nifty4.operators.power_projection_operator>
Scaling <../mod/nifty4.operators.smoothness_operator>
Smoothness <../mod/nifty4.operators.smoothness_operator>
Sum <../mod/nifty4.operators.sum_operator>
Spaces
======
Description of Spaces
.. toctree::
:caption: Types of Spaces
DOF <../mod/nifty4.spaces.dof_space>
Gauss-Legendre <../mod/nifty4.spaces.gl_space>
HEALPix <../mod/nifty4.spaces.gl_space>
Power <../mod/nifty4.spaces.power_space>
LM <../mod/nifty4.spaces.lm_space>
RG <../mod/nifty4.spaces.rg_space>
Domain <../mod/nifty4.spaces.domain>
Structured Domain <../mod/nifty4.spaces.structured_domain>
Unstrcutured Domain <../mod/nifty4.spaces.unstructured_domain>
...@@ -21,7 +21,7 @@ import sphinx_rtd_theme ...@@ -21,7 +21,7 @@ import sphinx_rtd_theme
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('../../nifty4/'))
napoleon_google_docstring = False napoleon_google_docstring = False
napoleon_numpy_docstring = True napoleon_numpy_docstring = True
......
...@@ -24,10 +24,11 @@ Contents ...@@ -24,10 +24,11 @@ Contents
........ ........
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
ift ift
start start
code
Indices and tables Indices and tables
.................. ..................
......
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