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

#15861 Update documentation on dockerized SUMO #16007

Merged
merged 6 commits into from
Jan 30, 2025

Conversation

Menkalian
Copy link
Contributor

@Menkalian Menkalian commented Jan 14, 2025

I updated the developer documentation on Docker and added a tutorial on the basic usage in docker (and fixed a unsatsified link error occurring in the container).

I tried to get an example with a GUI working, but I did not get it to work reproducible.

I hope I managed to hit the right tone for the docs.

closes #15861

@Menkalian Menkalian changed the title # #15861 Update documentation on dockerized SUMO Jan 14, 2025
@Menkalian
Copy link
Contributor Author

@uekerman FYI

@namdre namdre requested a review from behrisch January 14, 2025 05:55
@behrisch behrisch self-assigned this Jan 14, 2025
@Menkalian
Copy link
Contributor Author

I found a small issue in the docker image, that prevented sumo from executing. The new commit fixes that.

@behrisch
Copy link
Contributor

@Menkalian Thanks a lot! Instead of mangling with the ld path, I think it might be easier to install jupedsim directly into the system since we are dockerized anyway. What do you think?

@Menkalian
Copy link
Contributor Author

Menkalian commented Jan 22, 2025

@Menkalian Thanks a lot! Instead of mangling with the ld path, I think it might be easier to install jupedsim directly into the system since we are dockerized anyway. What do you think?

@behrisch Yeah, that's probably more the "docker" way. I was not sure if there was a specific reason for keeping a separate install directory, but it might just be a remnant from some previous work.

I will take a look at it.

If I find any further improvements for the docker image (e.g. smaller size, adding some meta information, checking with best practices, ...), would you prefer for me to add it in this PR or open a separate issue and PR? I'm fine with either way.

@Menkalian
Copy link
Contributor Author

I have now adapted the whole Dockerfile, so the resulting image is smaller (instead of 8.5 GB it's now around 4.2 GB), contains Metadata and has jupedsim installed in the system environment.

@Menkalian
Copy link
Contributor Author

Hey there,
Just wanted to ask whether there is something missing from my side for review/merge of this PR. I know some of the actions failed, but as far as I could tell, these were not caused by me.
Please give me a hint, if I have to fix them or add anything to this PR. Thanks 🙂 !

@behrisch behrisch merged commit 91709d3 into eclipse-sumo:main Jan 30, 2025
49 of 55 checks passed
@behrisch
Copy link
Contributor

Thanks a lot! This will help many people. I was a little unsure whether the tutorial should refer to "bleeding edge" main. Maybe it would be better to use "latest" here. What do you think?

@Menkalian
Copy link
Contributor Author

The reason I chose main instead of latest was, that latest did not work when I tested it (the jupedsim path problem) and I wanted the tutorial to work as soon as it was merged.
Generally speaking, I agree that using the more stable version latest should be the preferred way. Maybe that could be updated when a new version of latest is available.

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.

Update Developer Documentation for Dockerized SUMO
2 participants