Skip to main content

CLI for scaffolding interactive simulations using Python, Rust, and WebAssembly

Project description

cfa-simulator

Overview

This repository contains utilities for deploying interactive simulations using Python, Rust, and WebAssembly. It is still in the early stages of development so consider packages and APIs to be unstable.

Installing the cfasim CLI

# Shell (macOS / Linux)
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/CDCgov/cfa-simulator/releases/latest/download/cfasim-installer.sh | sh

# PowerShell (Windows)
powershell -ExecutionPolicy Bypass -c "irm https://github.com/CDCgov/cfa-simulator/releases/latest/download/cfasim-installer.ps1 | iex"

# uvx (ephemeral — no install)
uvx cfasim init

# cargo
cargo install cfasim

Binaries installed via the shell/PowerShell installer can self-update with cfasim update. Copies installed via cargo or uvx are managed by those tools — update them with cargo install cfasim --force or uv tool upgrade cfasim instead.

To opt into a once-per-week "new version available" hint, create ~/.cfasim/settings.toml with check_for_updates = true.

Related documents

General disclaimer This repository was created for use by CDC programs to collaborate on public health related projects in support of the CDC mission. GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise.

Public Domain Standard Notice

This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.

License Standard Notice

The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.

This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.

This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.

You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html

The source code forked from other open source projects will inherit its license.

Privacy Standard Notice

This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/other/privacy.html.

Contributing Standard Notice

Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.

All comments, messages, pull requests, and other submissions received through CDC including this GitHub page may be subject to applicable federal law, including but not limited to the Federal Records Act, and may be archived. Learn more at http://www.cdc.gov/other/privacy.html.

Records Management Standard Notice

This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.

Additional Standard Notices

Please refer to CDC's Template Repository for more information about contributing to this repository, public domain notices and disclaimers, and code of conduct.

Project details


Download files

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

Source Distribution

cfasim-0.7.1.tar.gz (51.0 kB view details)

Uploaded Source

Built Distributions

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

cfasim-0.7.1-py3-none-win_amd64.whl (4.1 MB view details)

Uploaded Python 3Windows x86-64

cfasim-0.7.1-py3-none-musllinux_1_2_x86_64.whl (4.6 MB view details)

Uploaded Python 3musllinux: musl 1.2+ x86-64

cfasim-0.7.1-py3-none-musllinux_1_2_aarch64.whl (4.3 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

cfasim-0.7.1-py3-none-manylinux_2_28_aarch64.whl (4.2 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

cfasim-0.7.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.5 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

cfasim-0.7.1-py3-none-macosx_11_0_arm64.whl (4.2 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

cfasim-0.7.1-py3-none-macosx_10_12_x86_64.whl (4.4 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file cfasim-0.7.1.tar.gz.

File metadata

  • Download URL: cfasim-0.7.1.tar.gz
  • Upload date:
  • Size: 51.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cfasim-0.7.1.tar.gz
Algorithm Hash digest
SHA256 cb49a4f081ea57f80ff6ee31cd03bc64f1a16e150f90245f00507f38b658483a
MD5 5ea19f94366132557ceeac235b9592b4
BLAKE2b-256 bb1b6d88fb1238fc83927cd84f7bd6a7480ba413bfd0395a2f9bc258179da276

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.7.1.tar.gz:

Publisher: pypi-cli.yml on CDCgov/cfa-simulator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cfasim-0.7.1-py3-none-win_amd64.whl.

File metadata

  • Download URL: cfasim-0.7.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 4.1 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cfasim-0.7.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a91c4b4bc75c24b333ee3f58ce1ac8404b5f67040584ee291c59fc901776300a
MD5 368bdad1ece5cc2d715d364e6b3455f2
BLAKE2b-256 1d09e1a08e0485934e99e25c517206a796a24047e6ebd77a20bbc3850bce63f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.7.1-py3-none-win_amd64.whl:

Publisher: pypi-cli.yml on CDCgov/cfa-simulator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cfasim-0.7.1-py3-none-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for cfasim-0.7.1-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 b25af50868301aefd37d03540c15d700bdd8bc318d846ae8b55b35e4b7d55143
MD5 4222e8fed97d432fe9e604a12aeceed6
BLAKE2b-256 58ac6c31463868030446378bfc2f8e95d550715e6eef7c382e3dbe923605b314

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.7.1-py3-none-musllinux_1_2_x86_64.whl:

Publisher: pypi-cli.yml on CDCgov/cfa-simulator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cfasim-0.7.1-py3-none-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for cfasim-0.7.1-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 98ff6546a0a9069268fe988ea72ac66b03a653a25bd3b30925a1a0bc24b89b62
MD5 0ca4069bb6568b90a1fbd8fc499ecdcb
BLAKE2b-256 dc3f7784761dac4ca3816d480fc0bf821e48478094f425b0c35789dfd9fa13d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.7.1-py3-none-musllinux_1_2_aarch64.whl:

Publisher: pypi-cli.yml on CDCgov/cfa-simulator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cfasim-0.7.1-py3-none-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for cfasim-0.7.1-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 e6773bcc770ed7d76ab43f09a89d64b4427cf6bf9cffdb2c064d524bbff642d9
MD5 0445b03e40f9d7b0f35a79ba304220f9
BLAKE2b-256 197427850a901a239b07bd0858af2725f7812509c824b4e654b28b387afabe6e

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.7.1-py3-none-manylinux_2_28_aarch64.whl:

Publisher: pypi-cli.yml on CDCgov/cfa-simulator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cfasim-0.7.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for cfasim-0.7.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b919082a544d4623bc0584688a43f53bfdb05acddf003822a53ea58f505d5b08
MD5 f699d1b625b63e27353ed31cf2709580
BLAKE2b-256 40022bd1ef62d573cda7c47f1f199b808f06422514ceb3ff2e8ebf023580d6fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.7.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: pypi-cli.yml on CDCgov/cfa-simulator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cfasim-0.7.1-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for cfasim-0.7.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 5f1b09aca056e19baf71a2bbdd748c683eb2e690475cbc8b5334c619cec54b19
MD5 ae1873a5bb7a89e82ca38dfaf208b790
BLAKE2b-256 bb1671a061773e64e97f65f1c11380bbe7c71721a589052aefe0049640e344fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.7.1-py3-none-macosx_11_0_arm64.whl:

Publisher: pypi-cli.yml on CDCgov/cfa-simulator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cfasim-0.7.1-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for cfasim-0.7.1-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d923c8916697cd6e2691d2a0ecd8af68e5c03ebdad8558f1030cdd284fc568a9
MD5 99f20105e228a56b665b6cf9e1376029
BLAKE2b-256 185d23b7a6dabf564852483033497df6717e12d58a3169441bdfb46a2ae18505

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.7.1-py3-none-macosx_10_12_x86_64.whl:

Publisher: pypi-cli.yml on CDCgov/cfa-simulator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page