Skip to content

Commit c24f599

Browse files
committed
docs: refresh README — version-agnostic refs, current Smart Merge (DOI-determinative + in-step uncertain-pair review), "Two ways to use BibexPy" + BibexPy-Lite links
1 parent a34c4a8 commit c24f599

1 file changed

Lines changed: 19 additions & 12 deletions

File tree

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
22
<a href="https://bibexpy.com">
3-
<img src="apps/web/public/images/bibexpy-logo-full.png" alt="BibexPy — V2.0.0 Helium — Bibliometrics Experience with Python" width="420">
3+
<img src="apps/web/public/images/bibexpy-logo-full.png" alt="BibexPy — v2 Helium — Bibliometrics Experience with Python" width="420">
44
</a>
55
</p>
66

@@ -25,7 +25,7 @@
2525

2626
---
2727

28-
**BibexPy v2.0.0 “Helium”** — the successor to v1.1.0 “Hydrogen” — turns the original
28+
**BibexPy v2 (“Helium”)** — the successor to v1 (“Hydrogen”) — turns the original
2929
command-line BibexPy into a **local web platform**, shipped as a single pip-installable
3030
package. It merges, filters, harmonizes, enriches and exports Web of Science + Scopus
3131
records with full provenance, and **never sends your licensed exports off your machine**.
@@ -34,10 +34,14 @@ records with full provenance, and **never sends your licensed exports off your m
3434
<img src=".github/assets/bibexpy-home.png" alt="BibexPy v2 home screen" width="780">
3535
</p>
3636

37-
> **Just need to merge in Google Colab?** [**BibexPy-Lite**](https://github.com/bcankara/BibexPy-Lite)
38-
> is a lightweight, no-install companion that runs the same Smart Merge algorithm
39-
> (WoS + Scopus deduplication) in a notebook or terminal — no web UI, no enrichment.
40-
> [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/bcankara/BibexPy-Lite/blob/main/BibexPy_Lite.ipynb)
37+
### Two ways to use BibexPy
38+
39+
| | What it is | Best for |
40+
|---|---|---|
41+
| **Full app** (this repo) | `pip install bibexpy` → a local web platform: merge → filter → harmonize → enrich → export → report. | The complete, reproducible workflow on your own machine. |
42+
| **[BibexPy-Lite](https://github.com/bcankara/BibexPy-Lite)** [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/bcankara/BibexPy-Lite/blob/main/BibexPy_Lite.ipynb) | A lightweight notebook/terminal tool that runs the **same Smart Merge algorithm** — no web UI, no enrichment. | A quick WoS + Scopus **merge** in Google Colab or a terminal. |
43+
44+
Both share one merge algorithm, so results are identical.
4145

4246
## Install
4347

@@ -64,7 +68,7 @@ inside the wheel). Works on Windows, macOS and Linux.
6468
python -m bibexpy --port 8080 # custom port
6569
python -m bibexpy --no-browser # server only
6670
python -m bibexpy --storage ./data # custom storage folder
67-
python -m bibexpy --version # → BibexPy 2.0.2 (Helium)
71+
python -m bibexpy --version # → BibexPy 2.0.x (Helium)
6872
```
6973

7074
(The short `bibexpy` command accepts exactly the same options.)
@@ -99,9 +103,11 @@ On macOS/Linux the `bibexpy` command is normally on PATH right after `pip instal
99103
- **Built-in sample dataset** — the first launch creates a ready-to-explore **Simple
100104
Project** (real Web of Science + Scopus exports), so you can try the whole pipeline
101105
before uploading your own data.
102-
- **One-click Smart Merge** — multi-stage probabilistic record linkage: exact DOI/identifier
103-
matching + Jaro–Winkler title similarity, confidence scoring, and an optional
104-
borderline-review queue. The result includes a copy-ready methodology paragraph.
106+
- **One-click Smart Merge** — staged record linkage with a **DOI-determinative** rule
107+
(records whose normalized DOIs differ are never merged), identifier matching, and
108+
Jaro–Winkler title similarity with confidence scoring, plus field-level merging. Pairs
109+
it cannot resolve with certainty are kept separate and offered for an optional review
110+
right in the merge step. The result includes a copy-ready methodology paragraph.
105111
- **ORCID-first author disambiguation** — ORCID identifiers as deterministic evidence, with a
106112
constrained field-similarity fallback only when coverage is incomplete.
107113
- **Address harmonization** — organization roll-up to a canonical parent institution +
@@ -169,8 +175,8 @@ bash scripts/build_wheel.sh # macOS / Linux
169175
pwsh scripts/build_wheel.ps1 # Windows
170176
```
171177

172-
`python_pkg/dist/bibexpy-2.0.2-py3-none-any.whl` — a pure-python `py3-none-any` wheel that
173-
installs on Windows / macOS / Linux with no compiler.
178+
`python_pkg/dist/bibexpy-<version>-py3-none-any.whl` — a pure-python `py3-none-any` wheel
179+
that installs on Windows / macOS / Linux with no compiler.
174180

175181
## Release
176182

@@ -185,6 +191,7 @@ git tag v2.0.0 && git push origin v2.0.0
185191

186192
[Website](https://bibexpy.com) ·
187193
[Docs](https://bibexpy.com/doc) ·
194+
[BibexPy-Lite (Colab)](https://github.com/bcankara/BibexPy-Lite) ·
188195
[YouTube](https://www.youtube.com/@BibexPy) ·
189196
[X / Twitter](https://twitter.com/BibexPy) ·
190197
[Instagram](https://www.instagram.com/bibexpy/) ·

0 commit comments

Comments
 (0)