The README install section currently shows only:
pyproject.toml defines three useful extras ([dev], [docs], [demo]) but they aren't mentioned anywhere in the README. Users following the tutorial notebook hit ModuleNotFoundError: matplotlib at the visualisation cells because jupyterlab and matplotlib only come in via [demo].
Two small README additions would help:
-
List the available extras and what each one is for.
-
Show the zsh-safe form, since pip install sarxarray[demo] errors out as zsh: no matches found: sarxarray[demo] on the default macOS shell:
pip install 'sarxarray[demo]' # to run the example notebook
pip install 'sarxarray[dev]' # to run the test suite
pip install 'sarxarray[docs]' # to build the docs locally
Happy to send a PR if useful.
(Filed in the context of JOSS review openjournals/joss-reviews#10492.)
The README install section currently shows only:
pyproject.tomldefines three useful extras ([dev],[docs],[demo]) but they aren't mentioned anywhere in the README. Users following the tutorial notebook hitModuleNotFoundError: matplotlibat the visualisation cells becausejupyterlabandmatplotlibonly come in via[demo].Two small README additions would help:
List the available extras and what each one is for.
Show the zsh-safe form, since
pip install sarxarray[demo]errors out aszsh: no matches found: sarxarray[demo]on the default macOS shell:Happy to send a PR if useful.
(Filed in the context of JOSS review openjournals/joss-reviews#10492.)