From c5684409069788f7b61b6c4a138f989b2021ee62 Mon Sep 17 00:00:00 2001
From: Tor-Einar Skog <tor-einar.skog@nibio.no>
Date: Mon, 13 Feb 2023 10:39:58 +0100
Subject: [PATCH] Documenting model deployment

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 267662d..a5d8aeb 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,8 @@ Install dependencies from requirements.txt
 
 This was done at start of project, and must be repeated after all dependency changes:
 
+TODO: Decide on whether to use pip freeze or manage requirements.txt manually. Ref e.g. [this blogpost](https://medium.com/@tomagee/pip-freeze-requirements-txt-considered-harmful-f0bce66cf895)
+
 ```sh
 (venv)$ pip install "fastapi[all]" (and others)
 (venv)$ pip freeze > requirements.txt
@@ -44,6 +46,13 @@ $ . venv/bin/activate
 (venv)$ deactivate
 ```
 
+### Install VIPS models
+The VIPS models available will vary between deployments of VIPSCore-Python. They are installed using pip, and specified in `models.txt` - which can be considered a deployment specific addendum to `requirements.txt`. Copy `models_example.txt` to `models.txt` to get started.
+
+```sh
+pip install -r models.txt
+```
+
 ## Development
 
 ### Run application locally
-- 
GitLab