Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chanwutk authored Jun 12, 2024
1 parent 49fce4c commit 9edbfef
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,27 +49,27 @@ while maintaining up to 97.1% accuracy compared to unoptimized execution.

## Requirement
```
- python >= 3.10 (Prefer Conda/Mamba)
- docker
- cuda >= 11.7 (If using GPU)
```

## How to Setup Spatialyze Repo
## Setup Spatialyze
### Clone the Spatialyze repo
```bash
git clone --recurse-submodules git@github.com:apperception-db/spatialyze.git
cd spatialyze
```

### We use Conda/Mamba to manage our python environment
Install [Mamba](https://mamba.readthedocs.io/en/latest/installation.html)
or install [Conda](https://docs.conda.io/en/latest/miniconda.html)

### Setup Environment and Dependencies
```bash
# clone submodules
git submodule update --init --recursive
```

### Using Docker Compose
```base
docker compose up --build --detach
```

### Using [Conda](https://docs.conda.io/en/latest/miniconda.html)/[Mamba](https://mamba.readthedocs.io/en/latest/installation.html) Environment
```bash
# setup virtual environment
# with conda
conda env create -f environment.yml
Expand Down

0 comments on commit 9edbfef

Please sign in to comment.