Skip to content

Commit 7746a91

Browse files
Update Python API documentation (cvc5#10995)
Resolves cvc5#10288. Requires cvc5#10994.
1 parent 129c0c7 commit 7746a91

File tree

3 files changed

+23
-15
lines changed

3 files changed

+23
-15
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,13 @@ For detailed build and installation instructions on these platforms,
6262
see file [INSTALL.rst](https://github.com/cvc5/cvc5/blob/main/INSTALL.rst).
6363

6464

65+
Interfaces
66+
-------------------------------------------------------------------------------
67+
68+
cvc5 features APIs for several different programming languages such as Python and
69+
Java. See the [user documentation](https://cvc5.github.io/docs/) for more information.
70+
71+
6572
Bug Reports
6673
-------------------------------------------------------------------------------
6774

docs/api/python/python.rst

+9-14
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If you would like a more feature-complete---yet verbose---python API, with the a
2828
You can compare examples using the two APIs by visiting the :doc:`examples page <../../examples/quickstart>`.
2929

3030

31-
Installation (x86-64 variants of Linux and macOS)
31+
Installation (from PyPi)
3232
------------
3333

3434
The base and pythonic Python API can be installed via `pip` as follows:
@@ -38,27 +38,22 @@ The base and pythonic Python API can be installed via `pip` as follows:
3838
pip install cvc5
3939
4040
41-
Installation (ARM64 variants of Linux and macOS)
41+
Installation (from source)
4242
------------
4343

44-
For ARM64-based machines (including Apple computers with M1 and M2 chips), the base and the pythonic Python API can be installed from source.
45-
Before building and installing, the following dependencies should be installed, using `brew` and `pip`:
44+
The base and pythonic Python API can also be installed from source following these steps:
4645

4746
.. code:: bash
4847
49-
brew install cmake python gmp java
50-
51-
52-
Then `cvc5` can be installed from source as follows:
53-
54-
.. code:: bash
55-
56-
git clone [email protected]:cvc5/cvc5.git
48+
git clone https://github.com/cvc5/cvc5.git
5749
cd cvc5
5850
./configure.sh --python-bindings --auto-download
5951
cd build
60-
make cvc5_python_api # add -jN for parallel build using N threads
61-
export PYTHONPATH="<path-to-local-cvc5-repo>/build/src/api/python/:$PYTHONPATH"
52+
make # add -jN for parallel build using N threads
53+
make install
54+
55+
For Windows, the steps above must be executed on a MINGW64 environment
56+
(see the `installation instructions <../../installation/installation>`).
6257

6358
And to make sure that it works:
6459

src/api/python/pyproject.toml

+7-1
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,17 @@ build-backend = "setuptools.build_meta"
1010
name="cvc5"
1111
description="Python bindings for cvc5"
1212
dynamic = ["version"]
13-
urls = {Homepage = "https://github.com/cvc5/cvc5"}
1413
license = {text = "BSD-3-Clause AND LGPL-3.0-or-later AND MIT"}
1514
# BSD-3-Clause : cvc5 library and Python API
1615
# LGPL-3.0-or-later : LibPoly and GMP
1716
# MIT : Pythonic API
1817

18+
[project.urls]
19+
Homepage = "https://cvc5.github.io/"
20+
Documentation = "https://cvc5.github.io/docs/"
21+
Repository = "https://github.com/cvc5/cvc5"
22+
Issues = "https://github.com/cvc5/cvc5/issues"
23+
Changelog = "https://github.com/cvc5/cvc5/blob/main/NEWS.md"
24+
1925
[tool.setuptools.dynamic]
2026
version = {attr = "cvc5.__version__"}

0 commit comments

Comments
 (0)