Release v0.3.3

Author: dilpath

README.md

@@ -4,12 +4,11 @@
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14183390.svg)](https://doi.org/10.5281/zenodo.14183390)
 
 
-The repository for the development of the extension to PEtab for model
-selection, including the additional file formats and Python 3 package.
+The PEtab extension for model selection, including additional file formats and library.
 
 ## Install
 
-The Python 3 package provides both the Python 3 and command-line (CLI)
+The Python 3 library provides both the Python 3 and command-line (CLI)
 interfaces, and can be installed from PyPI, with `pip3 install petab-select`.
 
 ## Documentation
@@ -19,12 +18,8 @@ Further documentation is available at
 
 ## Examples
 
-There are example Jupyter notebooks for usage of PEtab Select with
-
-- the command-line interface, and
-- the Python 3 interface,
-
-in the `doc/examples` directory.
+There are example Jupyter notebooks covering the Python API, CLI, and visualization in the "doc/examples" directory.
+The notebooks can be viewed at [https://petab-select.readthedocs.io/en/stable/examples.html](https://petab-select.readthedocs.io/en/stable/examples.html).
 
 ## Supported features
 

petab_select/model.py

@@ -410,6 +410,19 @@ class Model(ModelBase):
     :attr:`model_subspace_petab_yaml`.
     """
 
+    @model_validator(mode="before")
+    @classmethod
+    def _deprecated_petab_yaml(cls, data: Any) -> Any:
+        if isinstance(data, dict) and "petab_yaml" in data:
+            data[MODEL_SUBSPACE_PETAB_YAML] = data.pop("petab_yaml")
+            warnings.warn(
+                "Change the `petab_yaml` field of your model data "
+                "to `model_subspace_petab_yaml.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        return data
+
     @model_validator(mode="after")
     def _fix_petab_problem(self: Model) -> Model:
         """Fix a missing PEtab problem by loading it from disk."""