Install instructions for development incorrect in README

[phinate]

At the moment, the README suggests the following:

git clone git@github.com:NVIDIA/torch-harmonics.git
cd torch-harmonics
pip install -e .

In fact, for this to work on my machine, I needed to both bound my Python version to 3.11 (see #135 for why), and also run

git clone git@github.com:NVIDIA/torch-harmonics.git
cd torch-harmonics
pip install torch
pip install --no-build-isolation -e .

[azrael417]

Hello Nathan. In the --no-build-isolation is always required. You say it does not compile with python 3.12 and no build isolation enabled?

[phinate]

Hi! To separate out the two concerns:

• the problems with Python 3.12 happen at runtime:

$ python
Python 3.12.6 (main, Sep  9 2024, 21:36:32) [Clang 18.1.8 ] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import torch_harmonics
/Users/nsimpson/Code/torch-harmonics/torch_harmonics/legendre.py:116: SyntaxWarning: invalid escape sequence '\c'
  """
/Users/nsimpson/Code/torch-harmonics/torch_harmonics/legendre.py:154: SyntaxWarning: invalid escape sequence '\c'
  """
/Users/nsimpson/Code/torch-harmonics/torch_harmonics/disco/convolution.py:178: SyntaxWarning: invalid escape sequence '\o'
  """

It's a tiny fix (make the docstrings raw), which I've written in #136.

• The --no-build-isolation step was not given in the README for editable installing; I was just suggesting that should be amended.

FWIW, I think uv has a fantastic approach to this via augmenting build dependencies. I've used this to reliably install flash attention in my own library without any extra commands. I'd happily look at that myself if you'd like, but it would be a larger overhaul of how the project is installed.