Skip to content

Commit 63a7a0f

Browse files
authored
Update README.md
1 parent 984cb44 commit 63a7a0f

File tree

1 file changed

+37
-15
lines changed

1 file changed

+37
-15
lines changed

README.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# SymEngine Python Wrappers
33

4-
Python wrappers to the C++ library [SymEngine](https://github.com/symengine/symengine),
4+
Python wrappers to the C++ library [SymEngine](https://github.com/symengine/symengine),
55
a fast C++ symbolic manipulation library.
66

77
[![Build Status](https://travis-ci.org/symengine/symengine.py.svg)](https://travis-ci.org/symengine/symengine.py)
@@ -34,8 +34,9 @@ Cython >= 0.29.24
3434
SymEngine >= 0.7.0
3535
```
3636

37-
For **SymEngine**, only a specific commit/tag (see `symengine_version.txt`) is supported.
38-
The latest git master branch may not work as there may be breaking changes in **SymEngine**.
37+
For **SymEngine**, only a specific commit/tag (see `symengine_version.txt`) is
38+
supported. The latest git master branch may not work as there may be breaking
39+
changes in **SymEngine**.
3940

4041
Python wrappers can be installed by,
4142

@@ -55,20 +56,31 @@ python setup.py install build_ext
5556
--inplace # Build the extension in source tree
5657
```
5758

58-
Standard options to `setup.py` like `--user`, `--prefix` can be used to configure install location.
59-
NumPy is used if found by default, if you wish to make your choice of NumPy use explicit: then add e.g. `WITH_NUMPY=False` to `--define`.
59+
Standard options to `setup.py` like `--user`, `--prefix` can be used to
60+
configure install location. NumPy is used if found by default, if you wish
61+
to make your choice of NumPy use explicit: then add
62+
e.g. `WITH_NUMPY=False` to `--define`.
6063

6164
### Notes on Dependencies
6265

63-
If you intend to evaluate floating-point expressions (using **lambdify**), you should consider linking against **LLVM**. Many users might also benefit from linking against **FLINT**, as it is now LGPL-licensed.
66+
If you intend to evaluate floating-point expressions (using **lambdify**),
67+
you should consider linking against **LLVM**. Many users might also benefit
68+
from linking against **FLINT**, as it is now LGPL-licensed.
6469

65-
In general, **sudo** is only required if you are installing to the default prefix (`/usr/local`). We recommend specifying a custom prefix (`--prefix=$HOME/.local`) to avoid requiring administrative privileges, which most users can do without using **sudo**.
70+
In general, **sudo** is only required if you are installing to the default
71+
prefix (`/usr/local`). We recommend specifying a custom prefix
72+
(`--prefix=$HOME/.local`) to avoid requiring administrative privileges,
73+
which most users can do without using **sudo**.
6674

67-
If you're uncomfortable specifying the prefix manually, we suggest using **Conda** or installing the pre-built wheels via **pip** instead of building from source.
75+
If you're uncomfortable specifying the prefix manually, we suggest using
76+
**Conda** or installing the pre-built wheels via **pip** instead of building
77+
from source.
6878

6979
## Verification
7080

71-
You can verify the installation of **SymEngine** by using the provided code snippet in this README. This snippet ensures that the installation works as expected and that basic functionality is available.
81+
You can verify the installation of **SymEngine** by using the provided code
82+
snippet in this README. This snippet ensures that the installation works as
83+
expected and that basic functionality is available.
7284

7385
```python
7486
from symengine import var
@@ -82,16 +94,26 @@ This will output:
8294
x**2 + y**2 + z**2 + 2*x*y + 2*x*z + 2*y*z
8395
```
8496

85-
Note: The verification code provided above checks the functionality of SymEngine. For additional verification specific to SymEngine, please refer to the [official SymEngine Python bindings repository](https://github.com/symengine/symengine.py) for further tests and examples.
97+
Note: The verification code provided above checks the functionality of
98+
SymEngine. For additional verification specific to SymEngine, please refer to
99+
the [official SymEngine Python bindings repository](https://github.com/symengine/symengine.py)
100+
for further tests and examples.
86101

87102
## License
88103

89-
symengine.py is MIT licensed and uses several LGPL, BSD-3, and MIT licensed libraries.
104+
symengine.py is MIT licensed and uses several LGPL, BSD-3, and MIT licensed
105+
libraries.
90106

91107
Licenses for the dependencies of pip wheels are as follows:
92108

93-
- pip wheels on Unix use **GMP** (LGPL-3.0-or-later), **MPFR** (LGPL-3.0-or-later), **MPC** (LGPL-3.0-or-later), **LLVM** (Apache-2.0), **zlib** (Zlib), **libxml2** (MIT), **zstd** (BSD-3-Clause), and **symengine** (MIT AND BSD-3-Clause).
94-
- pip wheels on Windows use **MPIR** (LGPL-3.0-or-later) instead of **GMP** above and **pthreads-win32** (LGPL-3.0-or-later) additionally.
95-
- **NumPy** (BSD-3-Clause) and **SymPy** (BSD-3-Clause) are optional dependencies.
96-
- Sources for these binary dependencies can be found on [symengine-wheels](https://github.com/symengine/symengine-wheels/releases).
109+
- pip wheels on Unix use **GMP** (LGPL-3.0-or-later),
110+
**MPFR** (LGPL-3.0-or-later), **MPC** (LGPL-3.0-or-later),
111+
**LLVM** (Apache-2.0), **zlib** (Zlib), **libxml2** (MIT),
112+
**zstd** (BSD-3-Clause), and **symengine** (MIT AND BSD-3-Clause).
113+
- pip wheels on Windows use **MPIR** (LGPL-3.0-or-later) instead of **GMP**
114+
above and **pthreads-win32** (LGPL-3.0-or-later) additionally.
115+
- **NumPy** (BSD-3-Clause) and **SymPy** (BSD-3-Clause) are optional
116+
dependencies.
117+
- Sources for these binary dependencies can be found on
118+
[symengine-wheels](https://github.com/symengine/symengine-wheels/releases).
97119

0 commit comments

Comments
 (0)