From ea73381806fd6da9b1acf6d3741f95038373f1ca Mon Sep 17 00:00:00 2001 From: Guilhem Lavaux Date: Mon, 20 May 2024 17:53:49 +0200 Subject: [PATCH] chore: Update README --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fa2875b..a08cb42 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,12 @@ Neural network emulators to transform field/map data ## Installation -Install in editable mode +The source package use [Poetry](https://python-poetry.org/) for its dependency tracking. There are two ways of installing map2map: -```bash -pip install -e . -``` +* either in a local environment. If poetry is installed, it is sufficient to type `poetry shell` and `poetry install` and you get an environment properly setup. + It is in editable state. + +* or you may ask poetry to build a wheel package that you can install: `poetry build` and then `pip install dist/*` ## Usage