Skip to content

docs: how to run a study on Windows without the CLI #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Siddhanthguptaa wants to merge 1 commit into from
Closed

docs: how to run a study on Windows without the CLI #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<node>\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):
Expand Down
7 changes: 5 additions & 2 deletions concore_cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Compiles a concore workflow GraphML file into executable scripts (POSIX, Windows
**Options:**
- `-s, --source <dir>` - Source directory (default: src)
- `-o, --output <dir>` - Output directory (default: out)
- `-t, --type <type>` - Execution type: windows, posix, or docker (default: windows)
- `-t, --type <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`)

Expand Down Expand Up @@ -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**
Expand Down Expand Up @@ -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)
Loading