Contributing guidlines

[nick-gorman]

• Info on how to install for development and run tests

[mdavis-xyz]

Note that the uv sync command doesn't work for me:

(venv) matthew@zenbook:~/Documents/Projects/software/nemosis/NEMOSIS$ uv sync
warning: `VIRTUAL_ENV=/home/matthew/Documents/Projects/software/nemosis/venv` does not match the project environment path `.venv` and will be ignored
  × No solution found when resolving dependencies for split (python_full_version ==
  │ '3.8.*'):
  ╰─▶ Because the requested Python version (>=3.8) does not satisfy Python>=3.9 and
      pandas==2.2.3 depends on Python>=3.9, we can conclude that pandas==2.2.3 cannot
      be used.
      And because only pandas<=2.2.3 is available and your project depends on
      pandas>=2.2.3, we can conclude that your project's requirements are unsatisfiable.

      hint: The `requires-python` value (>=3.8) includes Python versions that are not
      supported by your dependencies (e.g., pandas==2.2.3 only supports >=3.9). Consider
      using a more restrictive `requires-python` value (like >=3.9).

I'm running python 3.12.3.

[mdavis-xyz]

This seems to work:

pip install -r requirements-dev.lock  -r requirements.lock 
python3 -m unittest discover tests -v -k TestCacheCompiler

Except all the tests fail because the cache location I specified does not exist. I expected that the library would create a folder if it doesn't exist. For now, please specify in the instructions that it needs to be a pre-existing location.