Skip to content

docs: add Getting Started section to README for Python/Poetry setup and quick run commands #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kaddujames501-ship-it wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add Getting Started section to README for Python/Poetry setup and quick run commands #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
173556f
docs: add Getting Started section to README for Python/Poetry setup a…
Mar 22, 2026
2254549
Fix suggested changes
Mar 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down