Added overview documentation.

mikgroup · Jul 15, 2018 · f975cce · f975cce
1 parent 3557aeb
commit f975cce
Show file tree

Hide file tree

Showing 11 changed files with 38 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,28 @@
-sigpy
-=====
+``sigpy`` Overview
+================
 
-`sigpy` is a Python package for signal reconstruction, with GPU support using cupy.
+Introduction
+------------
+
+``sigpy`` is a Python package for signal reconstruction, with GPU support using ``cupy``.
+
+``sigpy`` provides commonly used signal processing functions, including convolution, FFT, NUFFT, wavelet transform, and thresholding functions. All operations, except wavelet transform, can run on GPU. These operations are wrapped either in a linear operator class (``Linop``) or a proximal operator class (``Prox``) for easy usage in iterative algorithms. ``sigpy`` also implements popular iterative algorithms, such as conjugate gradient, (accelerated/proximal) gradient method, and primal dual hybrid gradient.
 
-`sigpy` provides commonly used signal processing functions, including convolution, FFT, NUFFT, wavelet transform, and thresholding functions. These operations are wrapped in a linear operator class (Linop), which allows easy manipulation, such as adjoint, addition, multiplication and composition. `sigpy` also implements popular iterative algorithms, such as conjugate gradient, (proximal) gradient method, primal dual hybrid gradient. All operations, except wavelet transform, can run on GPU.
+``sigpy`` provides a submodule ``sigpy.mri`` that uses the core module to implement common MRI iterative reconstruction methods, including SENSE reconstruction, L1-wavelet reconstruction, and total-variation reconstruction. In addition, it provides convenient simulation and sampling functions, such as poisson-disk sampling function.
+
+``sigpy`` also provides a preliminary submodule ``sigpy.learn`` that implements convolutional sparse coding, and linear regression.
+
+Installation
+------------
+The package is on PyPI, and can be installed via pip
 
-`sigpy` also provides a submodule `sigpy.mri` that implements common MRI iterative reconstruction methods, including SENSE reconstruction, L1-wavelet reconstruction, and total-variation reconstruction.
+	pip install sigpy
+
+Alternatively, the package can also be installed with the following required packages.
 
 Requirements
 ------------
-This package requires python3, numpy, scipy, pywavelets, and numba. 
+This package requires python3, numpy, scipy, pywavelets, and numba.
 
 For optional gpu support, the package requires cupy.
 
@@ -18,4 +31,4 @@ For optional distributed programming support, the package requires mpi4py.
 Documentation
 -------------
 
-Our documentation is hosted on readthedocs: https://sigpy.readthedocs.io
+Our documentation is hosted on Read the Docs: https://sigpy.readthedocs.io
diff --git a/doc/alg.rst b/doc/alg.rst
@@ -1,5 +1,5 @@
-Alg
-===
+Iterative Algorithms
+====================
 
 .. _alg:
 

diff --git a/doc/app.rst b/doc/app.rst
@@ -1,5 +1,5 @@
-App
-===
+Applications
+============
 
 .. _app:
 

diff --git a/doc/core.rst b/doc/core.rst
@@ -3,9 +3,9 @@ Core Module
 
 .. toctree::
    :maxdepth: 2
-
+
+   signal	 
    linop
    prox
-   signal
    alg
    app
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,14 +1,10 @@
-.. sigpy documentation master file, created by
-   sphinx-quickstart on Wed Jul  4 17:07:04 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to sigpy's documentation!
 =================================
 
 .. toctree::
    :maxdepth: 2
 
+   intro
    core
    mri
    learn
diff --git a/doc/intro.rst b/doc/intro.rst
@@ -0,0 +1 @@
+../README.md
diff --git a/doc/linop.rst b/doc/linop.rst
@@ -1,5 +1,5 @@
-Linop
-=====
+Linear Operators
+================
 
 .. _linop:
 

diff --git a/doc/mri_app.rst b/doc/mri_app.rst
@@ -1,5 +1,5 @@
-MRI App
-=======
+MRI Applications
+================
 
 .. _mri_app:
 

diff --git a/doc/mri_linop.rst b/doc/mri_linop.rst
@@ -1,5 +1,5 @@
-MRI Linop
-=========
+MRI Linear Operators
+====================
 
 .. _mri_linop:
 

diff --git a/doc/prox.rst b/doc/prox.rst
@@ -1,5 +1,5 @@
-Prox
-====
+Proximal Operators
+==================
 
 .. _prox:
 

diff --git a/doc/thresh.rst b/doc/thresh.rst
@@ -1,5 +1,5 @@
-Threshold
-=========
+Thresholding Functions
+======================
 
 .. _thresh: