Skip to content

docs: Small improvements to book #719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
swo wants to merge 3 commits into
base: main
Choose a base branch
from
+3 −11
Open

docs: Small improvements to book #719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c48517
docs: small typo and whitespace
swo Feb 4, 2026
f35d257
docs: fix dependencies
swo Feb 13, 2026
b8b41ef
docs: use main branch setup script
swo Feb 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions docs/book/src/first_model/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Ixa comes with a convenience script for setting up new Ixa projects. Change
directory to `disease_model/`, the project root, and run this command.

```bash
curl -s https://raw.githubusercontent.com/CDCgov/ixa/release/scripts/setup_new_ixa_project.sh | sh -s
curl -s https://raw.githubusercontent.com/CDCgov/ixa/main/scripts/setup_new_ixa_project.sh | sh -s
```

The script adds the Ixa library as a project dependency and provides you with a
Expand All @@ -76,15 +76,9 @@ We will depend on a few external libraries in addition to Ixa. The `cargo add`
command makes this easy.

```bash
cargo add rand_distr@0.4.3
cargo add csv
cargo add csv rand_distr serde
```

Notice that:

- a particular version can be specified with the `packagename@1.2.3` syntax;
- we can compile a library with specific features turn on or off.

### `Cargo.toml`

Cargo stores information about these dependencies in the `Cargo.toml` file. This
Expand Down
4 changes: 1 addition & 3 deletions docs/book/src/get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,11 @@ Execute the following commands to create a new Rust project called `ixa_model`.
cargo new --bin ixa_model

cd ixa_model

```

Use Ixa's new project setup script to setup the project for Ixa.

```bash

curl -s https://raw.githubusercontent.com/CDCgov/ixa/main/scripts/setup_new_ixa_project.sh | sh -s
```

Expand All @@ -43,5 +41,5 @@ cargo run -- --log-level=trace
To run with logging enabled for just `ixa_model`:

```bash
cargo run -- --log-level=ixa_model:trace
cargo run -- --log-level ixa_model=trace
```