Update installation process.

Author: RobinEnjalbert

setup.py

@@ -1,43 +1,41 @@
 from setuptools import setup, find_packages
 from os.path import join
 
-packages = []
-packages_dir = {}
+PROJECT = 'SSD'
+PACKAGES = ['Core', 'SOFA']
 
-include_SOFA = True
-try:
-    import Sofa
-except ImportError:
-    include_SOFA = False
+packages = [f'{PROJECT}']
+packages_dir = {f'{PROJECT}': 'src'}
 
-project = 'SSD'
-roots = ['Core', 'SOFA'] if include_SOFA else ['Core']
-root_packages = ['storage', 'rendering']
+# Configure packages list and directories
+for package in find_packages(where='src'):
+    packages.append(f'{PROJECT}.{package}')
+for package in PACKAGES:
+    packages_dir[f'{PROJECT}.{package}'] = join('src', package)
 
-for root in roots:
-    packages.append(f'{project}.{root}')
-    packages_dir[f'{project}.{root}'] = join('src', root)
-    for package in find_packages(where=join('src', root)):
-        packages.append(f'{project}.{root}.{package}')
-        packages_dir[f'{project}.{root}.{package}'] = join('src', root, package)
+# Add examples as subpackages
+examples_dir = {'Core': ['storage', 'rendering'],
+                'SOFA': ['storage', 'rendering', 'rendering-offscreen']}
+for package in PACKAGES:
+    packages_dir[f'{PROJECT}.examples.{package}'] = join('examples', package)
+    for example_dir in examples_dir[package]:
+        packages.append(f'{PROJECT}.examples.{package}.{example_dir}')
 
-examples = {'Core': ['storage', 'rendering'],
-            'SOFA': ['storage', 'rendering', 'rendering-offscreen']}
-for root in roots:
-    for repo in examples[root]:
-        packages.append(f'{project}.examples.{root}.{repo}')
-        packages_dir[f'{project}.examples.{root}.{repo}'] = join('examples', root, repo)
-
-packages.append(f'{project}')
-packages_dir[f'{project}'] = 'src'
+# Extract README.md content
+with open('README.md') as f:
+    long_description = f.read()
 
+# Installation
 setup(name='SimulationSimpleDatabase',
-      version='22.06',
+      version='22.12',
       description='A simplified API to use SQL Databases with numerical simulation.',
+      long_description=long_description,
+      long_description_content_type='text/markdown',
       author='R. Enjalbert, A. Odot',
+      author_email='robin.enjalbert@inria.fr',
       url='https://github.com/RobinEnjalbert/SimulationSimpleDatabase',
       packages=packages,
       package_dir=packages_dir,
-      package_data={f'{project}.examples.Core.rendering': ['armadillo.obj']},
+      package_data={f'{PROJECT}.examples.Core.rendering': ['armadillo.obj']},
       install_requires=['numpy', 'peewee', 'vedo'],
       entry_points={'console_scripts': ['SSD=SSD.cli:execute_cli']})

src/cli.py

@@ -144,10 +144,12 @@ def execute_cli():
 
     # Run a demo script
     if (example := args.run) is not None:
+
         # Check the example name
         if example.lower() not in examples.keys():
             print(f"Unknown demo '{example}'.")
             quit(print_available_examples(examples))
+
         # Get the example directory
         if not is_pip_installed():
             import SSD.Core
@@ -160,13 +162,25 @@ def execute_cli():
                 print(f"The directory '{join(getcwd(), 'SSD_examples')}' does not exists.")
                 copy_examples_dir()
             examples_dir = join(getcwd(), 'SSD_examples')
+
+        # Run the example
         if type(examples[example]) == str:
             root, repo, script, _ = examples[example].split('.')
+            # Check SOFA installation
+            if root == 'SOFA' and not is_SOFA_installed():
+                quit(print(f"SOFA bindings were not found, unable to run {example} example "
+                           f"({join(root, repo, script)}.py)"))
+            # Run example
             run([f'{executable}', f'{script}.py'], cwd=join(examples_dir, root, repo))
         else:
             root, repo, example_record, extension = examples[example][0].split('.')
             _, _, example_replay, _ = examples[example][1].split('.')
+            # Check SOFA installation
+            if root == 'SOFA' and not is_SOFA_installed():
+                quit(print(f"SOFA bindings were not found, unable to run {example} example "
+                           f"({join(root, repo, example_record)}.py)"))
             chdir(join(examples_dir, root, repo))
+            # Get user input between record and replay
             if example == 'caduceus':
                 if not exists('caduceus.db'):
                     print("Recording data in offscreen mode, please wait...")
@@ -181,7 +195,6 @@ def execute_cli():
                         run([f'{executable}', f'{example_replay}.py'], cwd=join(examples_dir, root, repo))
                 else:
                     run([f'{executable}', f'{example_record}.py'], cwd=join(examples_dir, root, repo))
-        return
 
     # No command
     else: