From 1f847533bd20ffa6902da3a919db70649f4ca9a7 Mon Sep 17 00:00:00 2001 From: Siddhanth Gupta Date: Wed, 4 Nov 2026 14:19:26 +0530 Subject: [PATCH] docs: how to run a study on Windows without the CLI Add a short section on makestudy.bat/build.bat/maxtime.bat/run.bat to the README, fix the documented --type default and the run.bat command in concore_cli/README.md, and add a troubleshooting entry for "'python' is not recognized". --- README.md | 14 ++++++++++++++ concore_cli/README.md | 7 +++++-- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1d59a86..20c9c85 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,20 @@ concore stop For detailed CLI documentation, see [concore_cli/README.md](concore_cli/README.md). +### Running a study on Windows (without the CLI) + +From `cmd` in the repository root, with Python 3 on your `PATH` as `python` (`makestudy.bat` calls it directly): + +```bat +makestudy.bat demo\sample.graphml mystudy +cd mystudy +build.bat +maxtime.bat 15 +run.bat +``` + +`makestudy.bat` creates the study folder (`mystudy` here) in the current directory; without the second argument it is named after the GraphML file. Each node writes its output to `\concoreout.txt`. Use `stop.bat` to stop the nodes and `clear.bat` to clear the data between runs (this also removes the max time, so run `maxtime.bat` again afterwards). In PowerShell, call the scripts as `.\makestudy.bat`, `.\build.bat`, and so on. + ## Configuration _concore_ supports customization through configuration files in the `CONCOREPATH` directory (defaults to the _concore_ installation directory): diff --git a/concore_cli/README.md b/concore_cli/README.md index 78f98b1..240fdfa 100644 --- a/concore_cli/README.md +++ b/concore_cli/README.md @@ -60,7 +60,7 @@ Compiles a concore workflow GraphML file into executable scripts (POSIX, Windows **Options:** - `-s, --source ` - Source directory (default: src) - `-o, --output ` - Output directory (default: out) -- `-t, --type ` - Execution type: windows, posix, or docker (default: windows) +- `-t, --type ` - Execution type: windows, posix, or docker (default: windows on Windows, posix elsewhere) - `--auto-build` - Automatically run build script after generation - `--compose` - Generate `docker-compose.yml` (only valid with `--type docker`) @@ -152,7 +152,7 @@ concore stop ```bash concore build workflow.graphml --auto-build cd out - ./run.bat # or ./run on Linux/Mac + run.bat # .\run.bat in PowerShell, ./run on Linux/Mac ``` 6. **Monitor execution** @@ -194,6 +194,9 @@ Supported file types: - Ensure all nodes have labels in the format `ID:filename.ext` - Verify that edge connections reference valid nodes +**Issue: `'python' is not recognized as an internal or external command` (Windows)** +- Install Python 3 and add it to `PATH`, or point the generated scripts at `python.exe` with `PYTHONWIN` in `concore.tools` (in the concore folder) or the `CONCORE_PYTHONWIN` environment variable (see [docs/CONFIG.md](../docs/CONFIG.md)) + **Issue: Processes won't stop** - Try running `concore stop` with administrator/sudo privileges - Manually kill processes using Task Manager (Windows) or `kill` command (Linux/Mac)