diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index d79520f54de8b5db90bf780d6d0db19fadd12c64..5aa60d45b8c7a8b3e5a29fe9eb14a6442ce14340 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -51,18 +51,14 @@ test_mpi: - mpiexec -n 2 --bind-to none pytest-3 -q test pages: - stage: release - before_script: - - ls + # FIXME Build only for main branch and set stage to release + stage: test script: - - python3 setup.py install --user -f - sh docs/generate.sh - mv docs/build/ public/ artifacts: paths: - public - only: - - NIFTy_4 before_script: - python3 setup.py install --user -f diff --git a/Dockerfile b/Dockerfile index 3c25b1f9c79064d73931ceba754a515bfb94336e..dbeaf3e7468d24158bb63ffaa36908d6feda16e8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -6,7 +6,7 @@ RUN apt-get update && apt-get install -y \ # Packages needed for NIFTy python3-scipy \ # Documentation build dependencies - python3-sphinx-rtd-theme \ + python3-sphinx-rtd-theme dvipng texlive-latex-base texlive-latex-extra \ # Testing dependencies python3-pytest-cov jupyter \ # Optional NIFTy dependencies diff --git a/nifty5/field.py b/nifty5/field.py index 90d7b39186e5b1ac8f1d7b9bef707310534629d9..b0e5ef0077dd2ea20f2003d4ef2559e28645cc66 100644 --- a/nifty5/field.py +++ b/nifty5/field.py @@ -36,8 +36,8 @@ class Field(object): This object's global shape must match the domain shape After construction, the object will no longer be writeable! - Note - ---- + Notes + ----- If possible, do not invoke the constructor directly, but use one of the many convenience functions for instantiation! """ @@ -190,8 +190,8 @@ class Field(object): def val(self): """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 from outside of NIFTy's core; there should be better alternatives. """ diff --git a/nifty5/library/correlated_fields.py b/nifty5/library/correlated_fields.py index ea7d39f0c7e6caf91e9a28237883ade4d9c59345..8d347ea3b5268eb3af7355efe313c925f7a8e23a 100644 --- a/nifty5/library/correlated_fields.py +++ b/nifty5/library/correlated_fields.py @@ -50,6 +50,13 @@ def CorrelatedField(target, amplitude_operator, name='xi', codomain=None): ------- Operator 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) if len(tgt) > 1: @@ -90,6 +97,14 @@ def MfCorrelatedField(target, amplitudes, name='xi'): ------- Operator 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) if len(tgt) != 2: