about summary refs log tree commit diff
path: root/README.md
AgeCommit message (Collapse)Author
6 daysClarify that the test suite is not for end users. HEAD mainArun Isaac
End users who install pyhegp via pip cannot run the test suite. Clarify this in the README. Perhaps, in the future, we should move these developer-oriented instructions to a separate document.
6 daysSeparate table of contents from introduction.Arun Isaac
If not separated, GitHub combines the table of contents with the list of papers in the introduction.
6 daysAdd table of contents to README.Arun Isaac
A table of contents gives people a brief overview of what's in the README, and allows them to jump to the section they are interested in.
6 daysReplace csv extension with tsv extension on genotype files.Arun Isaac
6 daysRemove txt extension from summary files.Arun Isaac
6 daysLink to file formats documentation from README.Arun Isaac
Readers are more likely to follow through to the file formats documentation if there is a link.
6 daysAdd instructions to install via Guix.Arun Isaac
6 daysMark virtual environment creation as optional.Arun Isaac
Not everyone may want to create a virtual environment. For example, on some HPC machines, creating a virtual environment is complicated or does not work.
7 daysAdd simple workflow.Arun Isaac
* README.md (How to use): Indent down into "Joint/federated analysis with many data owners" section. [Simple data sharing]: New section. * doc/generate-images.sh: Add simple workflow. * doc/workflow.png: Rename to doc/joint-workflow.png. * doc/workflow.uml: Rename to doc/joint-workflow.uml. * doc/simple-workflow.png, doc/simple-workflow.uml: New files. * tests/test_pyhegp.py: Import pytest. (test_simple_workflow): New test. * test-data/genotype.tsv: New file.
13 daysMention TianjingZhao2023 paper in README.Arun Isaac
* README.md: Mention TianjingZhao2023 paper.
2025-07-18Add CI badge to README.Arun Isaac
* README.md: Add CI badge.
2025-07-17Document usage instructions and workflow.Arun Isaac
* doc/workflow.uml, doc/workflow.png, doc/generate-images.sh: New files. * README.md (How to use): New section.
2025-07-17Add development version installation instructions.Arun Isaac
* README.md (Install development version): New section.
2025-07-07Add tests.Arun Isaac
* test_pyhegp.py: New file. * README.md (Run tests): New section. * guix.scm: Import python-hypothesis from (gnu packages check). (python-pyhegp)[arguments]: Enable tests. [native-inputs]: Add python-hypothesis.
2025-06-27README: Add missing preposition "in".Arun Isaac
* README.md: Add missing preposition "in".
2025-06-27Initial commitArun Isaac