remove mimic_utils readme and add instructions to README

Author: alistairewj

README.md

@@ -38,6 +38,37 @@ To start this deployment, click the Launch Stack button.  On the first screen, t
 
 [![cloudformation-launch-stack](/mimic-iii/buildmimic/aws-athena/cloudformation-launch-stack.png)](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=MIMIC&templateURL=https://aws-bigdata-blog.s3.amazonaws.com/artifacts/biomedical-informatics-studies/mimic-iii-athena.yaml)
 
+## mimic_utils package
+
+This package contains utilities for working with the MIMIC datasets; primarily transpiling SQL code.
+
+### Installation
+
+```bash
+pip install -e ".[test]"
+```
+
+### Development
+
+The repository includes a locked dependency file (`requirements-lock.txt`) generated by `pip-compile` for reproducible builds on Python 3.9. To use it:
+
+```bash
+pip install -r requirements-lock.txt
+pip install -e . --no-deps
+```
+
+To update the lock file after changing dependencies in `pyproject.toml`:
+
+```bash
+pip-compile pyproject.toml --output-file requirements-lock.txt --all-extras --strip-extras --upgrade
+```
+
+### Running tests
+
+```bash
+pytest tests/
+```
+
 ## Other useful tools
 
 * [Bloatectomy](https://github.com/MIT-LCP/bloatectomy) ([paper](https://github.com/MIT-LCP/bloatectomy/blob/master/paper/paper.md)) - A python based package for removing duplicate text in clinical notes