diff --git a/README.md b/README.md index 7906e86..3ee3abc 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,18 @@ You can install the Ancestry Prediction tool using poetry. Make sure that you ha poetry add https://github.com/genxnetwork/flan/ ``` +## Getting Started + +1. Verify prerequisites: + - `python3 --version` (should be 3.9+) + - `poetry --version` +2. From repo root: + - `poetry install` + - `poetry shell` (activates the virtual environment; alternatively, prefix commands with `poetry run`) +3. Run a quick local workflow (ensure you're in the Poetry environment): + - `flan global fit` + - `flan global predict --file=path/to/your_sample.vcf.gz` (use a sample VCF file from the repo's data directory or your own genomic data in VCF format) + ## Usage To fit the model globally, use the following command: