Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
As title
  • Loading branch information
esc committed May 12, 2024
1 parent f00c77a commit 7507fc8
Showing 1 changed file with 7 additions and 18 deletions.
25 changes: 7 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,21 @@ algorithms in Bahmann 2015, specifically those from section 4.1 and 4.2: namely
Numba because they serve to clearly identify regions within the Python
bytecode.

## dependencies
## development

* Python 3.11 or 3.12
* make (optional, build tool)
* graphviz
* pyyaml
* pytest (for testing)
* sphinx (for docs)
* sphinx_rt_theme (for docs)

You can create a conda env using the following:

```
$ conda env create -n numba-rvsdg python=3.12 python-graphviz pyyaml pytest sphinx sphinx_rtd_theme
$ conda activate numba-rvsdg
```

If you have `make` and `conda` available, a common workflow could be:
If you have `make` and `conda` available, a common setting up workflow could
be:

```
$ make conda-env # setup conda environment
$ conda activate numba-rvsdg # activate it
$ make conda-install # install dependencies
$ make # lint, build and test the project
```

Feel free to look at the `makefile` for low-level commands.
Feel free to look at the
[`makefile`](https://github.com/numba/numba-rvsdg/blob/main/makefile) for all
development commands.

## references

Expand Down

0 comments on commit 7507fc8

Please sign in to comment.