Simple Installer for Unified Directory Structure, Initial Implementation (#1819)

* partially working simple installer

* works on linux

* fix linux requirements files

* read root environment variable in right place

* fix cat invokeai.init in test workflows

* fix classical cp error in test-invoke-pip.yml

* respect --root argument now

* untested bat installers added

* windows install.bat now working

fix logic to find frontend files

* rename simple_install to "installer"

1. simple_install => 'installer'
2. source and binary install directories are removed

* enable update scripts to update requirements

- Also pin requirements to known working commits.
- This may be a breaking change; exercise with caution
- No functional testing performed yet!

* update docs and installation requirements

NOTE: This may be a breaking commit! Due to the way the installer
works, I have to push to a public branch in order to do full end-to-end
testing.

- Updated installation docs, removing binary and source installers and
  substituting the "simple" unified installer.
- Pin requirements for the "http:" downloads to known working commits.
- Removed as much as possible the invoke-ai forks of others' repos.

* fix directory path for installer

* correct requirement/environment errors

* exclude zip files in .gitignore

* possible fix for dockerbuild

* ready for torture testing

- final Windows bat file tweaks
- copy environments-and-requirements to the runtime directory so that
  the `update.sh` script can run.

  This is not ideal, since we lose control over the
  requirements. Better for the update script to pull the proper
  updated requirements script from the repository.

* allow update.sh/update.bat to install arbitrary InvokeAI versions

- Can pass the zip file path to any InvokeAI release, branch, commit or tag,
  and the installer will try to install it.
- Updated documentation
- Added Linux Python install hints.

* use binary installer's :err_exit function

* user diffusers 0.10.0

* added logic for CPPFLAGS on mac

* improve windows install documentation

- added information on a couple of gotchas I experienced during
  windows installation, including DLL loading errors experienced
  when Visual Studio C++ Redistributable was not present.

* tagged to pull from 2.2.4-rc1

- also fix error of shell window closing immediately if suitable
  python not found

Co-authored-by: mauwii <Mauwii@outlook.de>

scripts/configure_invokeai.py

@@ -40,7 +40,7 @@ Dataset_path = './configs/INITIAL_MODELS.yaml'
 Default_config_file = './configs/models.yaml'
 SD_Configs = './configs/stable-diffusion'
 
-assert os.path.exists(Dataset_path),"The configs directory cannot be found. Please run this script from within the InvokeAI distribution directory, or from within the invokeai runtime directory."
+assert os.path.exists(Dataset_path),"The configs directory cannot be found. Please run this script from within the invokeai runtime directory."
 
 Datasets = OmegaConf.load(Dataset_path)
 completer = generic_completer(['yes','no'])
@@ -234,7 +234,7 @@ This involves a few easy steps.
    "Role" should be "read").
 
    Now copy the token to your clipboard and paste it at the prompt. Windows
-   users can paste with right-click.
+   users can paste with right-click or Ctrl-Shift-V.
    Token: '''
         )
         access_token = getpass_asterisk.getpass_asterisk()
@@ -580,22 +580,7 @@ def get_root(root:str=None)->str:
     elif os.environ.get('INVOKEAI_ROOT'):
         return os.environ.get('INVOKEAI_ROOT')
     else:
-        init_file = os.path.expanduser(Globals.initfile)
-        if not os.path.exists(init_file):
-            return None
-
-    # if we get here, then we read from initfile
-    root = None
-    with open(init_file, 'r') as infile:
-        lines = infile.readlines()
-        for l in lines:
-            if re.search('\s*#',l): # ignore comments
-                continue
-            match = re.search('--root\s*=?\s*"?([^"]+)"?',l)
-            if match:
-                root = match.groups()[0]
-                root = root.strip()
-    return root
+        return Globals.root
 
 #-------------------------------------
 def select_root(root:str, yes_to_all:bool=False):
@@ -626,18 +611,16 @@ def initialize_rootdir(root:str,yes_to_all:bool=False):
     print(f'** INITIALIZING INVOKEAI RUNTIME DIRECTORY **')
     root_selected = False
     while not root_selected:
-        root = select_root(root,yes_to_all)
         outputs = select_outputs(root,yes_to_all)
-        Globals.root = os.path.abspath(root)
         outputs = outputs if os.path.isabs(outputs) else os.path.abspath(os.path.join(Globals.root,outputs))
 
-        print(f'\nInvokeAI models and configuration files will be placed into "{root}" and image outputs will be placed into "{outputs}".')
+        print(f'\nInvokeAI image outputs will be placed into "{outputs}".')
         if not yes_to_all:
-            root_selected = yes_or_no('Accept these locations?')
+            root_selected = yes_or_no('Accept this location?')
         else:
             root_selected = True
 
-    print(f'\nYou may change the chosen directories at any time by editing the --root and --outdir options in "{Globals.initfile}",')
+    print(f'\nYou may change the chosen output directory at any time by editing the --outdir options in "{Globals.initfile}",')
     print(f'You may also change the runtime directory by setting the environment variable INVOKEAI_ROOT.\n')
 
     enable_safety_checker = True
@@ -651,6 +634,7 @@ def initialize_rootdir(root:str,yes_to_all:bool=False):
         print('It can be selectively enabled at run time with --nsfw_checker, and disabled with --no-nsfw_checker.')
         print('The following option will set whether the checker is enabled by default. Like other options, you can')
         print(f'change this setting later by editing the file {Globals.initfile}.')
+        print(f'The NSFW checker is a memory hog. If you have less than 6 GB of VRAM answer NO to this option.')
         enable_safety_checker = yes_or_no('Enable the NSFW checker by default?',enable_safety_checker)
 
         print('\nThe next choice selects the sampler to use by default. Samplers have different speed/performance')
@@ -679,7 +663,7 @@ def initialize_rootdir(root:str,yes_to_all:bool=False):
             shutil.copytree(src,dest,dirs_exist_ok=True)
         os.makedirs(outputs, exist_ok=True)
 
-    init_file = os.path.expanduser(Globals.initfile)
+    init_file = os.path.join(Globals.root,Globals.initfile)
 
     print(f'Creating the initialization file at "{init_file}".\n')
     with open(init_file,'w') as f:
@@ -688,9 +672,6 @@ def initialize_rootdir(root:str,yes_to_all:bool=False):
 # Feel free to edit. If anything goes wrong, you can re-initialize this file by deleting
 # or renaming it and then running configure_invokeai.py again.
 
-# The --root option below points to the folder in which InvokeAI stores its models, configs and outputs.
---root="{Globals.root}"
-
 # the --outdir option controls the default location of image files.
 --outdir="{outputs}"
 
@@ -757,7 +738,7 @@ def main():
 
         # We check for to see if the runtime directory is correctly initialized.
         if Globals.root == '' \
-           or not os.path.exists(os.path.join(Globals.root,'configs/stable-diffusion/v1-inference.yaml')):
+           or not os.path.exists(os.path.join(Globals.root,'invokeai.init')):
             initialize_rootdir(Globals.root,opt.yes_to_all)
 
         # Optimistically try to download all required assets. If any errors occur, add them and proceed anyway.