Aquila-Consortium/map2map
32
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: Update README

Browse Source
This commit is contained in:
Guilhem Lavaux 2024-05-20 17:53:49 +02:00
parent 7361c3eb9d
commit ea73381806
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -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