Skip to content

Commit

Permalink
DOC: add TR-033 with basic amplitude analysis tutorial (#217)
Browse files Browse the repository at this point in the history
  • Loading branch information
shenvitor authored Jul 16, 2024
1 parent 965b794 commit 090f458
Show file tree
Hide file tree
Showing 6 changed files with 3,713 additions and 9 deletions.
9 changes: 9 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
"blatt",
"breit",
"chromodynamics",
"Clebsch",
"compwa",
"conda",
"Curvenote",
Expand All @@ -70,9 +71,12 @@
"defaultdict",
"dummifies",
"dummify",
"eigenstates",
"eval",
"flatté",
"functools",
"GlueX",
"Gordan",
"Hankel",
"helicities",
"helicity",
Expand Down Expand Up @@ -203,6 +207,7 @@
"epsabs",
"epsrel",
"eqnarray",
"errordef",
"evaluatable",
"expertsystem",
"facecolor",
Expand Down Expand Up @@ -231,7 +236,9 @@
"hoverinfo",
"hspace",
"hypotests",
"iframe",
"imag",
"iminuit",
"infty",
"ioff",
"iplt",
Expand Down Expand Up @@ -278,6 +285,7 @@
"maxdepth",
"maxsize",
"meshgrid",
"migrad",
"mmikhasenko",
"mname",
"mplot3d",
Expand All @@ -291,6 +299,7 @@
"nbconvert",
"nbformat",
"nbmake",
"nbody",
"nbsp",
"ncols",
"ndarray",
Expand Down
7 changes: 5 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ def get_nb_exclusion_patterns() -> list[str]:
"report/020*",
"report/021*",
"report/022*",
"report/033*",
}
julia_notebooks = {
"report/019*",
Expand Down Expand Up @@ -218,12 +219,12 @@ def install_ijulia() -> None:
"https://atom.io", # often instable
"https://doi.org/10.1002/andp.19955070504", # 403 for onlinelibrary.wiley.com
"https://doi.org/10.1155/2020/6674595", # 403 hindawi.com
"https://doi.org/10.7566/JPSCP.26.022002", # 403 for journals.jps.jp
"https://downloads.hindawi.com", # 403
"https://github.com/organizations/ComPWA/settings/repository-defaults", # private
"https://github.com/orgs/ComPWA/projects/5", # private
"https://github.com/orgs/ComPWA/projects/6", # private
"https://ieeexplore.ieee.org/document/6312940", # 401
"https://indico.ific.uv.es/event/6803", # SSL error
"https://journals.aps.org",
"https://leetcode.com",
"https://mybinder.org", # often instable
"https://open.vscode.dev",
Expand All @@ -232,6 +233,8 @@ def install_ijulia() -> None:
"https://via.placeholder.com", # irregular timeout
"https://www.andiamo.co.uk/resources/iso-language-codes", # 443, but works
"https://www.bookfinder.com",
r"https://github.com/ComPWA/RUB-EP1-AG/.*", # private
r"https://github.com/orgs/ComPWA/projects/\d+", # private
]
myst_enable_extensions = [
"amsmath",
Expand Down
7 changes: 1 addition & 6 deletions docs/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -636,12 +636,7 @@ EXECUTE_NB= tox -e doclive
```

:::{tip}
Notebooks are automatically formatted through {ref}`pre-commit <develop:Pre-commit>`
(see {ref}`develop:Formatting`). If you want to format the notebooks automatically as
you're working, you can do so with
[`jupyterlab-code-formatter`](https://ryantam626.github.io/jupyterlab_code_formatter/index.html),
which is automatically
{ref}`installed with the dev requirements <develop:Optional dependencies>`.
Notebooks are automatically formatted through {ref}`pre-commit <develop:Pre-commit>` (see {ref}`develop:Formatting`). If you want to format the notebooks automatically as you're working, you can do so with [`jupyterlab-code-formatter`](https://jupyterlab-code-formatter.readthedocs.io), which is automatically {ref}`installed with the dev requirements <develop:Optional dependencies>`.
:::

#### IJulia notebooks
Expand Down
Loading

0 comments on commit 090f458

Please sign in to comment.