Merge pull request #15 from sandialabs/12-adding-readme-badges-and-coveralls

12 adding readme badges and coveralls

Author: eebaill

.github/workflows/documentation.yml

@@ -1,4 +1,4 @@
-name: documentation
+name: Deploy to GitHub Pages
 
 on: [push, pull_request, workflow_dispatch]
 
@@ -13,16 +13,30 @@ jobs:
       - uses: actions/setup-python@v5
         with:
             python-version: '3.9'
+
       - name: Install dependencies
         run: |
           pip install sphinx sphinx_rtd_theme myst_parser sphinx-autoapi ipython
           pip install .[dev]
+
       - name: List files
         run: |
           ls -R
+
       - name: Sphinx build
         run: |
           sphinx-build -b html docs docs/_build/html
+
+      - name: Generating coverage report for coveralls
+        run: |
+          coverage run --source=pytuq -m pytest tests/
+          coverage report -m
+
+      - name: Coveralls GitHub Action
+        uses: coverallsapp/[email protected]
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }} 
+          
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

.github/workflows/python-test.yml

@@ -28,4 +28,4 @@ jobs:
 
     - name: Run tests
       run: |
-        python3 examples/surrogates/ex_pce.py
+        pytest tests/

README.md

@@ -2,6 +2,13 @@
 
 #### Khachik Sargsyan, Bert Debusschere, Emilie Grace Baillo
 
+
+[![Deploy to GitHub Pages](https://github.com/sandialabs/pytuq/actions/workflows/documentation.yml/badge.svg)](https://github.com/sandialabs/pytuq/actions/workflows/documentation.yml)
+[![Run Tests](https://github.com/sandialabs/pytuq/actions/workflows/python-test.yml/badge.svg)](https://github.com/sandialabs/pytuq/actions/workflows/python-test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/sandialabs/pytuq/badge.svg?branch=main)](https://coveralls.io/github/sandialabs/pytuq?branch=main)
+
+
+
 ## Overview
 
 The Python Toolkit for Uncertainty Quantification (PyTUQ) is a Python-only collection of libraries and tools designed for quantifying uncertainty in computational models. PyTUQ offers a range of UQ functionalities, including Bayesian inference and linear regression methods, polynomial chaos expansions, and global sensitivity analysis methods. PyTUQ features advanced techniques for dimensionality reduction, such as SVD and Karhunen-Loeve expansions, along with various MCMC methods for calibration and inference. The toolkit also includes robust classes for multivariate random variables and integration techniques, making it a versatile resource for researchers and practitioners seeking to quantify uncertainty in their numerical predictions. To explore the PyTUQ documentation and learn more, visit our website [here](https://sandialabs.github.io/pytuq/).

docs/conf.py

@@ -23,13 +23,14 @@
 
 source_suffix = ".rst"
 master_doc = "index"
+
+from pkg_resources import get_distribution, DistributionNotFound
+
 try:
-    from pkg_resources import get_distribution
-    version = release = get_distribution("pytuq").version
-except Exception:
-    import traceback
-    traceback.print_exc()
+    version = get_distribution("package-name").version
+except DistributionNotFound:
     version = release = "1.0.0"
+    pass
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/index.rst

@@ -7,14 +7,38 @@
 PyTUQ Documentation
 ============================================
 
-.. _PyTUQ: https://github.com/sandialabs/pytuq
 
-**Last Updated**: |today| **Version**: |version|
+.. start-badges
 
-Hello, :ref:`PyTUQ <PyTUQ>` is a Python-only toolkit for uncertainty quantification in computational models.
+.. list-table::
+    :stub-columns: 1
+
+    * - tests
+      - |python-tests| |deployment| |coveralls|
+
+.. |python-tests| image:: https://github.com/sandialabs/pytuq/actions/workflows/python-test.yml/badge.svg
+    :alt: Python Tests Build Status
+    :target: https://github.com/sandialabs/pytuq/actions/workflows/python-test.yml
+
+.. |deployment| image:: https://github.com/sandialabs/pytuq/actions/workflows/documentation.yml/badge.svg
+    :alt: Deployment Status
+    :target: https://github.com/sandialabs/pytuq/actions/workflows/documentation.yml
+
+.. |coveralls| image:: https://coveralls.io/repos/github/sandialabs/pytuq/badge.svg?branch=main
+    :target: https://coveralls.io/github/sandialabs/pytuq?branch=main
+    :alt: Coverage Status
+
+.. end-badges
+
+
+**Last Updated**: |today| 
+
+**Version**: |version|
+
+Hello, `PyTUQ <https://github.com/sandialabs/pytuq>`__ is a Python-only toolkit for uncertainty quantification in computational models.
 To explore the modules offered by PyTUQ, use the navigation panel on the left or below.
 
-Check out the :doc:`Getting Started <about>` section for further information, including how to
+Check out the :ref:`Getting Started <about>` section for further information, including how to
 :ref:`install <installation>` the project.
 
 .. toctree::

pyproject.toml

@@ -37,6 +37,12 @@ dependencies = [
   "matplotlib",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov"
+]
+
 [tool.setuptools.packages.find]
 where = ["src"] 
 namespaces = false