jepler/gmpy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update docs and prepare for v2.1.0a2

Browse source
This commit is contained in:
Case Van Horsen 2018-04-14 11:27:51 -07:00
parent 2a63e81306
commit dcb92c8b39
2 changed files with 29 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README
View file

@ -1,22 +1,13 @@
Welcome to gmpy2 project!
-------------------------
gmpy2 provides fast multiple-precision arithmetic to Python. gmpy2 is an
optimized C extension that supports the GMP, MPFR, and MPC libraries.
gmpy2 is based on the original gmpy module. gmpy2 adds support for correctly
rounded multiple-precision real (using the MPFR library) and complex (using
the MPC library) arithmetic.
gmpy2 is an optimized, C-coded Python extension module that supports fast
multiple-precision arithmetic. gmpy2 is based on the original gmpy module.
gmpy2 adds support for correctly rounded multiple-precision real arithmetic
(using the MPFR library) and complex arithmetic (using the MPC library).
The gmpy2 2.0.x series is a stable version that is only receiving bug fixes.
The main development branch (2.1.x) was extensively refactored. The most
significant changes are support for thread-safe contexts and context methods.
gmpy2 is available at https://pypi.python.org/pypi/gmpy2
gmpy2 is available at https://pypi.python.org/pypi/gmpy2/
Documentation is available at https://gmpy2.readthedocs.io/en/latest/
To install a development version of gmpy2 2.1.x, just clone or copy
the repository and follow the instructions in the INSTALL file. Detailed
instructions for building on Windows using the MSYS2/MINGW-W64 tool chain
can be found in msys2_build.txt

38
docs/intro.rst
View file

@ -37,15 +37,10 @@ gmpy2 Versions
This manual documents the two major versions of gmpy2. Sections that are
specific to a particular version will be identified as such.
There are two versions of gmpy2. The 2.0 version is the stable release that
only receives bug fixes and very minor updates. Version 2.1 is currently under
active development and includes several new capabilities. Most gmpy2 2.0 code
should run unchanged with gmpy2 2.1
Enhancements in gmpy2 2.1
-------------------------
The most significant changes in gmpy2 2.1 are:
The 2.0 version is the stable release that only receives bug fixes and very
minor updates. Version 2.1 is currently under active development and includes
several new capabilities. Most gmpy2 2.0 code should run unchanged with
gmpy2 2.1.
Changes in gmpy2 2.1.0a1
------------------------
@ -71,12 +66,16 @@ Changes in gmpy2 2.1.0a1
true for the other gmpy2 types.
* Support for Cython via the addition of a C-API and a gmpy2.pxd file.
Changes in gmpy2 2.1.0a2
------------------------
* Revised build system.
* Removal of unused code/macros.
* Cleanup of Cython interface.
Installation
============
This section will be updated soon to reflect improved support of pip and the
wheel format.
Installing gmpy2 on Windows
---------------------------
@ -101,8 +100,12 @@ later is required. MPC 1.0.1 or later is required for complex arithmetic.
Short Instructions
^^^^^^^^^^^^^^^^^^
If your system includes sufficiently recent versions of GMP, MPFR and MPC, and
you have the development libraries installed, compiling should be as simple as:
gmpy2 requires the development files for GMP, MPFR, and MPC. The actual package
that provides these files varies between Linux distributions. Install "libmpc-dev"
(or its equivalent) is usually sufficient.
If your system has the development libraries installed, compiling should be as
simple as:
::
@ -114,6 +117,13 @@ If this fails, read on.
Detailed Instructions
^^^^^^^^^^^^^^^^^^^^^
Note: You really shouldn't need to do this. Unless you need the capabilities
provided a newer GMP/MPFR/MPC, you should use the versions provided by your
distribution.
Note: The following instructions are currently out-of-date and will be revised
for the next alpha release.
If your Linux distribution does not support recent versions of GMP, MPFR and
MPC, you will need to compile your own versions. To avoid any possible conflict
with existing libraries on your system, it is recommended to use a directory