Skip to content

Commit

Permalink
Add section on building from source to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jackh726 committed May 13, 2024
1 parent 754645c commit a383b9f
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ dist/

**/workdir
.vscode
pybigtools/html/
pybigtools/html/
pybigtools/tests/data/
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,35 @@ See the `pybigtools` 🐍 [API Documentation](https://bigtools.readthedocs.io/en

The `pybigtools` package can be used as a dpendency either through [pypi](https://pypi.org/project/pybigtools/) or [conda](https://anaconda.org/bioconda/pybigtools/).

## How to build from source

In order to build the bigtools binaries, you can run

```
cargo build --release
```

and the binaries can be found in `target/release/`.

Otherwise, you can install the binaries from source by running

```
cargo install --path bigtools/
```

Building the python wheels for pybigtools requires [maturin](https://pypi.org/project/maturin/). To build the pybigtools wheel for installation (and install), you can run

```
maturin build --release -m pybigtools/Cargo.toml
pip install target/wheels/pybigtools*.whl
```

or

```
maturin develop --release -m pybigtools/Cargo.toml
```

## Benchmarks
[Benchmarks]: #Benchmarks

Expand Down

0 comments on commit a383b9f

Please sign in to comment.