princeton-vl / infinigen

Infinite Photorealistic Worlds using Procedural Generation
https://infinigen.org
BSD 3-Clause "New" or "Revised" License
5.26k stars 442 forks source link

docs: pip install command fails on windows #269

Open halr9000 opened 1 month ago

halr9000 commented 1 month ago

Describe the bug

Here in the docs, it says:

# Minimal install (No terrain or opengl GT, ok for Infinigen-Indoors or single-object generation) 
INFINIGEN_MINIMAL_INSTALL=True pip install -e .

That command will generate a syntax error using a cmd or powershell shell.

Steps to Reproduce

Assuming PowerShell, as one does.

  1. Install Miniconda using winget (winget install --id=Anaconda.Miniconda3 -e)
  2. Open conda shell, or change your default powershell profile to do so
  3. Follow the infinigen install steps from git clone to conda activate
  4. Attempt to run pip install, and observe:
PS C:\Users\hal> INFINIGEN_MINIMAL_INSTALL=True pip install -e .
INFINIGEN_MINIMAL_INSTALL=True: The term 'INFINIGEN_MINIMAL_INSTALL=True' is not recognized as a name of a cmdlet, function, script file, or executable program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.

What version of the code were you using?

967970e6cbb3239af6ce87f2e1eb289c2616fb88

Platform

Suggested fix

This should work, but I don't yet know how to verify if it did only install the minimal as specified. Got no errors, about to try it out!

$env:INFINIGEN_MINIMAL_INSTALL="True" && pip install -e .

araistrick commented 1 month ago

Hello,

We dont officially support windows install except via WSL at the moment. It should in principle be possible to pip install the minimal version, but it is not tested or supported until someone with windows dev experience PRs a working install instruction. I am unable to implement/test this myself.

The intent here is to set the INFINIGEN_MINIMAL_INSTALL bash variable to True so that setup.py sees this value in its os.environs. What would be the typical way to achieve this in PowerShell?