diff --git a/docs/serialization.ipynb b/docs/serialization.ipynb index 5a51a241..1898190d 100644 --- a/docs/serialization.ipynb +++ b/docs/serialization.ipynb @@ -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": { @@ -679,6 +690,9 @@ "cell_type": "code", "execution_count": null, "metadata": { + "jupyter": { + "source_hidden": true + }, "tags": [ "hide-input", "full-width", @@ -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, @@ -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": [], diff --git a/src/ampform_dpd/io/serialization/__init__.py b/src/ampform_dpd/io/serialization/__init__.py index e69de29b..297f29bb 100644 --- a/src/ampform_dpd/io/serialization/__init__.py +++ b/src/ampform_dpd/io/serialization/__init__.py @@ -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. +"""