moj-analytical-services / splink_demos

Structure - moj-analytical-services/splink_demos

The Jupyter Notebook tutorials in the splink_demos project are structured as a collection of Jupyter Notebook files, which are organized into subdirectories based on the topic they cover. The main directories in the project are:

  1. examples: This directory contains examples of how to use splink for various data linkage tasks. It is further divided into subdirectories for different databases, such as sqlite and duckdb. Each subdirectory contains a dashboards directory that holds the notebooks for that specific database.
  2. tutorials: This directory contains tutorials that guide users through the process of using splink for data linkage. The tutorials are designed to be self-contained and easy to follow, with step-by-step instructions and explanations.
  3. data: This directory contains sample datasets that are used in the examples and tutorials.
  4. docs: This directory contains documentation for the project, including installation instructions, a user guide, and API references.

Each Jupyter Notebook in the project follows a similar structure, consisting of markdown cells that provide explanations and code cells that contain executable Python code. The code cells are used to demonstrate the concepts discussed in the markdown cells, and users can modify and run the code to experiment with different configurations and parameters.

The splink_demos project also includes a Makefile that provides commands for building and testing the project. The Makefile includes targets for building the notebooks, running tests, and creating distribution packages.

Overall, the structure of the splink_demos project is designed to be modular and easy to navigate, with clear directories for each topic and well-organized Jupyter Notebook files. The project’s documentation and examples provide users with a clear and concise introduction to the splink library and its capabilities.

Sources: