Skip to content

Commit

Permalink
Update README.md Installation
Browse files Browse the repository at this point in the history
  • Loading branch information
cmarshak authored Feb 13, 2024
1 parent 45f1ffe commit f7b874a
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,23 @@ In order to easily manage dependencies, we recommend using dedicated project env
via [Anaconda/Miniconda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)
or [Python virtual environments](https://docs.python.org/3/tutorial/venv.html).

1. Install the environment in this repository with `mamba env update -f environment.yml`
2. Activate the environment `conda activate tile-mate`
3. Install the library with `pip` via `pip install tile-mate`
You can install the package with `conda`/`mamba` using:
```
mamba install tile_mate
```
or
```
pip install tile-mate
```
Alternatively, you can clone the repository and manage the environment using the `environment.yml` file provided.

For development, clone the repository and navigate to it in the terminal.
1. `mamba env update -f environment.yml`
2. Activate the environment `conda activate tile-mate`
3. Install the library with `pip` via `pip install tile-mate`.

For development, use `pip` with `-e` (editable) mode:
```
python -m pip install . -e
python -m pip install -e .
```

Python 3.10+ is supported.
Expand Down

0 comments on commit f7b874a

Please sign in to comment.