Skip to content

Commit

Permalink
correcting make process + userguide
Browse files Browse the repository at this point in the history
  • Loading branch information
benjaminye committed Oct 6, 2022
1 parent 4a9adc4 commit 2b805bc
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 3 deletions.
4 changes: 1 addition & 3 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,8 @@ help:
clean:
@echo "[Makefile] cleaning..."
@rm -rf "./$(BUILDDIR)"
@rm -rf "./$(SOURCEDIR)/examples"
# @rm -rf "./$(SOURCEDIR)/examples"
@rm -rf "./$(SOURCEDIR)/generated_api"
@rm -rf "./$(SOURCEDIR)/quickstart"
@rm -rf "./$(SOURCEDIR)/userguide"
@rm -rf "./$(SOURCEDIR)/README.rst"

# copy-examples:
Expand Down
3 changes: 3 additions & 0 deletions docs/source/userguide/101.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Time Series Outlier Detection 101

👷🚧 *Under Construction* 🚧👷‍♀️
35 changes: 35 additions & 0 deletions docs/source/userguide/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Installation
## PyPI
1. Install package via pip
```sh
pip install pyoats
```

## Docker
1. Clone the repo
```sh
git clone https://github.com/georgian-io/pyoats.git && cd pyoats
```
2. Build image
```sh
docker build -t pyoats .
```
3. Run Container
```sh
# CPU Only
docker run -it pyoats
# with GPU
docker run -it --gpus all pyoats
```

## Local
1. Clone the repo
```sh
git clone https://github.com/georgian-io/pyoats.git && cd pyoats
```
2. Install via Poetry
```sh
poetry install
```

0 comments on commit 2b805bc

Please sign in to comment.