chore: Update README

This commit is contained in:
Guilhem Lavaux 2024-05-20 17:53:49 +02:00
parent 7361c3eb9d
commit ea73381806

View File

@ -18,11 +18,12 @@ Neural network emulators to transform field/map data
## Installation ## 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 * 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.
pip install -e . 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 ## Usage