Repository navigation
support Windows - #137
support Windows#137Yuming-Lee24 wants to merge 9 commits into
Conversation
_2026_09_06_20_54_56_782.mp4 |
ratheron
left a comment
There was a problem hiding this comment.
Thanks for adding this. This will ease up the first week of the semester. @amacati do you agree that we should drop devcontainer support? Or just keep it in?
I've added some comments. Depending on Martin's answer, we should restructure the installation docs completely. Rest looks fine to me.
| @@ -0,0 +1,100 @@ | |||
| @echo off | |||
| rem Native Windows setup, called by Pixi through cmd.exe. No PowerShell required. | |||
There was a problem hiding this comment.
Called by pixi through cmd.exe?
There was a problem hiding this comment.
hmm, at first I am about to use a .ps1 to setup acados, but the pixi executes activation scripts through cmd.exe by default, so a .ps1 file can not be runned. Well this comment should be deleted.
Removed unnecessary mention of PowerShell in comments.
Co-authored-by: Marcel Rath <75042654+ratheron@users.noreply.github.com>
Hmm, I don't think anyone is using them, and pixi makes them redundant. We never had visualizations in the devcontainers either, right? |
Afaik, the visualizations in the containers work, but is extremely slow. |
|
@Yuming-Lee24 Looks like my github messed up my suggestions. I removed multiples lines in each, i.e., the whole section. Please check where what lines the comment includes |
|
Then I am fine with dropping the devcontainer support. Would be great if we could do this in a separate PR though to avoid too much churn. |
| Download a **Win64/x86_64 GCC release ZIP (UCRT, POSIX)** from | ||
| [WinLibs](https://winlibs.com/#download-release). Extract `mingw64` to | ||
| `C:\tools\mingw64`, then add `C:\tools\mingw64\bin` to your user **Path** under |
There was a problem hiding this comment.
Do we need to install this manually? Why can't we have this in pixi?
| ```powershell | ||
| winget install --exact --id Git.Git | ||
| winget install --exact --id prefix-dev.pixi | ||
| winget install --exact --id Microsoft.VCRedist.2015+.x64 |
There was a problem hiding this comment.
Do we need to install this manually? Why can't we have this in pixi?
| winget install --exact --id Git.Git | ||
| winget install --exact --id prefix-dev.pixi |
There was a problem hiding this comment.
We should just link to the official installation websites.
| It is also possible to develop the project on Windows using WSL2. Clone this project into the WSL2 file system, and follow the same instructions as for Linux. | ||
|
|
||
| However, rendering might not work out of the box. To enable software rendering, set the following environment variable in your WSL2 terminal: | ||
| ### Native Windows 10/11 (x86-64, not recommended) |
There was a problem hiding this comment.
This should be moved up after the Unix installation
ratheron
left a comment
There was a problem hiding this comment.
Nice that all dependencies are in pixi now. This makes it super easy to install. Thanks!
Since in this case the tutorial is basically identical for all platforms, we should only have one tutorial, which is just pointing out where differences lie (like file structure in windows etc)
| Pixi installs Python, CMake, MinGW-w64 GCC/G++, GNU Make, and the Visual C++ runtime | ||
| automatically into the project environment from the Windows dependencies in | ||
| `pyproject.toml`. |
There was a problem hiding this comment.
This is a Claude comment of what changed, but we dont need.
| [tool.pixi.target.win-64.dependencies] | ||
| cmake = "==3.26.0" | ||
| vc14_runtime = "*" | ||
| # MinGW-w64 toolchain for acados; exact package builds are pinned in pixi.lock. |
There was a problem hiding this comment.
Exact packages should not be pinned in the lock file. The lock file is only for reproducability. If we need exact packages, pin them here.
| !!! note | ||
| Be careful when flying the drone! Make sure to kill the process (**Ctrl+C**) immediately when your controller is unstable. | ||
|
|
||
| ### Native Windows 10/11 (x86-64, not recommended) |
There was a problem hiding this comment.
Since this is properly integrated now, this can be combined with the ubuntu install above. Like, git is already listed as a prerequisite and the clone and pixi steps are identical. We should just point out what doesnt work, like, does GPU work, does deployment work (most likely not) etc. In those cases, we can add something like I propose above
There was a problem hiding this comment.
Install deployment environment (deploy controller to real drones, Ubuntu only)
If this is the case.
|
|
||
| We also provide a dev container for the simulation environment. However, this is not recommended, since it's heavy and only supports software rendering at the moment. If you're using Windows, make sure to install [WSL](https://docs.microsoft.com/en-us/windows/wsl/install) and [Docker Desktop](https://docs.docker.com/desktop/windows/install/) with WSL integration. Refer to the `Using Docker` section below for more details. | ||
|
|
||
| #### Simulation & Hardware on our Lab PC (If Necessary) |
There was a problem hiding this comment.
why this is If nessary? don't we prefer students to deploy on lab PCs? @ratheron
There was a problem hiding this comment.
I agree, the (If Necessary) can be removed imo
There was a problem hiding this comment.
these two lines, a robostack env is not something that student need to install before setting up the repo env, the robotstack is installed via pixi install -e deploy, I suggest to remove this line. And also the line for docker, since we don't support it anymore I guess? @ratheron
There was a problem hiding this comment.
Docker, yes. Robostack, we should still hint what the env is
There was a problem hiding this comment.
not a fan of putting these here, confusing: "should I execute these commands or not?", I would cover this in the simulation env setup below
There was a problem hiding this comment.
we don't need -r now, rendering option is in the config file
|
I reconstruct the whole setup.md and fix some lines in simulation.md and deployment.md, tell me what do you think this new version. I think it is clearer. @ratheron |
ratheron
left a comment
There was a problem hiding this comment.
I like the overall structure of the new setup.md. Added some comments on the deployment.md

support native windows, including acados setup, verified on my win11 pc, I will verify again on my laptop. The simulation seems very smooth in the renderer.
A MinGW-w64 toolchain is introduced to compile acados and MPC solver DLLs.