ISISNeutronMuon / ISISNeutronMuon/quickBayes

JOSS doc changes

Open
#92 0 comments 0 reactions 1 assignee Claimed by @AnthonyLim23 View on GitHub
documentation
Dominant language
Python
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

As part of the JOSS review I will need to rewrite some of the docs. The plan is to have the following:

Introduction

- what is bayes? - priors, models, posteriors
- why use bayes? - to get the probability of a model and why this is important
- Discussion on comparison to other methods ([AIC](https://en.wikipedia.org/wiki/Akaike_information_criterion), [BIC](https://en.wikipedia.org/wiki/Bayesian_information_criterion) and [nested sampling](https://en.wikipedia.org/wiki/Nested_sampling_algorithm) and MCMC)

Theory
- executive summary of the main equation and assumptions
- derive the main equation and highlight the assumptions

Examples
- QENS data to identify the number of peaks present
- Identifying the number of decays in muon spectroscopy data
- Background identification (with creating a new workflow)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.