Skip to content

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

Draft
Siddhanthguptaa wants to merge 1 commit into
ControlCore-Project:devfrom
Siddhanthguptaa:docs/windows-run-instructions
Draft

Siddhanthguptaa wants to merge 1 commit into
ControlCore-Project:devfrom
Siddhanthguptaa:docs/windows-run-instructions

Conversation

@Siddhanthguptaa

Copy link
Copy Markdown

Refs #638. Depends on #639: on current dev run.bat doesn't start Python nodes, so the steps below only work once #639 is merged. Marking as draft until then.

  • README: a short "Running a study on Windows" section (makestudy.bat → build.bat → maxtime.bat → run.bat, where output goes, stop.bat/clear.bat, PowerShell .\ note). The example uses mystudy because a sample folder already exists in the repo.
  • concore_cli/README.md: the --type default is windows on Windows and posix elsewhere (see DEFAULT_EXEC_TYPE in cli.py); ./run.bat → run.bat (.\run.bat in PowerShell); a troubleshooting entry for "'python' is not recognized".

Checked by running the README steps as written in cmd on Windows 11 (with #639 applied): both nodes of demo/sample reach simtime 15.

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".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant