easylink 0.2.0

Research repository for the EasyLink ER ecosystem project.

EasyLink is a framework that allows users to build and run highly configurable entity resolution (ER) pipelines.

Supported Python versions: 3.11, 3.12

Installation

NOTE: This package requires AMD64 CPU architecture - it is not compatible with Apple’s ARM64 architecture (e.g. M1 and newer Macs).

There are a few things to install in order to use this package:

• Set up Linux.

  Singularity (and thus EasyLink) requires Linux to run. If you are not already using Linux, you will need to set up a virtual machine; refer to the Singularity documentation for installing on Windows or Mac.

• Install Singularity.

  First check if you already have Singularity installed by running the command singularity --version. For an existing installation, your Singularity version number is printed.

  If Singularity is not yet installed, you will need to install it; refer to the Singularity docs for installing on Linux.

  Note that this requires administrator privileges; you may need to request installation from your system admin if you are working in a shared computing environment.

• Install conda.

  We recommend miniforge. You can check if you already have conda installed by running the command conda --version. For an existing installation, a version will be displayed.

• Create a conda environment with python and graphviz installed.

  $ conda create --name easylink -c conda-forge python=3.12 graphviz 'gcc<14' -y
  $ conda activate easylink

• Install easylink in the environment.

  Option 1 - Install from PyPI with pip:

  $ pip install easylink

  Option 2 - Build from source with pip:

  $ pip install git+https://github.com/ihmeuw/easylink.git

Documentation

You can view documentation at https://easylink.readthedocs.io/en/latest/