leapfrog-py

Installation

pip install leapfrog-py

Usage

Get parameters

In the following example you will need parameters - inputs to the model. We have provided utilities to easily get test parameters (we use hdf5 file format to store these). If you already have different parameters in the correct shape you can skip this section.

from leapfrog_py import read_h5_file

parameters_adult = read_h5_file(
    "../leapfrogr/tests/testthat/testdata/adult_parms_full.h5"
)
parameters_child = read_h5_file(
    "../leapfrogr/tests/testthat/testdata/child_parms_full.h5"
)

Run model

Here are a couple of ways to run the model

from leapfrog_py import run_model

# Default configuration is HivFullAgeStratification and output_years is range(1970, 2031)
run_model(parameters_adult)

# Can give another configuration but make sure the parameters match it
run_model(parameters_child, "ChildModel")

# Can specify which years to output from the model
run_model(parameters_child, "ChildModel", [1970, 1971, 2000])

Run model from initial state

You can also run the model from an initial state. For example, to run the model in two parts

from leapfrog_py import run_model, run_model_from_state, get_time_slice

# Run model until year 2000
ret = run_model(parameters_adult, "HivFullAgeStratification", range(1970, 2001))

run_model_from_state(
    # parameters
    parameters_adult,
    # configuration
    "HivFullAgeStratification",
    # get the last time slice of the state returned by run model so we
    # can continue from where the model left off
    get_time_slice(ret, 30),
    # simulation start year, this should be the year the previous
    # argument represents
    2000,
    # years you want the model to output
    range(2001, 2031),
)

Run model for a single year

The previous two functions will return a dictionary with values that are have one more dimension (time dimension) than the state specified in the model config. This means if you want to carry on from that initial single year state you would have to use the get_time_slice utility at index 1. Example:

from leapfrog_py import run_model, run_model_from_state, get_time_slice

ret_single_year = run_model(parameters_adult, "HivFullAgeStratification", [1970])

for year in range(1970, 2031):
    ret_single_year = run_model_from_state(
        parameters_adult,
        "HivFullAgeStratification",
        get_time_slice(ret_single_year, 0),
        year,
        [year + 1],
    )

This is tedious for two reasons:

Repeatedly getting the time slice for one time dimension (initial one is unavoidable since we use run model and don't have any initial state)
Specifying output year as year + 1

So to make projecting for a single year more ergonomic we decided to create a separate function that returns the time slice for a single year:

from leapfrog_py import run_model, run_model_single_year, get_time_slice

ret_single_year = get_time_slice(
    run_model(parameters_adult, "HivFullAgeStratification", [1970]), 0
)

for year in range(1970, 2031):
    ret_single_year = run_model_single_year(
        parameters_adult, "HivFullAgeStratification", ret_single_year, year
    )

Development

This project uses scikit-build-core with nanobind to build the C++ project. You'll need a recent version of CMake (>3.15) and Python (>3.7).

We use uv to manage the project:

Sync the virtual env uv sync
Run tests uv run pytest
Lint uvx ruff check .
Format uvx ruff format
Format imports uvx ruff check --select I --fix

uv will rebuild automatically if you make a change to the C++ code however if you need to force recompilation use --reinstall-package leapfrog-py.

For local installation run pip install .

License

leapfrog-py is distributed under the terms of MIT license.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

leapfrog_py-1.0.15.tar.gz (21.7 kB view details)

Uploaded Aug 21, 2026 Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

leapfrog_py-1.0.15-cp314-cp314t-win_amd64.whl (170.6 kB view details)

Uploaded Aug 21, 2026 CPython 3.14tWindows x86-64

leapfrog_py-1.0.15-cp314-cp314t-win32.whl (150.2 kB view details)

Uploaded Aug 21, 2026 CPython 3.14tWindows x86

leapfrog_py-1.0.15-cp314-cp314t-musllinux_1_2_x86_64.whl (659.4 kB view details)

Uploaded Aug 21, 2026 CPython 3.14tmusllinux: musl 1.2+ x86-64

leapfrog_py-1.0.15-cp314-cp314t-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (210.6 kB view details)

Uploaded Aug 21, 2026 CPython 3.14tmanylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

leapfrog_py-1.0.15-cp314-cp314t-macosx_11_0_arm64.whl (240.7 kB view details)

Uploaded Aug 21, 2026 CPython 3.14tmacOS 11.0+ ARM64

leapfrog_py-1.0.15-cp314-cp314t-macosx_10_15_x86_64.whl (232.7 kB view details)

Uploaded Aug 21, 2026 CPython 3.14tmacOS 10.15+ x86-64

leapfrog_py-1.0.15-cp314-cp314-win_amd64.whl (167.6 kB view details)

Uploaded Aug 21, 2026 CPython 3.14Windows x86-64

leapfrog_py-1.0.15-cp314-cp314-win32.whl (148.6 kB view details)

Uploaded Aug 21, 2026 CPython 3.14Windows x86

leapfrog_py-1.0.15-cp314-cp314-musllinux_1_2_x86_64.whl (657.0 kB view details)

Uploaded Aug 21, 2026 CPython 3.14musllinux: musl 1.2+ x86-64

leapfrog_py-1.0.15-cp314-cp314-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (208.2 kB view details)

Uploaded Aug 21, 2026 CPython 3.14manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

leapfrog_py-1.0.15-cp314-cp314-macosx_11_0_arm64.whl (238.5 kB view details)

Uploaded Aug 21, 2026 CPython 3.14macOS 11.0+ ARM64

leapfrog_py-1.0.15-cp314-cp314-macosx_10_15_x86_64.whl (230.8 kB view details)

Uploaded Aug 21, 2026 CPython 3.14macOS 10.15+ x86-64

leapfrog_py-1.0.15-cp313-cp313-win_amd64.whl (162.0 kB view details)

Uploaded Aug 21, 2026 CPython 3.13Windows x86-64

leapfrog_py-1.0.15-cp313-cp313-win32.whl (144.2 kB view details)

Uploaded Aug 21, 2026 CPython 3.13Windows x86

leapfrog_py-1.0.15-cp313-cp313-musllinux_1_2_x86_64.whl (656.9 kB view details)

Uploaded Aug 21, 2026 CPython 3.13musllinux: musl 1.2+ x86-64

leapfrog_py-1.0.15-cp313-cp313-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (208.2 kB view details)

Uploaded Aug 21, 2026 CPython 3.13manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

leapfrog_py-1.0.15-cp313-cp313-macosx_11_0_arm64.whl (238.5 kB view details)

Uploaded Aug 21, 2026 CPython 3.13macOS 11.0+ ARM64

leapfrog_py-1.0.15-cp313-cp313-macosx_10_14_x86_64.whl (230.6 kB view details)

Uploaded Aug 21, 2026 CPython 3.13macOS 10.14+ x86-64

leapfrog_py-1.0.15-cp312-cp312-win_amd64.whl (162.1 kB view details)

Uploaded Aug 21, 2026 CPython 3.12Windows x86-64

leapfrog_py-1.0.15-cp312-cp312-win32.whl (144.2 kB view details)

Uploaded Aug 21, 2026 CPython 3.12Windows x86

leapfrog_py-1.0.15-cp312-cp312-musllinux_1_2_x86_64.whl (656.9 kB view details)

Uploaded Aug 21, 2026 CPython 3.12musllinux: musl 1.2+ x86-64

leapfrog_py-1.0.15-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (208.2 kB view details)

Uploaded Aug 21, 2026 CPython 3.12manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

leapfrog_py-1.0.15-cp312-cp312-macosx_11_0_arm64.whl (238.5 kB view details)

Uploaded Aug 21, 2026 CPython 3.12macOS 11.0+ ARM64

leapfrog_py-1.0.15-cp312-cp312-macosx_10_14_x86_64.whl (230.6 kB view details)

Uploaded Aug 21, 2026 CPython 3.12macOS 10.14+ x86-64

leapfrog_py-1.0.15-cp311-cp311-win_amd64.whl (162.6 kB view details)

Uploaded Aug 21, 2026 CPython 3.11Windows x86-64

leapfrog_py-1.0.15-cp311-cp311-win32.whl (144.4 kB view details)

Uploaded Aug 21, 2026 CPython 3.11Windows x86

leapfrog_py-1.0.15-cp311-cp311-musllinux_1_2_x86_64.whl (657.9 kB view details)

Uploaded Aug 21, 2026 CPython 3.11musllinux: musl 1.2+ x86-64

leapfrog_py-1.0.15-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (209.3 kB view details)

Uploaded Aug 21, 2026 CPython 3.11manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

leapfrog_py-1.0.15-cp311-cp311-macosx_11_0_arm64.whl (239.4 kB view details)

Uploaded Aug 21, 2026 CPython 3.11macOS 11.0+ ARM64

leapfrog_py-1.0.15-cp311-cp311-macosx_10_14_x86_64.whl (231.2 kB view details)

Uploaded Aug 21, 2026 CPython 3.11macOS 10.14+ x86-64

File details

Details for the file leapfrog_py-1.0.15.tar.gz.

File metadata

Download URL: leapfrog_py-1.0.15.tar.gz
Upload date: Aug 21, 2026
Size: 21.7 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for leapfrog_py-1.0.15.tar.gz
Algorithm	Hash digest
SHA256	`f66fcdffc354a2b84fba09e419c6f1689ceef03641fb3508164aaaba8592507c`
MD5	`15d51a08e56f821aa1d44ee4faf2ecdc`
BLAKE2b-256	`689e6cdcaa80b2c5b568b81eb2c5a3a6d744b3a1a7f948db95047ac30ea3e2d9`

Algorithm	Hash digest
SHA256	`43b6d3ac405ce0ee896e0c245e47f9e8ae283efa632a1c22cef2a008a598a8de`
MD5	`75b885845a9b4a9bf8f8679f77ceccd2`
BLAKE2b-256	`df0e47c63915da237561d3b10556c210f100fc8203ed878a1373940bd700c277`

Algorithm	Hash digest
SHA256	`b6ab0d77dbabec958190531638d7f354102de0a4a0c09f5eefa1cf5a6d8047cc`
MD5	`6d7b40ecb6115adb40ddd27cea600ffa`
BLAKE2b-256	`a3aa0acbefbd0ebfa98aa26b20685b32393fe584a0e702e026bec502acd75256`

Algorithm	Hash digest
SHA256	`3f9a7598ef95fcb0bb8565d411b5aa5b76a1da81e98745200be60c42c7687505`
MD5	`3278fd06bfdda791f7b301b36fb537e2`
BLAKE2b-256	`f4be1829c0e0141e8266bcb772af3979bd47de61f931233487fe6140fae4b875`

Algorithm	Hash digest
SHA256	`536dc48a13b7435fc37874c7c01953bef9a0a6ab752fb886313eada8051773aa`
MD5	`5c1f27aab64d0973e59f0e058a447e9c`
BLAKE2b-256	`02e8f7b816f9e85700e12fb70ffd57819530984dff700b1bed6511571c5c8d8b`

Algorithm	Hash digest
SHA256	`db02a9fc4b27e08ae24b3d47cc24514dc036af208a552ed86ff400f3e12bed0f`
MD5	`1bbfcde60ec5f480bd45da21935cbec7`
BLAKE2b-256	`bddfed3c5904cc23301e486c9e30565f1ca13bd57e1bd9a6ca597ae9fcdb0b54`

Algorithm	Hash digest
SHA256	`a59e7d53789e14771ce6de640de85a969b8342ff4d647d26a1ec75a01626eb78`
MD5	`818d4dfa351ccb236bba3af8579da22d`
BLAKE2b-256	`241cca34b691a6da160aa9a8886ec37e48bf83a1e61c109264e2940e3942bde2`

Algorithm	Hash digest
SHA256	`d01a34b30a85744502e5f5edb441d90a6cc072ad25da104c8224505831160719`
MD5	`fba2855a3e239cfe2e6f5561979eeb44`
BLAKE2b-256	`b486ff90f7bb1af27c31dc3316ac1adc743ad22d326441ef5ed9f38e0e0b51e7`

Algorithm	Hash digest
SHA256	`5cd314199628636011b918e1dd8b5996c55ab6b96e747766d893a3a83672cc51`
MD5	`b1f1505c3506fff2ed8fe7096b024f33`
BLAKE2b-256	`a416f2e172f130af888dc8ac6d95c3785b466429d07a6738edf021a056af9d6b`

Algorithm	Hash digest
SHA256	`874180eaccf84e683b68c5efd380c8063fdc5c4b1040d2520ecf3d09965ac107`
MD5	`dbd0305b931cb9bf72e1bbb9ae944a42`
BLAKE2b-256	`cdafe411f977de38c01cad6404ff7c420b93a5e5f4d7ce48f56692b750fd5854`

Algorithm	Hash digest
SHA256	`070eceb1b5492895ea9f79c694f3977237e1afc6d8683e92d21d17396f9b381f`
MD5	`5c4766dfaeda75c823441eed42f322a9`
BLAKE2b-256	`10027a8fd6243177d07ce6919a7566a8b5c558dff246f14f3c9fd2304c25e9f4`

Algorithm	Hash digest
SHA256	`19a476ab146f611b77aff282188818f1b1ad5191cf90ce342205a2675f2a5dab`
MD5	`aa409494491bbc39dd37d6df747a3831`
BLAKE2b-256	`c7dfa07b4d1400002b8e0d16eb4d8b19ba8e9f45bbfc254ec90ba28b223b2e1f`

Algorithm	Hash digest
SHA256	`856457c459669a6ac99a64cdf783f972b7de1133ba67a9d8814394a26e366d0b`
MD5	`18cdb43bd7e2ac37c3296f4d64543ffe`
BLAKE2b-256	`a5c20f9c9ab3436eb00edb32285163caf145b73f6463b7d211f15d05af1de5d4`

Algorithm	Hash digest
SHA256	`590bc30c6ab3f5b36fadfefe25e3bf2e49fd0694446902006b1d67a0c5ab0d95`
MD5	`90e6598aa4e5261267ba5a32b651f457`
BLAKE2b-256	`5dac7cf649de4ba341505871a768b73c2e87ceb61784a0b4311e39e17794d0b1`

Algorithm	Hash digest
SHA256	`634f39462d7f81eeb21d14235b1fed8b0832b4c57fc4161acad902422e2e872b`
MD5	`6b86b23c4d4b89865a4bf5e343471701`
BLAKE2b-256	`e89c572f957fe6e08402da47e36b5d500c9d9feae07d005a8b9e5e6d76ecdae9`

Algorithm	Hash digest
SHA256	`bd6e670248c3de9ddcc2fbf3cbcbc43214ee8f8fd9605a539b7682289ebdadd5`
MD5	`0d42b6fbf69d90a25e0a4558a7d89cdd`
BLAKE2b-256	`9162d0a0ca355723e657d1c3f3ab29d0dfebf24f636f22e6dc76e20288f4b71c`

Algorithm	Hash digest
SHA256	`872ac867c657ca8ca4b9bf2d78a66c1c695527fd86e4591b2e114dd66843386e`
MD5	`2a5dcf83f188680122e21ae70c0b79fe`
BLAKE2b-256	`ea9068ea388829ee59e89d55578149f73eb8e7c18971ee162bce397a5d4f1c6f`

Algorithm	Hash digest
SHA256	`794bfff382b00f29fef61d7109081dbd66e74e6d5b44d23c47a15a58d5f75f62`
MD5	`bea8d4ec0aaab58933143b651d11bf8a`
BLAKE2b-256	`0e34acafbf478e5090021d8947c454f453b5dc2cccc8e0eb6f2436b324567432`

Algorithm	Hash digest
SHA256	`1a01bef739a391435e879d463be911e4604f60ddfc257e3b37353d27f30fdf3a`
MD5	`0fcf3af97d4c55dcbf039bfdd18e9f29`
BLAKE2b-256	`e5970d4d46a0349fd3e7105713e016961e1d6ed01f93a833619bd374d25762ca`

Algorithm	Hash digest
SHA256	`d769480ae902be47a2f680dd898e48996e7fe6412805e8c8550125dd91a38def`
MD5	`a68a33045fd2f7ddfb86dd217d21e67b`
BLAKE2b-256	`a03832deb7e895c939e61f8630e71f278afb2ef8a370f331dd99ffc32428a1a1`

Algorithm	Hash digest
SHA256	`c1af799dcdd3720dbd5310ef449dceb28b99ccfdbd92a14eda66cf3844c35ee8`
MD5	`502913697974df2e6702696bee1263cd`
BLAKE2b-256	`a9c291328c2b19bb2075e2165cf2cd848a09d6f5edc3c79a3fa89404d0d813d0`

leapfrog-py 1.0.15

leapfrog-py

Installation

Usage

Get parameters

Run model

Run model from initial state

Run model for a single year

Development

License

Project links

Key dates

1 maintainer

Credits

GitHub Statistics

Requires

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

Algorithm	Hash digest
SHA256	`4a1a1b9d9514557405d05a66435c30c3ea4c381ff4332cd497124f3787817412`
MD5	`27b49346a7752d6b764083e0af7f243e`
BLAKE2b-256	`ef6bd182a2d6eb7d5a431b716ecde7dd6b836ea8e6dd5e7f0edc928b9b8b123a`

Algorithm	Hash digest
SHA256	`55be81bb326697e7dcb972cf136e54ccc4954c518a44c21c2ed2982ba1faf7e5`
MD5	`e486be1c259684025c90d7418e7a433e`
BLAKE2b-256	`fe9f3a7195b830345bde280165785b7711d7cb8dd172c45d52111383a17a4663`

Algorithm	Hash digest
SHA256	`c15d411885efb2c18e76cb6d71c9b0b5df390fe6e85b69db3c94290e99da9d81`
MD5	`db5432cec84cdd1b8fb11ab91de5d4eb`
BLAKE2b-256	`1059ca208e0c97aede826d8f1ed4c604b150869c9ad265b0ea0dfbb58e1fd7cb`

Algorithm	Hash digest
SHA256	`96a353dbd92c09fe9479a23ea2965923aa6dd05c482bc78eed254f5b60333dae`
MD5	`91c5baaa6299b4262d2181d6f40dba77`
BLAKE2b-256	`e715f6376cec1cd95e2ee0a72005d477d8e927632d9c39246d37d4cf43ea653d`

Algorithm	Hash digest
SHA256	`23b5682a99cba611d82e977e80f96e3e8a05be524f261727e8defdf51d1fcd20`
MD5	`5f18b7c103d96261b445b23e9b851cbc`
BLAKE2b-256	`a1b1ff16b714344d258726e4a8bd2bc61509290d9703af2fb9d713eb34d94f16`

Algorithm	Hash digest
SHA256	`a2976ea4f0c2620be7899fce29f077b3fa72c808c344d0f652bce16549a00f01`
MD5	`043c0625a751a8c15ac5c11dbdfac45b`
BLAKE2b-256	`bf03bd8182cc63f1001abcef6664ef555374219cea0b5f410b63280b40fa689b`

Algorithm	Hash digest
SHA256	`23fcbf53fd50e8bb81d5b0074490e7b3482e3fce8cc50925f172ef0d8d9cbe2c`
MD5	`a817c01be56fdb1e50549d2bfd7c8ed9`
BLAKE2b-256	`d24479a158cdbd5630fa6c2d11540236e555adc24905c4314eaa14e1d8cc99d7`

Algorithm	Hash digest
SHA256	`31a83b8df57e406d93d51c3f547f13d8b1cfade08f88cc9605cb4fcd3f3422b8`
MD5	`72025bfdda902d53f568b121994b6972`
BLAKE2b-256	`7b65eb219d1779419cf6034dce250fb1fc831687e650adfb981db2d81fd069af`

Algorithm	Hash digest
SHA256	`b5f103b8b4791113d741fa8b9e492d6ec1ddcc326e29038f36d5932dc7f6c927`
MD5	`4cb8c8159abe861a1a849679363b78d4`
BLAKE2b-256	`0594867ba66a3d056ab59bdce77aed64a27b0521f7f14bd0d80aef0693658ba1`

Algorithm	Hash digest
SHA256	`743c8ee540925f053f1a01b25e1f34c1595be5e4d62a710d6c9a2f8784bbf314`
MD5	`10647a2cbb1716dd2b9ff39489b7f2fe`
BLAKE2b-256	`8062bc1e83073fee8f0d04d094e14ad702094a12c27d7a10df474550d221589f`