Skip to content

Commit

Permalink
integrate new tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
JohannesBuchner committed Apr 28, 2024
1 parent 2e7cebb commit 5f384b8
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 3 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 .
Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
'sphinx.ext.viewcode',
'sphinx.ext.mathjax',
'sphinx.ext.autosectionlabel',
#'nbsphinx',
'nbsphinx',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
Expand Down
2 changes: 2 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================
Expand Down
7 changes: 5 additions & 2 deletions doc/xspec-analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cite>`, which gives an introduction and
detailed discussion on the methodology.
For an introduction and detailed discussion on the methodology, see:

* the :ref:`accompaning paper <cite>`
* the `book chapter "Statistical Aspects of X-ray Spectral Analysis" <https://arxiv.org/abs/2309.05705>`_
* the PlotBXA tutorial linked on the left of this page

0 comments on commit 5f384b8

Please sign in to comment.