iiasa / message_ix

The integrated assessment and energy systems model MESSAGEix
https://docs.messageix.org
Apache License 2.0
111 stars 149 forks source link

Mention Z shell specifics in install instructions #819

Closed glatterf42 closed 4 weeks ago

glatterf42 commented 2 months ago

As discovered by @setupelz just now, users of the Z shell (zsh) might run into this error message when trying to install from source:

% pip install --editable .[docs,tests,tutorial]
zsh: no matches found: .[docs,tests,tutorial]

This issue is explained wonderfully here:

zsh uses square brackets for globbing / patern matching

Consequently, the brackets need to be escaped or inside quotes like pip install -e '.[docs,tests,tutorial]' for the command to work. This could either be a Known Issue or a footnote on the specific command.

We might want to include the same note in the other repos of our stack as well.

khaeru commented 2 months ago

Using the lens of #771: