diff --git a/docs/Makefile b/docs/Makefile index 92d225d..e909606 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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: diff --git a/docs/source/userguide/101.md b/docs/source/userguide/101.md new file mode 100644 index 0000000..31b0010 --- /dev/null +++ b/docs/source/userguide/101.md @@ -0,0 +1,3 @@ +# Time Series Outlier Detection 101 + +👷🚧 *Under Construction* 🚧👷‍♀️ \ No newline at end of file diff --git a/docs/source/userguide/installation.md b/docs/source/userguide/installation.md new file mode 100644 index 0000000..f9c4e1b --- /dev/null +++ b/docs/source/userguide/installation.md @@ -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 + ``` +