From 173556f61f86d15cc5ae31aaa7b0716f7082d368 Mon Sep 17 00:00:00 2001 From: Hello Universe Date: Sun, 22 Mar 2026 23:47:01 +0300 Subject: [PATCH 1/2] docs: add Getting Started section to README for Python/Poetry setup and quick run commands --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 7906e86..8fedad5 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` (or use `poetry run` for each command) +3. Run a quick local workflow: + - `flan global fit` + - `flan global predict --file=path/to/your_sample.vcf.gz` + ## Usage To fit the model globally, use the following command: From 2254549eb34152005a344738160fd991019f0b59 Mon Sep 17 00:00:00 2001 From: Hello Universe Date: Sun, 22 Mar 2026 23:56:57 +0300 Subject: [PATCH 2/2] Fix suggested changes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8fedad5..3ee3abc 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,10 @@ poetry add https://github.com/genxnetwork/flan/ - `poetry --version` 2. From repo root: - `poetry install` - - `poetry shell` (or use `poetry run` for each command) -3. Run a quick local workflow: + - `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` + - `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