Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readthedoc #14

Closed
wants to merge 10 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: "2"

build:
os: "ubuntu-22.04"
tools:
python: "3.12"

python:
install:
- requirements: docs/requirements.txt

sphinx:
configuration: docs/conf.py
9 changes: 8 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,14 @@
"_build",
]
extensions = ["myst_nb"]
html_theme = "pydata_sphinx_theme"
html_theme = "sphinx_book_theme"
master_doc = "index"
myst_enable_extensions = [
"amsmath",
"colon_fence",
"dollarmath",
"html_image",
"smartquotes",
]
nitpicky = True
project = "GlueX N-Star"
51 changes: 0 additions & 51 deletions docs/hello.ipynb

This file was deleted.

19 changes: 17 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# MyST-NB Quickstart
# Amplitude Analysis 101 / PWA101 (v2.0)

## CAS-assisted Amplitude Models building for photoproduction reaction

This document is a follow-up of PWA101 (v1.0) (temporarily see [here](https://compwa--217.org.readthedocs.build/report/999.html)),
as an introduction to Amplitude Analysis / Partial Wave Analysis (PWA) by demonstrating its application to a specific reaction channel and amplitude model.

Now the focus is the use of symbolic expressions (computations), with the use of [ComPWA packages](https://compwa.github.io/), or CAS(Computer Algebra System)-assisted model building in general (the python package `SymPy` in this case) to illustrate the general process in PWA.

This tutorial aims to equip readers with deeper understanding of PWA methodologies and full workflow in the context of hadron physics through a practical, hands-on example with symbolic expressions via [ComPWA](https://compwa.github.io/).

Furthermore,
address to the issue ✅ [ComPWA/gluex-nstar#1](https://github.com/ComPWA/gluex-nstar/issues/1), this document is PWA101(v2.0), which shows PWA methodologies and full workflow in the context of hadron physics with symbolic expressions via [ComPWA](https://compwa.github.io/).

# Table of contents:

```{toctree}
hello
reaction
pgamma-state
```
Loading