Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add information about not requiring WSL for pip-installed Deephaven #4873

Merged
merged 3 commits into from
Nov 27, 2023
Merged

Add information about not requiring WSL for pip-installed Deephaven #4873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
641f6ba
Updates
jjbrosnan Nov 21, 2023
1d61897
Update py/server/README.md
margaretkennedy Nov 21, 2023
e5d6296
Fix note formatting
jjbrosnan Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ docker compose up

### pip-installed Deephaven

Users who wish to use Python but not Docker should use [pip-installed Deephaven](https://deephaven.io/core/docs/tutorials/quickstart-pip/).
Users who wish to use Python but not Docker should use [pip-installed Deephaven](https://deephaven.io/core/docs/tutorials/quickstart-pip/). For users with Windows operating systems, WSL is **not** required to use Deephaven this way.

```sh
pip install --upgrade pip setuptools wheel
Expand Down Expand Up @@ -150,18 +150,10 @@ docker compose version
docker run hello-world
```

:::note

Internally, the Java build process will use [Gradle Auto Provisioning](https://docs.gradle.org/current/userguide/toolchains.html#sec:provisioning)
> **_NOTE:_** Internally, the Java build process will use [Gradle Auto Provisioning](https://docs.gradle.org/current/userguide/toolchains.html#sec:provisioning)
to download and use the appropriate Java version for building and testing.

:::

:::note

On Windows, all commands must be run inside a WSL 2 terminal.

:::
> **_NOTE:_** On Windows, all commands must be run inside a WSL 2 terminal.

#### Python

Expand Down
9 changes: 7 additions & 2 deletions py/server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@ maximum performance. By taking advantage of the unique streaming table capabilit
facilities (Kafka, Parquet, CSV, SQL, etc.), Python developers can quickly put together a real-time data processing pipeline
that is high performing and easy to consume.

If you use a Windows operating system, WSL is **not** required to run Deephaven via pip.

## Install

Because this package depends on the Deephaven server, it comes preinstalled with Deephaven Docker images and is made
available at runtime in the Python console in the Deephaven Web UI.

## Quick start
``` python

```python
from deephaven import read_csv
from deephaven.stream.kafka.consumer import kafka_consumer, TableType
from deephaven.plot import Figure, PlotStyle
Expand All @@ -27,7 +30,9 @@ plot = Figure() \
```

## Related documentation

* https://deephaven.io/

## API Reference
[start here] https://deephaven.io/core/pydoc/

[Start here](https://deephaven.io/core/pydoc/)
Loading