Skip to content

Commit 2b612c9

Browse files
committed
Update available platforms
1 parent 9b085aa commit 2b612c9

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

docs/formats/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 3
1010
We briefly discuss the file formats for storing SDP problems. Most SDP solvers were developed in the late 1990s, which is when these formats were specified.
1111

1212
{: .attention }
13-
This section is an optional read if you want to use SDPA for Python. For quick start, please see the [Usage](https://sdpa-python.github.io/docs/usage/) section.
13+
This section is an optional read if you want to use SDPA for Python. For quick start, please see the [Usage](docs/usage/) section.
1414

1515
{: .warning }
1616
*SDPA for Python* solves an problem in a different standard form than *SDPA*. Below, when we say SDPA, we mean the backend software used by SDPA for Python. SDPA for Python, can however read problems stored in SDPA sparse format.

docs/installation/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 2
77

88
# Installing SDPA for Python
99

10-
SDPA for Python can be installed for `x86_64` through `pip`. Two variants of this package are available on the Python Package Index (PyPI). The package using the SDPA (OpenBLAS) backend can be installed by
10+
SDPA for Python can be installed via `pip` on Windows, macOS and Linux for `x86_64` (as well as for `arm64` on Linux). Two variants of this package are available on the Python Package Index (PyPI). The package using the SDPA (OpenBLAS) backend can be installed by
1111

1212
```bash
1313
pip install sdpa-python
@@ -19,4 +19,6 @@ The package using the [SDPA Multiprecision](https://github.com/sdpa-python/sdpa-
1919
pip install sdpa-multiprecision
2020
```
2121

22-
Wheels for other architectures are not currently available but we have provided build instructions for Windows, Linux and macOS if you would like to build it from source. `sdpa-python` has currently not been tested on other architectures.
22+
{: .attention }
23+
**Apple Silicon**
24+
`sdpa-multiprecision` wheels are available for Apple Silicon. The regular variant is currently only installable from source (instructions below). Due to a lack of a Fortran cross compiler, we are not able to provide macOS `arm64` wheels for the regular variant.

index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Interior-point SDP solver for Python
1717

1818
---
1919

20-
SDPA for Python (`sdpa-python`) is a Python 3 wrapper for SDPA (SemiDefinite Programming Algorithm). SDPA is a software package for solving general SDPs based on primal-dual interior-point methods with the HRVW/KSH/M search direction [1].
20+
SDPA for Python is a Python 3 wrapper for SDPA (SemiDefinite Programming Algorithm). SDPA is a software package for solving general SDPs based on primal-dual interior-point methods with the HRVW/KSH/M search direction [1].
2121

2222
This package is a fork of SDPAP, the Python interface for SDPA provided at the [official SDPA website](http://sdpa.sourceforge.net/download.html). This repository aims to provide Python 3 support for both SDPA and [SDPA Multiprecision](https://github.com/sdpa-python/sdpa-multiprecision) (fork of SDPA-GMP [4]).
2323

@@ -37,11 +37,11 @@ The package using the SDPA Multiprecision (GMP) backend can be installed by
3737
pip install sdpa-multiprecision
3838
```
3939

40-
PyPI currently does not have wheels for Apple M1 but it can built from source. Please see the instructions in the [Installation](https://sdpa-python.github.io/docs/installation/) section.
40+
For supported platforms, please see the [Installation](docs/installation/) section.
4141

4242
### Usage
4343

44-
To get started, see the [Usage](https://sdpa-python.github.io/docs/usage/) section.
44+
To get started, see the [Usage](docs/usage/) section.
4545

4646
## History
4747

0 commit comments

Comments
 (0)