Home

Feature branches

Each feature branch should have: - branch name (short, descriptive, unique) - description of the feature - person responsible for managing the feature Discuss in Slack #abc before adding a new feature

Feature development is tracked in https://github.com/HIIT/abcpy/projects

output_persistence

• develop the ability to persist generated data (eg. simulated data) to a database and retrieve it from there when appropriate
• RP: Jarno, Antti

async_wait

• develop the ability to add asynchronous .compute() calls to dask if necessary, use BOLFI as an example implementation
• RP: Jarno

bolfi

• have a working version of the Bolfi inference algorithm
• RP: Antti

test_fw

• develop initial test framework
• RP: Kusti

documentation_fw

• develop initial documentation functionality
• RP: Kusti

smc_abc

• develop SMC ABC inference method
• RP: Henri

rejection_sampling

• develop rejection sampling ABC inference method
• RP: Henri

posterior_model

• develop the basic abstract model for representing the posterior that .infer() method returns, with at least one concrete implementation
• RP: Antti

prior_model

• develop the basic abstract model for representing the prior that .infer() method uses, with at least one concrete implementation
• RP: Henri

reporting

• develop basic reporting functions for debugging the inference process and printing out the prior, ABC samples, (likelihood) and posterior
• RP: Antti

slurm

• develop a way to practically execute jobs, defined as .py script files, distributed in a slurm environment with user-defined SBATCH parameters
• RP: Antti

scipy_dist

• develop a way to use scipy distributions for nodes
• RP: Henri

node_change

• develop a way to change the class of node while at the same time keeping existing references valid
• RP: Henri

acq_api

• develop a intuitive user interface for composing acquisition functions for BO methods
• RP: Kusti

Development guidelines

Adding a new feature

• Discuss if feature should be added (in Slack #abc)
• If there are people supporting the idea, create a feature branch to main repo (from dev branch)
• Add feature data to list of feature branches

Contributing to an existing feature

• Pick a feature to work on
• Fork the main repository, checkout your version of the feature branch
• Develop code
• Push commits to your fork
• Make a pull request from your repo feature branch to main repo feature branch
• Wait until PR accepted; make changes if needed

Making a small change / bugfix (smaller than a feature)

• Fork the main repository, checkout dev branch
• Develop code
• Push commits to your fork
• Make a pull request from your repo dev branch to main repo dev branch
• Wait until PR accepted; make changes if needed

Merging a feature

• When feature is ready, announce this in Slack #abc
• Make a pull request from main repo feature branch to main repo dev branch
• Wait until PR accepted by majority vote of core developers; make changes if needed

Making a release

• When all features for release are ready, announce this in Slack #abc
• Make a pull request from main repo dev branch to main repo master
• Wait until PR accepted by all core developers; make changes if needed
• Add release version tag to main repo master branch
• Publish new version to pypi