Commit edd81a72 authored by Martin Reinecke's avatar Martin Reinecke

Merge branch 'cosm' into 'NIFTy_5'

Various stuff by Philipp A

See merge request ift/nifty-dev!206
parents 94e8fc43 aef6ea9b
...@@ -51,18 +51,14 @@ test_mpi: ...@@ -51,18 +51,14 @@ test_mpi:
- mpiexec -n 2 --bind-to none pytest-3 -q test - mpiexec -n 2 --bind-to none pytest-3 -q test
pages: pages:
stage: release # FIXME Build only for main branch and set stage to release
before_script: stage: test
- ls
script: script:
- python3 setup.py install --user -f
- sh docs/generate.sh - sh docs/generate.sh
- mv docs/build/ public/ - mv docs/build/ public/
artifacts: artifacts:
paths: paths:
- public - public
only:
- NIFTy_4
before_script: before_script:
- python3 setup.py install --user -f - python3 setup.py install --user -f
......
...@@ -6,7 +6,7 @@ RUN apt-get update && apt-get install -y \ ...@@ -6,7 +6,7 @@ RUN apt-get update && apt-get install -y \
# Packages needed for NIFTy # Packages needed for NIFTy
python3-scipy \ python3-scipy \
# Documentation build dependencies # Documentation build dependencies
python3-sphinx-rtd-theme \ python3-sphinx-rtd-theme dvipng texlive-latex-base texlive-latex-extra \
# Testing dependencies # Testing dependencies
python3-pytest-cov jupyter \ python3-pytest-cov jupyter \
# Optional NIFTy dependencies # Optional NIFTy dependencies
......
...@@ -36,8 +36,8 @@ class Field(object): ...@@ -36,8 +36,8 @@ class Field(object):
This object's global shape must match the domain shape This object's global shape must match the domain shape
After construction, the object will no longer be writeable! After construction, the object will no longer be writeable!
Note Notes
---- -----
If possible, do not invoke the constructor directly, but use one of the If possible, do not invoke the constructor directly, but use one of the
many convenience functions for instantiation! many convenience functions for instantiation!
""" """
...@@ -190,8 +190,8 @@ class Field(object): ...@@ -190,8 +190,8 @@ class Field(object):
def val(self): def val(self):
"""dobj.data_object : the data object storing the field's entries. """dobj.data_object : the data object storing the field's entries.
Note Notes
---- -----
This property is intended for low-level, internal use only. Do not use This property is intended for low-level, internal use only. Do not use
from outside of NIFTy's core; there should be better alternatives. from outside of NIFTy's core; there should be better alternatives.
""" """
......
...@@ -50,6 +50,13 @@ def CorrelatedField(target, amplitude_operator, name='xi', codomain=None): ...@@ -50,6 +50,13 @@ def CorrelatedField(target, amplitude_operator, name='xi', codomain=None):
------- -------
Operator Operator
Correlated field Correlated field
Notes
-----
In NIFTy, non-harmonic RGSpaces are by definition periodic. Therefore
the operator constructed by this method will output a correlated field
with *periodic* boundary conditions. If a non-periodic field is needed,
one needs to combine this operator with a :class:`FieldZeroPadder`.
""" """
tgt = DomainTuple.make(target) tgt = DomainTuple.make(target)
if len(tgt) > 1: if len(tgt) > 1:
...@@ -90,6 +97,14 @@ def MfCorrelatedField(target, amplitudes, name='xi'): ...@@ -90,6 +97,14 @@ def MfCorrelatedField(target, amplitudes, name='xi'):
------- -------
Operator Operator
Correlated field Correlated field
Notes
-----
In NIFTy, non-harmonic RGSpaces are by definition periodic. Therefore
the operator constructed by this method will output a correlated field
with *periodic* boundary conditions. If a non-periodic field is needed,
one needs to combine this operator with a :class:`FieldZeroPadder` or even
two (one for the energy and one for the spatial subdomain)
""" """
tgt = DomainTuple.make(target) tgt = DomainTuple.make(target)
if len(tgt) != 2: if len(tgt) != 2:
......
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