Skip to content

codeforamerica/cmr-entity-resolution

Repository files navigation

CMR Entity Resolution

An entity resolution solution for automated record clearance.

Dependencies

  • Docker or Docker Desktop with compose v2 enabled.

Creating and running an environment

Launching

This solution is provided as a docker compose file and can be launched locally by running the following command:

Note: If you would like to launch the webapp to search for entities using a web interface, you will need to add -p webapp to include the webapp profile.

docker compose up -d

The configuration uses a persistent volume for the database and message queue containers to ensure data is persisted through updates to the image or configuration.

Applying changes

In order to apply changes made to docker configurations, you will need to run the same command used for launching above. This will cause any containers that have changed to be recreated.

You can also apply changes to single container by adding it to the container. For example, to apply changes to the api container only you would run the following:

docker compose up -d api

Stopping and starting

The environment can be safely stopped and restarted without loss of data. Stopping, starting, and restarting does not apply pending changes. Use the command below with the appropriate subcommand for your desired action:

docker compose [stop|start|restart]

Terminating

To terminate the local environment you can run the following command:

Note: If you would like to keep the persistent volumes, omit the --volumes flag.

docker compose down --volumes

Importing & exporting

Data can be imported and exported using either the included CLI command or docker container. See Importing & Exporting for more information on how to get data in and out of Senzing.

Examples

See our collection of examples to see a demonstration of the system in action.

About

An entity resolution solution for automated record clearance.

Resources

License

Stars

Watchers

Forks

Releases

No releases published