diff --git a/docs/usage/installation.md b/docs/usage/installation.md index 70f75c3f78..ffd3ffcefb 100644 --- a/docs/usage/installation.md +++ b/docs/usage/installation.md @@ -1,17 +1,57 @@ # Installation -The `deltalake` project can be installed via Pip for Python or Cargo for Rust. +The `deltalake` project can be installed via pip for Python or Cargo for Rust. -## Using Pip +## Install Delta Lake for Python + +With pip: ``` bash pip install deltalake ``` -NOTE: official binary wheels are linked against openssl statically for remote objection store communication. Please file Github issue to request for critical openssl upgrade. +With Conda: + +```bash +conda install -c conda-forge deltalake +``` + +## Install Delta Lake for Rust -## Using Cargo +With Cargo: ``` bash cargo add deltalake -``` \ No newline at end of file +``` + +## Run Delta Lake and pandas in a Jupyter Notebook + +You can easily run Delta Lake and pandas in a Jupyter notebook. + +Create an environment file with the dependencies as follows: + +```yaml +name: deltalake-minimal +channels: + - conda-forge + - defaults +dependencies: + - python=3.11 + - ipykernel + - pandas + - polars + - jupyterlab + - pip + - pip: + - deltalake +``` + +Create a virtual environment with the dependencies: + +```bash +conda env create -f deltalake-minimal.yml +``` + +Open the Jupyter notebook and run commands as follows: + +![](jupyter-example.png) diff --git a/docs/usage/jupyter-example.png b/docs/usage/jupyter-example.png new file mode 100644 index 0000000000..64ca6a3140 Binary files /dev/null and b/docs/usage/jupyter-example.png differ