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.17.tar.gz (49.8 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.17-py3-none-win_amd64.whl (4.1 MB view details)

Uploaded Python 3Windows x86-64

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

Uploaded Python 3musllinux: musl 1.2+ x86-64

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

Uploaded Python 3musllinux: musl 1.2+ ARM64

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

Uploaded Python 3manylinux: glibc 2.28+ ARM64

cfasim-0.3.17-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

cfasim-0.3.17-py3-none-macosx_11_0_arm64.whl (4.3 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

cfasim-0.3.17-py3-none-macosx_10_12_x86_64.whl (4.5 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: cfasim-0.3.17.tar.gz
  • Upload date:
  • Size: 49.8 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.17.tar.gz
Algorithm Hash digest
SHA256 9c046ba55e9806c7ed780b6ff14cec45164066d2c8951aa82fc56d662a3e86c3
MD5 1f26556f8537eba7435fce26e234dfe4
BLAKE2b-256 3c982110707fbe246b34a585521ecce839a8dd8c978421f7d72501b16365e554

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: cfasim-0.3.17-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.3.17-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a60e3f9cd9a70850270c806cf8937de6c56639257a18fc772d4a2fe40f66478c
MD5 2b4664d34e060989ecaf8c5b9eeb6395
BLAKE2b-256 3445e375220d8483899aeb8aa89082b1ef4d9c4e8ad123568df47278f41db634

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.3.17-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 6c18be5588e49961c9fdf0ff660ab5459d729db8931082ba7e3a857eebc0e59e
MD5 e1a555ae42a1ddbd3f2713821891328d
BLAKE2b-256 4a50584f8028b3702ed26426960454ed8f772646feb512b7b48eb4ab73dfee0e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.3.17-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 26ebf81c27bfe30911b23e8877e50ff3b4fdf8f374eebe285a288ded5cbcac79
MD5 398c45735f8bb4dc332b983169374026
BLAKE2b-256 e58ef52486241fb3fd18b6de5309a8ae19d79c427ccbde8edbdd6400f9f1df4a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.3.17-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 1179a0e71f74ea72e6f4d5792686312f513b1924665369c23d8426715bb08d30
MD5 a342930d86dc4b7f93385e336150647c
BLAKE2b-256 b9a9442f0bcc2ed96d278463dde8dbb568247314a3c8eb4fcc26d8f7ab05933c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.3.17-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e4531a4018ba68404db5b7570f69cffb59ffc8601fa30ca40f8e0bcd010aea60
MD5 7dc8363876450051fcb85cdcd4dca19e
BLAKE2b-256 85462dd498e0dc4affa0294a0bde14b5167dce4fb312a86d0a3d7e270a4bd914

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.3.17-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ffb514d35198232f11bc52b7fd698c79fddd9e76a5fef96acfc47e68282cd1d9
MD5 5c54f375f02384ecf4a0471bbc3afd1e
BLAKE2b-256 136f13f2dc601c586e794eb2a40ebab6fb151eb9a136f47e80333bfecbcd3eea

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.3.17-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 b406d619a2f591621a250fc13b8e9e9a79e1731faa2d93eb014e06d2dd558bc4
MD5 2e233ca07c093a7e29b26c93ccc53cb5
BLAKE2b-256 4e800ee2032252b0db73b7d22db7ae7b5282a4c990e92ffdae96be623c408ee3

See more details on using hashes here.

Provenance

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