Skip to content

Commit

Permalink
win
Browse files Browse the repository at this point in the history
  • Loading branch information
joocer committed Feb 12, 2025
1 parent b99f162 commit ae40a91
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 15 deletions.
28 changes: 15 additions & 13 deletions docs/get-started/deployment-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,23 @@ Opteryx can be installed and deployed on a number of different platforms. It has

The full regression suite is run on Ubuntu (Ubuntu 24) for Python versions 3.10, 3.11, and 3.12. The below table shows regression suite coverage:

OS | Python 3.10 | Python 3.11 | Python 3.12 |
----------------- | :---------: | :---------: | :---------: |
MacOS (x86/Intel) | Partial | Partial | None |
MacOS (M-series) | Partial | Partial | Partial |
Ubuntu (x86) | Full | Full | Full |
Ubuntu (ARM) | Partial | Partial | Partial |
OS | Python 3.9 | Python 3.10 | Python 3.11 | Python 3.12 | Python 3.13 |
----------------- | :---------: | :---------: | :---------: | :---------: | :---------: |
MacOS (x86/Intel) | None | Partial | Partial | None | None |
MacOS (M-series) | None | Partial | Partial | Partial | Partial |
Ubuntu (x86) | None | Full | Full | Full | Partial |
Ubuntu (ARM) | None | Partial | Partial | Partial | Partial |
Windows (x86) | None | None | None | None | **No Build** |


 **Full** - no tests are excluded from the test suite - coverage statistics are from Ubuntu Python 3.10 tests.
 **Partial** - some tests are excluded from the test suite or that some tests fail.
 **None** - there is no automated test for this configuration.
 **No Build** - compatibility issues prevent this combination from being built.

!!! Note
- Windows (x86) last supported version 0.19.0
- Python 3.9 is not recommended
- Windows (x86) last supported version 0.19.0, builds are still created but not recommended for use beyond prototyping
- Python 3.8 last supported version 0.11.0
- Partial coverage is primarily due to testing platform constraints, not core-compatibility issues.

Expand All @@ -51,15 +54,14 @@ Opteryx supports Python versions 3.9, 3.10 and 3.11. Due to variations in suppor

Environment | Python Versions Supported
----------------- | -----------------------------------
Linux 64bit x86 | 3.9, 3.10, 3.11, 3.12
Linux ARM | build from source
MacOS Intel | 3.9, 3.10, 3.11, 3.12
MacOS Apple (M) | 3.9, 3.10, 3.11, 3.12
Linux 64bit x86 | 3.9, 3.10, 3.11, 3.12, 3.13
Linux ARM | 3.9, 3.10, 3.11, 3.12, 3.13
MacOS Intel | 3.9, 3.10, 3.11, 3.12, 3.13
MacOS Apple (M) | 3.9, 3.10, 3.11, 3.12, 3.13
Windows x86 | 3.9, 3.10, 3.11, 3.12

Opteryx is primarily developed on workstations running Python 3.11 (Debian x86, Raspian, and MacOS M2) and is known to be deployed in production environments running Python 3.9 and Python 3.11 on Debian.

Python 3.11 has the greatest test coverage due to it being supported on more platforms.

### Jupyter Notebooks

Opteryx can run in Jupyter Notebooks to access data locally or, if configured, remotely on systems like GCS and S3.
Expand Down
4 changes: 2 additions & 2 deletions docs/get-started/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

### Requirements

- Operating System: macOS, Linux or Windows
- Operating System: MacOS, Linux or Windows
- Python:
- 3.9 or later
- **Note**: For Apple Silicon Mac, Python 3.11 or later is required
- **Note**: Windows is not recommented

### Install from PyPI (recommended)

Expand Down

0 comments on commit ae40a91

Please sign in to comment.