Skip to content

Commit

Permalink
Added numpy as a build-system requirement and updated readme to pip i…
Browse files Browse the repository at this point in the history
…nstall.
  • Loading branch information
rasmushaugaard committed Mar 21, 2024
1 parent d3d44fa commit 38c64c6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,17 @@ g++ -I../main example.C -o example -O3

# Getting started (Python)

On MacOS, do the following (not yet made on other ).
```bash
pip install git+https://github.com/hbf/miniball.git#subdirectory=python
```

or

1. Stand in the `python`-folder.
2. Run `pip install setup.py` (you may need to use the `--user` option or `sudo`).
3. Run `pytest` (if you do not have it, install it through `pip install pytest`) to see that it works and that all tests pass.
4. Does it work? Great! You are now ready to use the python function.
```bash
git clone https://github.com/hbf/miniball.git
cd miniball/python
pip install .
```

# Getting started (C#)

Expand Down
6 changes: 6 additions & 0 deletions python/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[build-system]
requires = [
"setuptools",
"wheel",
"numpy",
]

0 comments on commit 38c64c6

Please sign in to comment.