Skip to content

Commit

Permalink
Update instructions to remember how to get this going on a fresh system
Browse files Browse the repository at this point in the history
  • Loading branch information
ntjohnson1 committed Jul 4, 2024
1 parent bc67ce2 commit f2dff8b
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@
Learning About Using Rust From Python via Tensor Toolbox

## Thoughts
1. Python Bindings
* Python wrappings reside in ./py-tensor
* Local build via `maturin develop -r` in that directory
* See [pyO3](https://github.com/PyO3/pyo3) for more details.

1. Pyttb is based on MATLAB.
This is mostly a port from pyttb discarding the MATLAB.
Expand All @@ -16,6 +12,20 @@ There isn't an attempt to maintain 1:1 compatibility.
1. We depend on ndarray and ndarray-linalg
* See details on [ndarray-linalg](https://github.com/rust-ndarray/ndarray-linalg/blob/master/README.md) to get that to build
* My path on ubuntu was:
* Install `gfortran`
* `cargo test --features=openblas`
* This installs the openblas crate which takes a bit the first time, but minimizes additional setup
* Install rustup
* For convenience (see ndarray for more options)
* apt install gfortran libopenblas-dev
* For code coverage
* apt install pkg-config libssl-dev
* cargo install cargo-tarpaulin
* Check it out
* `cargo tarpaulin --features=openblas-system --skip-clean --engine llvm --exclude-files 'py-tensor/**/*'`

1. Python Bindings
* Python wrappings reside in ./py-tensor
* See [pyO3](https://github.com/PyO3/pyo3) for more details.
* Easiest approach
* Create python env in preferred format
* cd py-tensor
* pip install -e .[dev]
* pytest tests

0 comments on commit f2dff8b

Please sign in to comment.