Merge pull request #178 from DiamondLightSource/ccpireg

Adding ccpi regularisers

Author: dkazanc

.github/workflows/httomolibgpu_doc_conda.yml

@@ -24,7 +24,7 @@ jobs:
           with:
             python-version: "3.10"
 
-        - name: httomolib
+        - name: httomolibgpu
           uses: conda-incubator/setup-miniconda@v2
           with:
             auto-update-conda: false
@@ -40,5 +40,5 @@ jobs:
         - name: Run ghp-import
           run: ghp-import -n -p -f ./docs/build
           env:
-            GITHUB_TOKEN: ${{ github.token }}            
-          
+            GITHUB_TOKEN: ${{ github.token }}
+

README.rst

@@ -9,10 +9,10 @@ Some of the methods also have been optimised to ensure higher computational effi
 The purpose of HTTomolibGPU
 ===========================
 
-**HTTomolibGPU** can be used as a stand-alone library, see Examples section in `Documentation <https://diamondlightsource.github.io/httomolibgpu/>`_.
+**HTTomolibGPU** can be used as a stand-alone library, see :ref:`examples`.
 However, it has been specifically developed to work together with the `HTTomo <https://diamondlightsource.github.io/httomo/>`_ package as
 its backend for data processing. HTTomo is a user interface (UI) written in Python for fast big tomographic data processing using
-MPI protocols.
+MPI protocols or as well serially.
 
 Install HTTomolibGPU as a PyPi package
 =========================================================

conda/environment.yml

@@ -19,5 +19,6 @@ dependencies:
   - ipython
   - h5py
   - astra-toolbox
-  - httomo::tomobar
+  - tomobar
+  - ccpi-regulariser
   - scikit-image

docs/source/_static/figures/FBP.png

@@ -0,0 +1,6 @@
+:mod:`httomolibgpu.misc.denoise`
+============================================
+.. automodule:: httomolibgpu.misc.denoise
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/source/_static/figures/ROF.png

@@ -8,6 +8,7 @@ Submodules
    :maxdepth: 4
 
    httomolibgpu.misc.corr
+   httomolibgpu.misc.denoise
    httomolibgpu.misc.morph
    httomolibgpu.misc.rescale