Merge branch 'main' into sphinx

PalashChitnavis · web-flow · commit 8dbe146f6b8f · 2025-08-28T15:27:03.000+05:30
diff --git a/brian2wasm/__main__.py b/brian2wasm/__main__.py
@@ -1,35 +1,55 @@
 import argparse
+import shutil
 import sys
 import os
+import platform
+import subprocess
 
 def main():
     """
-        Run a Brian2Wasm simulation from the command line.
+        Command-line interface for **Brian2Wasm**.
+
+        Usage
+        -----
+        ``python -m brian2wasm <script.py> [--no-server] [--skip-install]``
 
         Parameters
         ----------
         script : str
-            Path to the Python model file. Must end with ``.py`` and must not call
-            ``set_device`` directly, as the CLI automatically inserts the required
-            ``set_device('wasm_standalone', …)`` line.
-        no_server : bool, optional
-            If True, generate the WASM/HTML output without starting the local
-            preview server (sets the ``BRIAN2WASM_NO_SERVER`` environment variable).
-
-        Raises
-        ------
-        FileNotFoundError
-            If the given script does not exist.
-        ValueError
-            If the provided file is not a ``.py`` script.
-        RuntimeError
-            If execution of the model fails for any reason.
-
-        Notes
-        -----
-        This command is typically invoked as::
+            Path to the user’s Python model. The file **must** end with
+            ``.py`` and must not call ``set_device`` itself – the CLI inserts
+            the appropriate ``set_device('wasm_standalone', …)`` line
+            automatically.
+        --no-server : flag, optional
+            Generate the WASM/HTML output without starting the local preview
+            web-server (sets the ``BRIAN2WASM_NO_SERVER`` environment
+            variable for the subprocess).
+        --skip-install : flag, optional
+            Run Brian2WASM without checking or installing EMSDK. Use this if
+            you are sure EMSDK is already installed and configured in your
+            environment.
 
-            python -m brian2wasm <script.py> [--no-server]
+        Behaviour
+        ---------
+        1. Validates that *script* exists and is a ``.py`` file.
+        2. Looks for an ``<scriptname>.html`` file in the same directory.
+           * If found, passes the HTML file to ``set_device`` so the custom
+             template is used.
+           * Otherwise falls back to the default template.
+        3. Unless *--skip-install* is given, verifies EMSDK installation
+           (Pixi/Conda/CONDA_EMSDK_DIR) and attempts to activate it.
+        4. Prepends the required ``set_device('wasm_standalone', …)`` call to
+           the script source in-memory.
+        5. Executes the modified script with its own directory as working
+           directory, so any relative paths inside the model behave as
+           expected.
+
+        Exit status
+        -----------
+        * ``0`` – build finished successfully (and server started unless
+          *--no-server* was given).
+        * ``1`` – any error (missing file, not a ``.py`` file, EMSDK not found
+          or not activated, exception during model execution, etc.).
     """
 
     parser = argparse.ArgumentParser(
@@ -44,18 +64,28 @@ def main():
         action="store_true",
         help="Generate files without starting the web server"
     )
+    parser.add_argument("--skip-install",
+                        action="store_true",
+                        help="Run Brian2WASM without installing/activating EMSDK"
+    )
+    
     args = parser.parse_args()
 
     script_path = args.script
 
     # Check if the script exists and is a Python file
     if not os.path.isfile(script_path):
-        print(f"Error: File '{script_path}' does not exist.", file=sys.stderr)
+        full_path = os.path.abspath(script_path)
+        print(f"❌ Error: File '{full_path}' does not exist.", file=sys.stderr)
         sys.exit(1)
     if not script_path.endswith(".py"):
-        print(f"Error: File '{script_path}' is not a Python script (.py).", file=sys.stderr)
+        print(f"❌ Error: File '{script_path}' is not a Python script (.py).", file=sys.stderr)
         sys.exit(1)
 
+    if not args.skip_install:
+        # Check emsdk setup
+        check_emsdk()
+
     # Read the original script
     with open(script_path, 'r') as f:
         script_content = f.read()
@@ -69,41 +99,87 @@ def main():
     html_file_path = os.path.join(script_dir, html_file)
     has_html_file = os.path.isfile(html_file_path)
 
-    # Inject the required lines at the top
+    # Inject required lines at the top
     if has_html_file:
-        print(f"html file found: '{html_file_path}'")
+        print(f"✅ HTML file found: '{html_file_path}'")
         injection = (
             "from brian2 import set_device\n"
             "import brian2wasm\n"
             f"set_device('wasm_standalone', directory='{script_name}', html_file='{html_file}')\n"
         )
     else:
-        print(f"html file not found: using default html template")
+        print("ℹ️  HTML file not found: using default HTML template.")
         injection = (
             "from brian2 import set_device\n"
             "import brian2wasm\n"
             f"set_device('wasm_standalone', directory='{script_name}')\n"
         )
+
     modified_script = injection + script_content
 
-    # Set the working directory to the script's directory
+    # Set working directory to script's directory
     original_cwd = os.getcwd()
     os.chdir(script_dir)
 
     try:
-        # Execute the modified script in memory with __file__ set
         if args.no_server:
             os.environ['BRIAN2WASM_NO_SERVER'] = '1'
-        print(f"Script path: {os.path.abspath(script_path)}")
-        print(f"Directory: {script_dir}")
+
+        print(f"📄 Script path: {os.path.abspath(script_path)}")
+        print(f"📁 Directory: {script_dir}")
         exec_globals = {'__name__': '__main__', '__file__': os.path.abspath(script_path)}
-        exec(modified_script, exec_globals)
+        compiled_script = compile(modified_script, script_path, 'exec')
+        exec(compiled_script, exec_globals)
+
     except Exception as e:
-        print(f"Error running script: {e}", file=sys.stderr)
+        print(f"❌ Error running script: {e}", file=sys.stderr)
         sys.exit(1)
+
     finally:
-        # Restore the original working directory
         os.chdir(original_cwd)
 
+
+def check_emsdk():
+    emsdk = shutil.which("emsdk")
+    conda_emsdk_dir = os.environ.get("CONDA_EMSDK_DIR")
+
+    if not emsdk and not conda_emsdk_dir:
+        print("❌ EMSDK and CONDA_EMSDK_DIR not found. That means EMSDK is not installed.")
+        print("   ➤ If you are using **Pixi**, run:")
+        print("     pixi add emsdk && pixi install")
+        print("   ➤ If you are using **Conda**, run:")
+        print("     conda install emsdk -c conda-forge")
+        print("   ➤ Else refer to Emscripten documentation:")
+        print("     https://emscripten.org/index.html#")
+        sys.exit(1)
+
+    print(f"✅ EMSDK is installed and CONDA_EMSDK_DIR is found")
+
+    try:
+        print("🔧 Attempting to activate EMSDK with: emsdk activate latest")
+        result = subprocess.run(["./emsdk", "activate", "latest"], cwd=conda_emsdk_dir, check=False, capture_output=True, text=True)
+        if result.returncode != 0:
+            print("❌ Failed to activate EMSDK:")
+            choice = input("Do you want to install and activate EMSDK now? (y/n) ")
+            if choice == 'y':
+                try:
+                    subprocess.run(["./emsdk", "install", "latest"], cwd=conda_emsdk_dir, check=True)
+                    print("✅ EMSDK install & activation succeeded. You can run the script now.")
+                except subprocess.CalledProcessError as e:
+                    print("❌ Failed to activate EMSDK:")
+                    print("   ➤ Please run the following manually in your terminal and try again:")
+                    print("       cd $CONDA_EMSDK_DIR && ./emsdk install latest && ./emsdk activate latest")
+            else:
+                print("   ➤ Please run the following manually in your terminal and try again:")
+                print("       cd $CONDA_EMSDK_DIR && ./emsdk install latest && ./emsdk activate latest")
+
+            sys.exit(1)
+        else:
+            print("✅ EMSDK activation succeeded.")
+    except Exception as e:
+        print(f"❌ Error while running EMSDK activation: {e}")
+        sys.exit(1)
+
+
 if __name__ == "__main__":
     main()
diff --git a/brian2wasm/device.py b/brian2wasm/device.py
@@ -254,12 +254,13 @@ def generate_makefile(self, writer, compiler, compiler_flags, linker_flags, nb_t
         source_files = ' '.join(sorted(writer.source_files))
         preamble_file = os.path.join(os.path.dirname(__file__), 'templates', 'pre.js')
 
-        emsdk_path = (
+        prefs.devices.wasm_standalone.emsdk_directory = (
                 prefs.devices.wasm_standalone.emsdk_directory
                 or os.environ.get("EMSDK")
                 or os.environ.get("CONDA_EMSDK_DIR")
-                or ""
         )
+        emsdk_path = prefs.devices.wasm_standalone.emsdk_directory
+
         emsdk_version = prefs.devices.wasm_standalone.emsdk_version
         if not emsdk_path:
             # Check whether EMSDK is already activated
@@ -662,22 +663,19 @@ def run(self, directory, results_directory, with_output, run_args):
             if os.environ.get('BRIAN2WASM_NO_SERVER','0') == '1':
                 print("Skipping server startup (--no-server flag set)")
                 return
-            
+
+            emsdk_path = prefs.devices.wasm_standalone.emsdk_directory
+            os.environ['EMSDK_QUIET'] = '1'
+
             if platform.system() == "Windows":
-                cmd_line = f'emrun "index.html"'
-                try:
-                    os.system(cmd_line)
-                except Exception as e:
-                    raise RuntimeError(f"Failed to run emrun command: {cmd_line}. "
-                                       "Please ensure that emrun is installed and available in your PATH.") from e
-
-            if prefs.devices.wasm_standalone.emsdk_directory:
-                emsdk_path = prefs.devices.wasm_standalone.emsdk_directory
-                run_cmd = ['source', f'{emsdk_path}/emsdk_env.sh', '&&', 'emrun', 'index.html']
+                cmd_line = f'cmd.exe /C "call {emsdk_path}\\emsdk_env.bat & emrun index.html"'
+
             else:
-                run_cmd = ['emrun', 'index.html']
+                run_cmd = ['source', f'{emsdk_path}/emsdk_env.sh', '&&', 'emrun', 'index.html']
+                cmd_line = f"/bin/bash -c '{' '.join(run_cmd + run_args)}'"
+
             start_time = time.time()
-            os.system(f"/bin/bash -c '{' '.join(run_cmd + run_args)}'")
+            os.system(cmd_line)
             self.timers['run_binary'] = time.time() - start_time
 
     def build(self, html_file=None, html_content=None, **kwds):
diff --git a/pyproject.toml b/pyproject.toml
@@ -49,8 +49,8 @@ python = ">=3.10"
 emsdk = "*"        
 
 [tool.pixi.pypi-dependencies]
-brian2wasm = "*"
-brian2 = "==2.9.0"         
+brian2wasm =  "*"
+brian2 = ">=2.9.0"         
 
 [tool.pixi.tasks]
 setup = "emsdk install latest && emsdk activate latest"
diff --git a/recipe/meta.yaml b/recipe/meta.yaml
@@ -0,0 +1,37 @@
+{% set name = "brian2wasm" %}
+{% set version = "0.4.2" %}
+
+package:
+  name: {{ name }}
+  version: {{ version }}
+
+source:
+  path: ..
+
+build:
+  number: 0
+  script: {{ PYTHON }} -m pip install . --no-deps -vv
+
+requirements:
+  host:
+    - python
+    - pip
+    - setuptools
+  run:
+    - python
+    - brian2 >=2.9.0
+    - numpy
+    - emsdk
+
+about:
+  home: https://github.com/brian-team/brian2wasm
+  summary: WebAssembly backend for Brian2 simulator
+  description: |
+    brian2wasm extends the Brian2 simulator to generate WebAssembly-compatible code
+    using Emscripten. This enables running spiking neural network simulations directly
+    in the browser.
+
+extra:
+  recipe-maintainers:
+    - mstimberg
+    - PalashChitnavis
