Skip to content
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.

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

Update setting-up-sitl-on-linux.rst #5970

Closed
wants to merge 1 commit into from

Conversation

stevenjowens
Copy link

Clarified -w option.

Removed --console and --map from sim_vehicle.py example because GUI dependencies are not included in the SITL docker instance.

Added note about using --no-mavproxy.

Clarified -w option.

Removed --console and --map from sim_vehicle.py example because GUI dependencies are not included in the SITL docker instance.

Added note about using --no-mavproxy.
@Hwurzburg
Copy link
Contributor

strongly disagree with the changes about removing the console and map options....this page is a native Linux setup which includes installation of ALL necessary components for the GUI elements...not a DOCKER based page...the minor tweaking of the -w wording is fine but really the first run should be : sim_vehicle.py --map --console -w to avoid unnecessary restarts....feel free to change to this....

@stevenjowens
Copy link
Author

stevenjowens commented May 12, 2024

this page is a native Linux setup

That's an excellent point. I started here:
https://ardupilot.org/dev/docs/sitl-simulator-software-in-the-loop.html
which links to:
https://ardupilot.org/dev/docs/setting-up-sitl-on-linux.html
which says "Please follow the instructions in Setting up the Build Environment (Linux/Ubuntu) to set up the full environment, including SITL." and links to:
https://ardupilot.org/dev/docs/building-setup-linux.html#building-setup-linux

I followed the section on building-setup-linux titled "Setup using Docker", then went back to:
https://ardupilot.org/dev/docs/setting-up-sitl-on-linux.html
Which then walks you through starting sim_vehicle.py, and tells you to use the --console and --map parameters, which of course doesn't work in the docker SITL.

So tell me where the information should be and I'll make that edit. Either setting-up-sitl-on-linux needs two two subsections under "Starting SITL simulator", one for native linux and one for docker, or there needs to be a separate page somewhere for starting SITL under docker.

@Ryanf55
Copy link
Contributor

Ryanf55 commented May 12, 2024

I would add info in the "Setup using Docker" section that docker is not recommended unless you want isolated environments or your host environment is not what you want to develop in.

Given the wiki hardly mentions docker, and has tons of other things that need exposed to work for a full IDE, and we don't have a VSCode devcontainer, I honestly wouldn't recommend anyone use docker except for CI.

@Hwurzburg
Copy link
Contributor

@Ryanf55 I agree....I think we should have:

  1. A note on the Docker section saying that it is not recommended unless an isolated environment is needed
  2. the startup instructions compressed to a single command as I suggest
  3. a warning that the map and console options wont work in a Docker situation
    see add warning notes on Docker setups #5972 and we can close this.... @stevenjowens thanks for bringing the Docker issue up

@Hwurzburg
Copy link
Contributor

closing since #5972 now merged

@Hwurzburg Hwurzburg closed this May 14, 2024
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.

None yet

3 participants