Skip to content

Commit 3c1c7ab

Browse files
committed
Update instructions
1 parent 314c9e6 commit 3c1c7ab

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,26 @@ This repository provides a library and command-line interface that reimplements
1212
You may build Finch from source, which requires Rust >= `1.49`. Rust's Cargo package manager (see [rustup](https://www.rustup.rs) for Cargo installation instructions) can automatically build and install Finch with `cargo install finch_cli`.
1313
If you require python bindings, you must take extra steps (see [python support](#python-support)). Alternatively, [download a prebuilt binary](https://github.com/onecodex/finch-rs/releases) or install from [PyPi](https://pypi.org/project/finch-sketch/) `pip install finch-sketch`.
1414

15+
### Development ###
16+
17+
To build wheels locally, run:
18+
19+
```sh
20+
uv venv --python 3.11 #
21+
source .venv/bin/activate
22+
uv build
23+
24+
# or, using maturin by itself:
25+
26+
maturin build --features python --release --strip^
27+
```
28+
29+
#### Building binary wheels and pushing to PyPI
30+
31+
There is a Github Workflow that will build Python wheels for macOS (x86 and
32+
ARM) and Ubuntu (x86). To run, create a new release.
33+
34+
1535
### Example Usage ###
1636
To get started, we first compute sketches for several FASTA or FASTQ files. These sketches are compact, sampled representations of the underlying genomic data, and what allow `finch` to rapidly estimate distances between datasets. Sketching files uses the `finch sketch` command:
1737

@@ -206,7 +226,7 @@ cont, jacc = sketch_one.compare(sketch_two)
206226

207227
## Cap'n Proto
208228

209-
There is a `finch.capnp` in `src/serialization` file and the output of the MinHash schema (https://github.com/marbl/Mash/blob/54e6d66b7720035a2605a02892cad027ef3231ef/src/mash/capnp/MinHash.capnp)
229+
There is a `finch.capnp` in `src/serialization` file and the output of the MinHash schema (https://github.com/marbl/Mash/blob/54e6d66b7720035a2605a02892cad027ef3231ef/src/mash/capnp/MinHash.capnp)
210230
+ the changes by @bovee in https://github.com/bovee/Mash/blob/master/src/mash/capnp/MinHash.capnp
211231

212232
Both are generated after installing `capnp` and `cargo install capnpc` with the following command:

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ maintainer = "One Codex"
88
classifier = [
99
"Intended Audience :: Science/Research",
1010
"License :: OSI Approved :: MIT License",
11-
"Topic :: Scientific/Engineering :: Bio-Informatics"
11+
"Topic :: Scientific/Engineering :: Bio-Informatics",
1212
]
1313
dynamic = ["version"]
1414
readme = "README.md"

0 commit comments

Comments
 (0)