Skip to content

Commit

Permalink
DOC: add preview warning for ampform_dpd.io.serialization
Browse files Browse the repository at this point in the history
  • Loading branch information
redeboer committed May 26, 2024
1 parent 507066a commit 83b6983
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
31 changes: 30 additions & 1 deletion docs/serialization.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@
"# Model serialization"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"This notebooks illustrates the use of the {mod}`ampform_dpd.io.serialization` module, which can be used to build amplitude models from the [amplitude-serialization](https://rub-ep1.github.io/amplitude-serialization) initiative.\n",
"\n",
":::{warning}\n",
"The {mode}`ampform_dpd.io.serialization` module is a preview feature.\n",
":::"
]
},
{
"cell_type": "markdown",
"metadata": {
Expand Down Expand Up @@ -679,6 +690,9 @@
"cell_type": "code",
"execution_count": null,
"metadata": {
"jupyter": {
"source_hidden": true
},
"tags": [
"hide-input",
"full-width",
Expand Down Expand Up @@ -793,6 +807,17 @@
"### Validation"
]
},
{
"cell_type": "markdown",
"metadata": {
"tags": []
},
"source": [
":::{error}\n",
"The following serves as a numerical check on whether the amplitude model has been deserialized correctly. For now, this is not the case, see [ComPWA/ampform-dpd#133](https://github.com/ComPWA/ampform-dpd/issues/133) for updates.\n",
":::"
]
},
{
"cell_type": "code",
"execution_count": null,
Expand Down Expand Up @@ -950,8 +975,12 @@
"jupyter": {
"source_hidden": true
},
"mystnb": {
"code_prompt_show": "Dalitz plot is not yet correct"
},
"tags": [
"hide-input"
"hide-input",
"hide-output"
]
},
"outputs": [],
Expand Down
5 changes: 5 additions & 0 deletions src/ampform_dpd/io/serialization/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
"""Amplitude model serialization
See :doc:`/usage/serialization` for more information and
`https://rub-ep1.github.io/amplitude-serialization/`_ for more information.
"""

0 comments on commit 83b6983

Please sign in to comment.