diff --git a/README.md b/README.md index 7f9617834edc9ec1803f41f1be3e6bab80dbb84f..c6da2bb76aff66595c3db16865239edb24aa0f89 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,11 @@ -# ReferenceModel - -## How to find and instantiate this model -TODO: Must find a way of dynamically importing models - -Clues here: https://stackoverflow.com/questions/42401495/how-to-dynamically-import-modules#42402095 +<img src="docs/illustrations/vipslogo_512.png" alt="VIPS Logo" height="250"/> -``` python ->>> from reference_model import reference_model ->>> from vipscore_common.vips_model import VIPSModel ->>> print(VIPSModel.__subclasses__()) -[<class 'reference_model.reference_model.ReferenceModel'>] ->>> print(VIPSModel.__subclasses__()[0]) -<class 'reference_model.reference_model.ReferenceModel'> ->>> t = VIPSModel.__subclasses__()[0]() ->>> t -<reference_model.reference_model.ReferenceModel object at 0x7f8fab6dee30> ->>> t.get_model_name() -'Reference Model' ->>> t.get_model_description() -"\n The model is a reference model for developers, showcasing best practices and functionalities of a model.\n It's a simple day degree model for an imagined pest, and when thresholds are passed, the warning status progresses.\n " +# ReferenceModel +This VIPS model is **an example only, without any actual agronomic value**. It provides examples of how you +create your own pest prediction model that can be deployed to a [VIPSCore-Python server](https://gitlab.nibio.no/VIPS/VIPSCore-Python) deployment. -``` +## How to deploy this model +See the [VIPSCore-Python README](https://gitlab.nibio.no/VIPS/VIPSCore-Python#install-vips-models) for how to make it available on that server. ## Testing The tests are located in the `tests` folder, and we're using [Pytest](https://docs.pytest.org/) diff --git a/docs/illustrations/vipslogo_512.png b/docs/illustrations/vipslogo_512.png new file mode 100644 index 0000000000000000000000000000000000000000..f4e416ef1adf3fa60969a5cfb1fd6387ee867ae3 Binary files /dev/null and b/docs/illustrations/vipslogo_512.png differ