splink

(★ 2,351)

Fast, accurate and scalable probabilistic data linkage with support for multiple SQL backends

File Explorer

Download Latest Version (.zip)

- - bug_report.yml
  - config.yml
  - FEATURE_REQUEST.md
- - check-lockfile.yml
  - check-minimal-import.yml
  - codeql-analysis.yml
  - demo-examples.yml
  - demo-tutorials.yml
  - dependency-canary.yml
  - dependency-review.yml
  - documentation.yml
  - lint.yml
  - pypi-release.yml
  - pytest-duckdb.yml
  - pytest-postgres.yml
  - pytest-spark.yml
  - pytest-sqlite.yml
  - typechecking.yml
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- - api_docs_index.md
  - blocking.md
  - blocking_analysis.md
  - clustering.md
  - column_expression.md
  - comparison_level_library.md
  - comparison_library.md
  - datasets.md
  - em_training_session.md
  - evaluation.md
  - exploratory.md
  - inference.md
  - linker_clustering.md
  - misc.md
  - settings_dict_guide.md
  - splink_dataframe.md
  - table_management.md
  - training.md
  - visualisations.md
- - .authors.yml
  - index.md
- - accuracy_analysis_from_labels_table.nb.py
  - cluster_studio_dashboard.nb.py
  - comparison_viewer_dashboard.nb.py
  - completeness_chart.nb.py
  - cumulative_comparisons_to_be_scored_from_blocking_rules_chart.nb.py
  - index.md
  - m_u_parameters_chart.nb.py
  - match_weights_chart.nb.py
  - parameter_estimate_comparisons_chart.nb.py
  - profile_columns.nb.py
  - tf_adjustment_chart.nb.py
  - threshold_selection_tool_from_labels_table.nb.py
  - unlinkables_chart.nb.py
  - waterfall_chart.nb.py
- - custom.css
  - neoteroi-mkdocs.css
- - conftest.py
  - pyproject.toml
  - uv.lock
- - caching.md
  - CONTRIBUTING.md
  - debug_modes.md
  - dependency_compatibility_policy.md
  - index.md
  - spark_pipelining_and_caching.md
  - transpilation.md
  - udfs.md
- - __init__.py
- - favicon.ico
  - postcode_components.png
  - vega_spec_for_readme.vg.json
- - tags.md
- - mathjax.js
- - main.html
- - topic_guides_index.md
- getting_started.md
- index.md
- profile_columns_tooltip_1.png
- - development_environment.yaml
  - development_environment_lock_Linux-x86_64.txt
  - development_setup_with_conda.sh
- - test_uv_build.sh
- - docker-compose.yaml
  - servers.json
  - setup.sh
  - teardown.sh
- - custom_dictionary.txt
  - pyspelling.yml
  - spellchecker.sh
- - ensure_packages_installed.sh
- build-test.dockerfile
- generate_dataset_docs.py
- make_docs_locally.sh
- make_test_datasets_smaller.py
- reduce_notebook_runtime.py
- run_notebooks.sh
- test_build.sh
- update_vega.py
- - duckdb.py
  - postgres.py
  - spark.py
  - sqlite.py
- - __init__.py
  - accuracy.py
  - block_from_labels.py
  - blocking.py
  - blocking_analysis.py
  - blocking_rule_creator.py
  - blocking_rule_creator_utils.py
  - blocking_rule_library.py
  - cache_dict_with_logging.py
  - charts.py
  - chunking.py
  - cluster_studio.py
  - clustering.py
  - column_expression.py
  - comparison.py
  - comparison_creator.py
  - comparison_level.py
  - comparison_level_composition.py
  - comparison_level_creator.py
  - comparison_level_library.py
  - comparison_level_sql.py
  - comparison_library.py
  - comparison_vector_distribution.py
  - comparison_vector_values.py
  - completeness.py
  - connected_components.py
  - constants.py
  - database_api.py
  - dialects.py
  - edge_metrics.py
  - em_sampling.py
  - em_training_session.py
  - estimate_u.py
  - exceptions.py
  - expectation_maximisation.py
  - find_matches_to_new_records.py
  - graph_metrics.py
  - input_column.py
  - labelling_tool.py
  - linker.py
  - logging_messages.py
  - lower_id_on_lhs.py
  - m_from_labels.py
  - m_training.py
  - m_u_records_to_parameters.py
  - match_weights_histogram.py
  - misc.py
  - one_to_one_clustering.py
  - parse_sql.py
  - pipeline.py
  - predict.py
  - profile_data.py
  - realtime.py
  - settings.py
  - settings_creator.py
  - similarity_analysis.py
  - splink_comparison_viewer.py
  - splink_dataframe.py
  - splink_logging.py
  - splinkdataframe_utils.py
  - sql_transform.py
  - term_frequencies.py
  - testing.py
  - unique_id_concat.py
  - unlinkables.py
  - vertically_concatenate.py
  - waterfall_chart.py
- __init__.py
- blocking_analysis.py
- blocking_rule_library.py
- clustering.py
- comparison_level_library.py
- comparison_library.py
- datasets.py
- exploratory.py
- logging.py
- py.typed
- - postgres_conf.py
- - arrays_df.parquet
  - fake_1000_from_splink_demos.csv
  - fake_1000_from_splink_demos_strip_datetypes.parquet
  - known_params_comparison_vectors.csv
  - splink2_479_vs_481.csv
  - splink2_m_u_history_fixed_u.csv
  - splink2_m_u_history_no_fix.csv
  - splink2_proportion_of_matches_history_fixed_u.csv
  - splink2_proportion_of_matches_history_no_fix.csv
  - test_array.parquet
- __init__.py
- basic_settings.py
- cc_testing_utils.py
- conftest.py
- decorator.py
- helpers.py
- literal_utils.py
- test_accuracy.py
- test_analyse_blocking.py
- test_array_based_blocking.py
- test_array_columns.py
- test_blocking.py
- test_blocking_rule_composition.py
- test_caching.py
- test_cc_random_graphs.py
- test_charts.py
- test_chunking.py
- test_cluster_at_multiple_thresholds.py
- test_cluster_studio.py
- test_cluster_using_single_best_links.py
- test_clustering.py
- test_column_expression.py
- test_columns_selected.py
- test_columns_used.py
- test_compare_splink2.py
- test_comparison_level.py
- test_comparison_level_composition.py
- test_comparison_level_lib.py
- test_comparison_lib.py
- test_comparison_template_lib.py
- test_comparison_viewer_dashboard.py
- test_completeness.py
- test_compound_comparison_levels.py
- test_correctness_of_convergence.py
- test_dataframe_in_out_formats.py
- test_date_levels_and_comparisons.py
- test_debug_mode.py
- test_disable_tf_exact_match_detection.py
- test_em_max_pairs.py
- test_estimate_prob_two_rr_match.py
- test_expectation_maximisation.py
- test_extreme_match_weights.py
- test_full_example_deterministic_link.py
- test_full_example_duckdb.py
- test_full_example_postgres.py
- test_full_example_spark.py
- test_full_example_sqlite.py
- test_graph_metrics.py
- test_input_column.py
- test_join_type_for_estimate_u_and_predict_are_efficient.py
- test_km_distance_level.py
- test_lat_long_distance.py
- test_linker_variants.py
- test_m_train.py
- test_new_comparison_levels.py
- test_new_db_api.py
- test_postgres_udfs.py
- test_predict_between.py
- test_predict_within.py
- test_profile_data.py
- test_realtime.py
- test_regex_param.py
- test_score_missing_edges.py
- test_score_pairs.py
- test_settings_options.py
- test_settings_validation.py
- test_spark_udfs.py
- test_splink_datasets.py
- test_sql_transform.py
- test_term_frequencies.py
- test_testing_fns.py
- test_total_comparison_count.py
- test_train_vs_predict.py
- test_u_train.py
- utils.py
.dockerignore
.gitignore
CHANGELOG.md
CONTRIBUTING.md
LICENSE
Makefile
mkdocs.yml
pyproject.toml
README.md
uv.lock

# Installation Guide

1. Get the code

git clone https://github.com/moj-analytical-services/splink

Downloads the entire project code from GitHub to your computer.

cd splink

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install splink

Installs the package published on PyPI directly — no need to clone the source.

pip install 'splink[{backend}]'

Installs the package published on PyPI directly — no need to clone the source.

pip install 'splink[spark]'

Installs the package published on PyPI directly — no need to clone the source.

pip install 'splink[postgres]'

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

docker compose -f scripts/postgres_docker/docker-compose.yaml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install splink

Installs the package published on PyPI directly — no need to clone the source.

pip install 'splink[{backend}]'

Installs the package published on PyPI directly — no need to clone the source.

pip install 'splink[spark]'

Installs the package published on PyPI directly — no need to clone the source.

pip install 'splink[postgres]'

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

splink

File Explorer

# Installation Guide

2. Official Install Script

3. Docker

4. Python

5. Make

Today's picks

Was this content helpful?

Recent Feedback

splink

File Explorer

# Installation Guide

2. Official Install Script

3. Docker

4. Python

5. Make

Today's picks

Was this content helpful?

Recent Feedback

Download README