From 5f384b8d0b9adbddd55e93aa86487cc2399ab333 Mon Sep 17 00:00:00 2001 From: Johannes Buchner Date: Sun, 28 Apr 2024 15:35:14 +0200 Subject: [PATCH] integrate new tutorials --- .github/workflows/test.yml | 7 +++++++ doc/conf.py | 2 +- doc/index.rst | 2 ++ doc/xspec-analysis.rst | 7 +++++-- 4 files changed, 15 insertions(+), 3 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index c665e28..ba52fbe 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -314,6 +314,13 @@ jobs: python -m pip install . wc -l examples/sherpa/.cover* examples/xspec/.cover* docker/testsrc/.cover* .cover* || true + - name: David Homan's workflow + run: | + python -m pip install natsort; + pushd examples/xspec/bayesian-workflow/tutorials/; + bash run_all.sh; + popd; + - name: Coverage report run: | coverage combine examples/sherpa examples/xspec docker/testsrc . diff --git a/doc/conf.py b/doc/conf.py index bf697e8..feb50ef 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -38,7 +38,7 @@ 'sphinx.ext.viewcode', 'sphinx.ext.mathjax', 'sphinx.ext.autosectionlabel', - #'nbsphinx', + 'nbsphinx', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.napoleon', diff --git a/doc/index.rst b/doc/index.rst index 32eab2f..12c717e 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -57,6 +57,8 @@ The usage is similar in Sherpa and Xspec conceptionally: examples xagnfitter + ../examples/xspec/bayesian-workflow/tutorials/tutorial_usage_plotbxa.ipynb + ../examples/xspec/bayesian-workflow/tutorials/tutorial_usage_plotxspec.ipynb Indices and tables ================== diff --git a/doc/xspec-analysis.rst b/doc/xspec-analysis.rst index 43d795b..cdd4488 100644 --- a/doc/xspec-analysis.rst +++ b/doc/xspec-analysis.rst @@ -204,5 +204,8 @@ For Xspec, the *qq* function in the *qq* module allows you to create such plots .. autofunction:: bxa.xspec.qq.qq -Refer to the :ref:`accompaning paper `, which gives an introduction and -detailed discussion on the methodology. +For an introduction and detailed discussion on the methodology, see: + +* the :ref:`accompaning paper ` +* the `book chapter "Statistical Aspects of X-ray Spectral Analysis" `_ +* the PlotBXA tutorial linked on the left of this page