Skip to content

Commit

Permalink
Update readme instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
kwabenantim committed Mar 19, 2024
1 parent 1735643 commit 593439d
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,19 +74,33 @@ Developed and tested with Python 3.8 - 3.12 on Ubuntu 22.04.
You can install the dependencies with `pip install pyyaml pygccxml castxml`

### Test the Installation
To generate the full `pyshapes` wrapper do:
First, clone the repository with:

```bash
git clone https://github.com/Chaste/cppwg.git
```

Add the cppwg directory to your `PYTHONPATH` e.g. by doing:

```bash
export PYTHONPATH=$(pwd)/cppwg:$PYTHONPATH
```

To generate the full `pyshapes` wrapper, do:

```bash
python cppwg/shapes/wrapper/generate.py \
--source_root cppwg/shapes/src/ \
--wrapper_root cppwg/shapes/wrapper/ \
--castxml_binary path/to/bin/castxml \
--castxml_binary /path/to/bin/castxml \
--package_info cppwg/shapes/wrapper/package_info.yaml \
--includes cppwg/shapes/src/
```

then to build the example package do:
where `/path/to/bin/castxml` is the path to your castxml installation.
If it is on the `PATH`, you can find it with `which castxml`.

To build the example package do:

```bash
mkdir cppwg/shapes/build
Expand Down

0 comments on commit 593439d

Please sign in to comment.