Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinsung committed Sep 18, 2023
1 parent e4d9c76 commit d31163e
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,37 @@ from the root directory of the code repository.

To set up ffsim for development, install it from source in editable mode along with the development requirements:

pip install -e ".[dev]"
```bash
pip install -e ".[dev]"
```

If you add or modify any Rust modules, rebuild them by running the command

maturin develop --release
```bash
maturin develop
```

If you are benchmarking the code, then pass the `--release` flag:

```bash
maturin develop --release
```

Tests and other code checks are managed using [tox](https://tox.wiki/en/latest/).
To run the default tox environments, simply run

tox
```bash
tox
```

To run a specific environment, for example, to run the lint checks, do

tox run -e lint
```bash
tox run -e lint
```

You can also use `pytest` to run the tests directly. For example,

pytest tests/
```bash
pytest tests/
```

0 comments on commit d31163e

Please sign in to comment.