updating docs, bumping version

FRBs · Jan 6, 2022 · 6bdbbb9 · 6bdbbb9
1 parent c3db09a
commit 6bdbbb9
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 159 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -5,29 +5,29 @@
 # Required
 version: 2
 
-# Build PDF & ePub
-formats:
-  - pdf
-  - epub
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   builder: html
   configuration: docs/conf.py
+  fail_on_warning: false
 
-conda:
-  environment: docs/environment.yml
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+  - epub
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: "3.8"
   install:
     - method: pip
       path: .
       extra_requirements:
         - docs
     - method: setuptools
       path: .
-
-build:
-  image: latest
diff --git a/README.md b/README.md
@@ -1,28 +1,28 @@
 # sigpyproc
 
-`sigpyproc` is a pulsar and FRB data analysis library for python.
-
 [![GitHub CI](https://github.com/FRBs/sigpyproc3/workflows/GitHub%20CI/badge.svg)](https://github.com/FRBs/sigpyproc3/actions)
 [![Docs](https://readthedocs.org/projects/sigpyproc3/badge/?version=latest)](https://sigpyproc3.readthedocs.io/en/latest/?badge=latest)
 [![codecov](https://codecov.io/gh/FRBs/sigpyproc3/branch/master/graph/badge.svg)](https://codecov.io/gh/FRBs/sigpyproc3)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+`sigpyproc` is a pulsar and FRB data analysis library for python. It provides an OOP approach to pulsar data handling through the use of objects representing different data types (e.g. [SIGPROC filterbank](http://sigproc.sourceforge.net), time-series, fourier-series, etc.).
+
+As pulsar data processing is often time critical, speed is maintained through the use of compiled C++ code that are accessed via the excellent `pybind11 <https://pybind11.readthedocs.io/>`_ library. Additional performance increases are obtained via the use of multi-threading with OpenMP, a threading library standard to most linux and mac systems.
+
+`sigpyproc` was initially intended to be an Python wrapper for the [SIGPROC](http://sigproc.sourceforge.net) pulsar signal processing toolbox, but over time it has developed and become an independent project in its own right. Unlike [SIGPROC](http://sigproc.sourceforge.net) and [PRESTO](https://github.com/scottransom/presto), `sigpyproc` does not currently have full capabilities as a piece of FRB/pulsar searching software. Instead, `sigpyproc` provides data manipulation routines which are well suited to preprocessing and micro-management of pulsar data. The structure of the package also makes it an ideal development environment, with a simple plug-and-play system with new modules and extensions.
 
-## Usage
+## Basic Usage
 
 ```python
-from sigpyproc.Readers import FilReader
+from sigpyproc.readers import FilReader
 myFil = FilReader("tutorial.fil")
 
 ```
 
 ## Installation
 
-You need Python 3.6 or later to run sigpyproc. Additionally,
-[FFTW3](http://www.fftw.org) and [OpenMP](https://www.openmp.org)
-should be installed/enabled on your system.
-
-### Step-by-step guide
-
-Once you have all the requirements installed, you can install this via pip:
+You need Python 3.8 or later to run sigpyproc.
+Install via pip:
 
 ```bash
 pip install git+https://github.com/FRBs/sigpyproc3
@@ -34,20 +34,11 @@ Or, download / clone this repository, and then run
 python -m pip install .
 ```
 
-<!---
-### Docker
+### Test the installation
 
-This repo now comes with a `Dockerfile`, so you can build a simple docker container with `sigpyproc` in it. To do so, clone this directory, cd into it, and then run on your command line:
+You can execute some unit and benchmark tests using [pytest](https://docs.pytest.org) to make sure that the installation went alright. In the root directory of the source code
+execute the following command:
 
+```bash
+python -m pytest -v tests
 ```
-docker build --tag sigpyproc .
-```
-
-You can then run the container with
-
-```
-docker run --rm -it sigpyproc
-```
-
-(Have a read of docker tutorials and documentation for more details!)
---->
diff --git a/docs/api/core.rst b/docs/api/core.rst
@@ -0,0 +1,19 @@
+sigpyproc.core module
+=====================
+
+sigpyproc.core.stats
+--------------------
+
+.. automodule:: sigpyproc.core.stats
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+sigpyproc.core.kernels
+----------------------
+
+.. automodule:: sigpyproc.core.kernels
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/libcpp.rst b/docs/api/libcpp.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -9,7 +9,6 @@
 # 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
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 
 import sigpyproc
 
@@ -38,6 +37,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
+    "myst_parser",
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx.ext.intersphinx",
@@ -61,7 +61,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-html_theme = 'sphinx_book_theme'
+html_theme = "sphinx_book_theme"
 html_theme_options = {
     "logo_only": False,
     "display_version": True,
@@ -77,7 +77,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ["_static"]
+# \html_static_path = ["_static"]
 
 
 # -- Extension configuration -------------------------------------------------

diff --git a/docs/environment.yml b/docs/environment.yml
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,60 +1,11 @@
-sigpyproc
-=========
-
-**sigpyproc** is a FRB/pulsar data analysis library for Python. It provides an
-OOP approach to pulsar data handling through the use of objects representing
-different data types (e.g.
-`SIGPROC filterbank <http://sigproc.sourceforge.net>`_,
-`PSRFITS <https://www.atnf.csiro.au/research/pulsar/psrfits_definition/Psrfits.html>`_,
-time series, fourier series, etc.).
-
-As pulsar data processing is often time critical, speed is maintained through
-the use of compiled C++ code that are accessed via the excellent
-`pybind11 <https://pybind11.readthedocs.io/>`_ library.
-Additional performance increases are obtained via the use of multi-threading
-with OpenMP, a threading library standard to most linux and mac systems.
-
-.. image:: https://github.com/FRBs/sigpyproc3/workflows/GitHub%20CI/badge.svg
-  :target: https://github.com/FRBs/sigpyproc3/actions
-.. image:: https://readthedocs.org/projects/sigpyproc3/badge/?version=latest
-  :target: https://sigpyproc3.readthedocs.io/en/latest/?badge=latest
-  :alt: Documentation Status
-.. image:: https://codecov.io/gh/FRBs/sigpyproc3/branch/master/graph/badge.svg
-  :target: https://codecov.io/gh/FRBs/sigpyproc3
-
-
-Basic Usage
------------
-
-.. code-block:: python
-
-  from sigpyproc.Readers import FilReader
-  myFil = FilReader("tutorial.fil")
-
-  from sigpyproc.Readers import FitsReader
-  myFits = FitsReader("tutorial.fits")
-
-
-Why sigpyproc?
---------------
-**sigpyproc** was initially intended to be an Python wrapper for the
-`SIGPROC <http://sigproc.sourceforge.net>`_ pulsar signal processing toolbox,
-but over time it has developed and become an independent project in its own right.
-Unlike `SIGPROC <http://sigproc.sourceforge.net>`_ and
-`PRESTO <https://github.com/scottransom/presto>`_, **sigpyproc** does not currently
-have full capabilities as a piece of FRB/pulsar searching software.
-Instead, **sigpyproc** provides data manipulation routines which are well suited to
-preprocessing and micro-management of pulsar data. The structure of the package also
-makes it an ideal development environment, with a simple plug-and-play system with
-new modules and extensions.
-
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
 
 
 .. toctree::
   :maxdepth: 2
   :caption: Documentation
 
-  install
   modules
   dev
 

diff --git a/docs/install.rst b/docs/install.rst
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -14,4 +14,4 @@ API Reference
    api/base
    api/utils
    api/params
-   api/libcpp
+   api/core
diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = sigpyproc
-version = 0.6.0
+version = 1.0.0
 author = Ewan Barr
 author_email = [email protected]
 maintainer = Pravir Kumar
@@ -22,7 +22,7 @@ classifiers =
 zip_safe = false
 include_package_data = false
 packages = find:
-python_requires = >=3.6
+python_requires = >=3.7
 install_requires =
     numpy>=1.20
     astropy>=4.0
@@ -46,7 +46,9 @@ tests =
     pytest-sugar
     pytest-benchmark
 docs =
-    sphinx>=3.2.1
+    docutils>=0.17
+    myst-parser
+    sphinx
     sphinx-book-theme
     pandoc
     ipython