From 43b1dbf61866631323cfa707ee2071cccefffb12 Mon Sep 17 00:00:00 2001
From: Tor-Einar Skog <tor-einar.skog@nibio.no>
Date: Tue, 31 Jan 2023 15:53:45 +0100
Subject: [PATCH] Documenting discovery and abstraction

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ff069e1..cada388 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,21 @@
-# ReferenceModel
\ No newline at end of file
+# ReferenceModel
+
+## How to find and instantiate this model
+TODO: Must find a way of dynamically importing models
+
+``` 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        "
+
+```
\ No newline at end of file
-- 
GitLab