rust-numpy
Rust bindings for the NumPy C-API.
API documentation
Requirements
- Rust >= 1.41.1
- Basically, our MSRV follows the one of PyO3
- Python >= 3.6
- Python 3.5 support is dropped from 0.13
- Some Rust libraries
- ndarray for Rust-side matrix library
- PyO3 for Python bindings
- And more (see Cargo.toml)
- numpy installed in your Python environments (e.g., via
pip install numpy
)- We recommend
numpy >= 1.16.0
, though older versions may work
- We recommend
Note: Starting from 0.3, rust-numpy migrated from rust-cpython to PyO3. If you want to use rust-cpython, use version 0.2.1 from crates.io.
Python 2 support
Version 0.5.0 is the last version that supports Python 2.
If you want to compile this library with Python 2, please use 0.5.0 from crates.io.
In addition, you have to add a feature flag in Cargo.toml
like
[]
= "0.5.0"
= ["python2"]
You can also automatically specify the Python version in setup.py
,
using setuptools-rust.
Dependency on ndarray
This crate uses types from ndarray
in its public API. ndarray
is re-exported
in the crate root so that you do not need to specify it as a direct dependency.
Furthermore, this crate is compatible with multiple versions of ndarray
and therefore depends
on a range of semver-incompatible versions, currently >= 0.13, < 0.16
. Cargo does not
automatically choose a single version of ndarray
by itself if you depend directly or indirectly
on anything but that exact range. It can therefore be necessary to manually unify these dependencies.
For example, if you specify the following dependencies
= "0.15"
= "0.13"
this will currently depend on both version 0.13.1
and 0.15.3
of ndarray
by default
even though 0.13.1
is within the range >= 0.13, < 0.16
. To fix this, you can run
to achieve a single dependency on version 0.13.1
of ndarray
.
Example
Execute a Python program from Rust and get results
[]
= "numpy-test"
[]
= "0.15"
= "0.15"
use PyArray1;
use ;
use IntoPyDict;
Write a Python module in Rust
Please see the simple-extension directory for the complete example. Also, we have an example project with ndarray-linalg.
[]
= "rust_ext"
= ["cdylib"]
[]
= "0.15"
[]
= "0.15"
= ["extension-module"]
use ;
use ;
use ;
Contributing
We welcome issues and pull requests.
PyO3's Contributing.md is a nice guide for starting. Also, we have a Gitter channel for communicating.