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.3.14.tar.gz (49.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.3.14-py3-none-win_amd64.whl (3.6 MB view details)

Uploaded Python 3Windows x86-64

cfasim-0.3.14-py3-none-musllinux_1_2_x86_64.whl (4.1 MB view details)

Uploaded Python 3musllinux: musl 1.2+ x86-64

cfasim-0.3.14-py3-none-musllinux_1_2_aarch64.whl (3.8 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

cfasim-0.3.14-py3-none-manylinux_2_28_aarch64.whl (3.7 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

cfasim-0.3.14-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

cfasim-0.3.14-py3-none-macosx_11_0_arm64.whl (3.8 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

cfasim-0.3.14-py3-none-macosx_10_12_x86_64.whl (3.9 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: cfasim-0.3.14.tar.gz
  • Upload date:
  • Size: 49.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.3.14.tar.gz
Algorithm Hash digest
SHA256 c718a293597c5bd319f0e705da2119d1fc25ff977def00e2064fd64842f0079d
MD5 4d392310ca77ec450e5d72109bc87fbd
BLAKE2b-256 96e4509c61e2150fe961e50e0b11ad2e870d3a5343a0a18116b024768e379888

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.3.14.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.3.14-py3-none-win_amd64.whl.

File metadata

  • Download URL: cfasim-0.3.14-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.6 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.3.14-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 7cb19e55f76c41425ad264fc6332a0376f7a250aec3c1c865b0358b7d27c36d5
MD5 67f527af5f7b3fe9220c97a2f995366a
BLAKE2b-256 0396bd89f1fae962c595987651a483633215620bf3ff1044d795ef1ac14212f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.3.14-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.3.14-py3-none-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for cfasim-0.3.14-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 abe3a17b6f9497561a2e8848657d41eb4be7ce9433d1b524b218ba7b5168114c
MD5 0a8759ea15425566e5148ddfd82165bc
BLAKE2b-256 be57ab2358eb9bc208efd3d5d8842d9bc06781fd6857ec3b6124e8c7c3dcb5e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.3.14-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.3.14-py3-none-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for cfasim-0.3.14-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 20e95cd1f9625bcb4e8755e09d5fb626349b50bbadab27027280ae4fbb123579
MD5 d2c7bcf302f8d1cc57d8def82c875f03
BLAKE2b-256 6496a09b3a94c2dc85fcab9333bbec43a3a7020d2d440822a9d1f902a8c4237f

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.3.14-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.3.14-py3-none-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for cfasim-0.3.14-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 b64dd4f577efad5f2b237e735a9e3dd40d432ca0cfcdf2c5637bb366e99b6c03
MD5 3cc7c4ff3a68f962778211b6e5739af4
BLAKE2b-256 de4a99301805dbcf499ce15c5ce68e29c6258734975b801897207106185bc6ed

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.3.14-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.3.14-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for cfasim-0.3.14-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 de454e8149808b15021244b0006d78e94e8aa80cd6834e54efa8075b7266ff4a
MD5 d9c42304cf752157daff838f91eef146
BLAKE2b-256 68e0ebe66b873fdeef23b249a80c3254822aa57cd1db4b69345859d6f55eeb8e

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.3.14-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.3.14-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for cfasim-0.3.14-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 945ffc94f1d9fff4f174822c78a6ef21e08bdec4036c28df78905bfd8487f548
MD5 e350ceccb89c47859f67e355aed6fbf4
BLAKE2b-256 d89ecedbbd2624cfd621365c279177c7d262872aee315390e4c2589f49bac6af

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.3.14-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.3.14-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for cfasim-0.3.14-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 93fc07ed97a328d34a41781c6cdd6d3533206df8a2b1ef8ad2dba90a2bf30515
MD5 876a024447c51e08c49e29d871501c12
BLAKE2b-256 e024af852488c0dd03c17788af3af2bdfafe8167a446dc7c11f9cb528cef4a33

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfasim-0.3.14-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