popsim-consortium / popsim-consortium/stdpopsim

Add --years option to CLI

Open
#75 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
144
Forks
100
Avg merge
2h 44m
Merged PRs (30d)
2

Description

Add an option to the CLI to rescale time into years in the output tree sequence using the scaling factors given in #73 and #74.

This is probably easiest done by dumping the tables and multiplying all the times by this factor.

If this option is used, there should be a reference printed out saying where the generation_time estimate came from and encouraging users to cite it.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading issues #73 and #74 for the scaling factors, then locate the CLI entry point and the output tree-sequence table handling. Verify that --years scales all relevant times and that using it prints a generation_time reference with citation guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.