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

Add Windows installation #34

Merged
merged 5 commits into from
Jan 21, 2021
Merged

Add Windows installation #34

merged 5 commits into from
Jan 21, 2021

Conversation

mabelzhang
Copy link
Contributor

Redo of #32............ Is third try the charm?

Copy of description:

Partially addresses gazebosim/docs#117

I haven't added a tutorial page to address this other issue gazebosim/docs#14 (comment) , since ign-tools is "tricky"? Do we want a tutorial page for it?

…inary install; dos2unix

Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
@mabelzhang mabelzhang requested a review from JShep1 January 8, 2021 01:21
@mabelzhang mabelzhang requested a review from caguero as a code owner January 8, 2021 01:21
@github-actions github-actions bot added 🏢 edifice Ignition Edifice 🏰 citadel Ignition Citadel 🔮 dome Ignition Dome labels Jan 8, 2021
@mabelzhang
Copy link
Contributor Author

Now I know how to read the colorful labels on the right.

Copy link

@JShep1 JShep1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, should we perhaps have a note indicating that the ign command line utilities are currently building, but not functional for Windows?

@mabelzhang
Copy link
Contributor Author

Do you think it'll be fixed in the short term (since you're looking into it), or do you expect it to be there for the long term? Maybe we don't need to add it if you have to remember to remove it in a week or two.

@JShep1
Copy link

JShep1 commented Jan 8, 2021

Do you think it'll be fixed in the short term (since you're looking into it), or do you expect it to be there for the long term? Maybe we don't need to add it if you have to remember to remove it in a week or two.

I just took a quick look, I built ign-tools from source on Windows and it generates a ign ruby script which can be run with ruby ign, although installing or sourcing the workspace built with colcon does not allow this ruby command to find the necessary yaml files.

This is likely due to the searched directory being C:/Program Files (x86)/ignition-tools/share/ignition/, I manually modified the file to search the actual install directory C:/Users/asus/test-ws/install/share/ignition and the commands for the built packages were found. I think this should be a quick fix....

--- Edit ---

Ahh, so I guess I had to specify my own CMAKE_INSTALL_PREFIX with the flag when I built the package. Maybe we should make it more clear what CMAKE_INSTALL_PREFIX is in these tutorials to save beginning users (and advanced users) time on trying to figure out why the command line tools aren't working. Perhaps we could reference this in a more general doc like https://github.com/ignitionrobotics/docs/blob/master/citadel/troubleshooting.md and just link to it here

@JShep1
Copy link

JShep1 commented Jan 8, 2021

The problem to solve after the above mentioned one is to have the ign command line utility usable after the environment is sourced with call install\setup.bat, which I haven't spent time on yet so I'm unsure why exactly this is occurring.

Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
@mabelzhang
Copy link
Contributor Author

mabelzhang commented Jan 8, 2021

Thanks for looking into it! I added a note in c197106 for now.
Feel free to add a troubleshoot section to the guide you linked. Sounds good.

Did you have to set CMAKE_INSTALL_PREFIX to something specific? For each library, I only compiled SOME (if any) of its dependencies from source, so I had CMAKE_INSTALL_PREFIX set to the directory where the previous library was compiled from source. Since most of my libraries were installed from conda-forge (for the sake of writing the per-library tutorials), it wasn't uniform across all the libraries. Maybe you have a better idea from a full source install.

Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
@JShep1
Copy link

JShep1 commented Jan 16, 2021

Yes, I had to specify where the directory where the previous library was compiled for CMAKE_INSTALL_PREFIX, colcon makes this a lot more simplified.

Additionally, the ign command line utility works only so far as locating the commands that each package provides, at this point, attempting to invoke any of the command line utilities results in a ruby crash having to do with (I think) the loading of the ignition shared object file, I believe @chapulina mentioned this might have to do with the ruby versions that the ruby scripts are built with?

nit
Signed-off-by: John Shepherd <john@openrobotics.org>
@JShep1 JShep1 merged commit c1a3b26 into ign-tools1 Jan 21, 2021
@JShep1 JShep1 deleted the mabelzhang/windows_install branch January 21, 2021 01:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants