Document the need to install Python headers on Ubuntu

jfowkes / pycutest

Python interface to CUTEst

https://jfowkes.github.io/pycutest/

GNU General Public License v3.0

27 stars 10 forks source link

Document the need to install Python headers on Ubuntu #80

Closed jfowkes closed 4 months ago

jfowkes commented 4 months ago

Resolves #79

Ubuntu does not install the Python headers, including Python.h, by default. We require Python.h in order to compile the CUTEst problem C interfaces.

This PR informs the user of this fact and shows them how to install the Python headers on Ubuntu in the README and install docs. As far as I am aware this is not required for macOS as their Python comes with the headers by default. No idea about other Linux distributions.

lindonroberts commented 4 months ago

Thanks @jfowkes, this is a good idea to mention. Perhaps it would be worthwhile saying explicitly "these are automatically included on MacOS" so those users know no action is needed.

jfowkes commented 4 months ago

@lindonroberts good idea, I have added a mention of this. If you are happy I will merge.