easylink 0.1.24__tar.gz → 0.2.0__tar.gz

{easylink-0.1.24 → easylink-0.2.0}/.gitignore

@@ -149,3 +149,5 @@ src/easylink/_version.py
 .specifications/
 .snakemake/
 */copilot-instructions.md
+
+results/

{easylink-0.1.24 → easylink-0.2.0}/CHANGELOG.rst

@@ -1,3 +1,13 @@
+**0.2.0 - 6/30/25**
+
+ - Official demo release
+ - Add progress dots to terminal output
+
+**0.1.25 - 6/30/25**
+
+ - Release new images
+ - Clean up stdout logging
+
 **0.1.24 - 6/26/25**
 
  - Properly escape special characters in envars specified via pipeline configuration

{easylink-0.1.24 → easylink-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: easylink
-Version: 0.1.24
+Version: 0.2.0
 Summary: Research repository for the EasyLink ER ecosystem project.
 Home-page: https://github.com/ihmeuw/easylink
 Author: The EasyLink developers
@@ -78,34 +78,50 @@ Installation
 
 .. _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:
 
-- Install singularity. 
+- 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 <https://docs.sylabs.io/guides/4.1/admin-guide/installation.html#installation-on-windows-or-mac>`_. 
 
-  You may need to request it from your system admin. 
-  Refer to https://docs.sylabs.io/guides/4.1/admin-guide/installation.html.
-  You can check if you already have singularity installed by running the command
-  ``singularity --version``. For an existing installation, your singularity version
+- 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 <https://docs.sylabs.io/guides/4.1/admin-guide/installation.html#installation-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 <https://github.com/conda-forge/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.
 
-- Install easylink, python and graphviz in a conda environment.
+- 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::
 
-    $ conda create --name easylink -c conda-forge python=3.12 graphviz 'gcc<14' -y
-    $ conda activate easylink
     $ pip install easylink
 
   Option 2 - Build from source with pip::
     
-    $ conda create --name easylink -c conda-forge python=3.12 graphviz 'gcc<14' -y
-    $ conda activate easylink
     $ pip install git+https://github.com/ihmeuw/easylink.git
 
 .. _end_installation:

easylink-0.2.0/README.rst

@@ -0,0 +1,70 @@
+========
+EasyLink
+========
+
+EasyLink is a framework that allows users to build and run highly configurable
+entity resolution (ER) pipelines.
+
+.. _python_support:
+
+**Supported Python versions: 3.11, 3.12**
+
+.. _end_python_support:
+
+Installation
+============
+
+.. _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 <https://docs.sylabs.io/guides/4.1/admin-guide/installation.html#installation-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 <https://docs.sylabs.io/guides/4.1/admin-guide/installation.html#installation-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 <https://github.com/conda-forge/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
+
+.. _end_installation:
+
+Documentation
+=============
+
+You can view documentation at https://easylink.readthedocs.io/en/latest/

{easylink-0.1.24 → easylink-0.2.0}/docs/source/concepts/pipeline_schema/index.rst

@@ -623,6 +623,8 @@ This step :ref:`has sub-steps <entity_resolution_sub_steps>`, which may be expan
   and similar incremental methods, the already-found clusters would be used directly
   and updated with new decisions about not-yet-clustered records.
 
+.. _canonicalizing:
+
 Canonicalizing and downstream analysis
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

{easylink-0.1.24 → easylink-0.2.0}/docs/source/user_guide/index.rst

@@ -5,10 +5,6 @@ User Guide
 ==========
 Here we cover several core conceptual topics related using EasyLink.
 
-.. todo::
-
-   Everything
-
 .. toctree::
    :maxdepth: 2
    :glob: