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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3musllinux: musl 1.2+ x86-64

cfasim-0.7.8-py3-none-musllinux_1_2_aarch64.whl (4.2 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

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

Uploaded Python 3manylinux: glibc 2.28+ ARM64

cfasim-0.7.8-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.8-py3-none-macosx_11_0_arm64.whl (4.2 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

cfasim-0.7.8-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.8.tar.gz.

File metadata

  • Download URL: cfasim-0.7.8.tar.gz
  • Upload date:
  • Size: 51.1 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.8.tar.gz
Algorithm Hash digest
SHA256 27942b1172395cea42372d58657d598f7ca66dcb8d54d000bed23aa66c8bacf4
MD5 ba223d4a8ddaaf54f9356ab6717bf9d5
BLAKE2b-256 707be345ac9a14b48a353ae2b74c1454f013916a4e4115443871a979090f5455

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: cfasim-0.7.8-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.8-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 d05274dc4b6eebb2600316e37660735ba3e4e192830f403329ac5422d488763e
MD5 ed35a591a7dac197f8bf23653f99f161
BLAKE2b-256 dfe770e0d28d1debbb02e44b15cb0a4cb81fb410431188501c9c5e680021415c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.7.8-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 c7ddb506787cba089d1902e2789b7bffba10205e8c650d7edd3e99944f64b004
MD5 cf658bf933597b3b4f032b0446dc77a0
BLAKE2b-256 b05a6c73912ef75d8e40a8ff47e838cc60b1104ad081ed135426db97dbefb837

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.7.8-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 6ea939006fe9dbb323246e9525520a817e16a44b547538ad2036c5c89ca8f763
MD5 b7de7957d283c93849948cc74c09d80d
BLAKE2b-256 41eb4a45484e46fae600697571455a7580aea803593d03a4b594046832f1926e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.7.8-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 d5bbe37ebc85d2d06e5e6edf4fc1141913a70f39907fd06a1b264ada53de7f93
MD5 02d82090988f463fadb5dbb4b382b588
BLAKE2b-256 b8f36dba1de3e81b61bae86afd51c6ec460bc012fb67d048b048d065c18c28f6

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.7.8-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 41f868ca8c8e53548a55ce4d7ef08f9de307a9d2fcb961ee56486694966670e4
MD5 3a9b408937b403a0d0187fe8952f2a14
BLAKE2b-256 1e30ccb389c36e42579a565904737c0789f2817b818f502b1aaf9276d7fc3856

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.7.8-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f47ceb423f37ceb959e85c6f05c1296ca2e5b6af54170665eb2d0599da8c7538
MD5 0e00933b88b071af66cc9447efb66b04
BLAKE2b-256 17f14a29a6ee439018081185bce89ef3398aeb0d54d8bb5911dd39e961bfcad9

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cfasim-0.7.8-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 9c147329a7757c4644e75566607ecba21367a7563a4be6530bbd7ca1049974a1
MD5 705e3be01072d5409cd19be613dae9fd
BLAKE2b-256 5e0a78c6626c7ac1e2fd9baabd54e23d988c12bb8a5fcbddfc3bab829b493990

See more details on using hashes here.

Provenance

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