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

Improve setup script experience #183

Merged
merged 5 commits into from
Jul 2, 2024
Merged

Improve setup script experience #183

merged 5 commits into from
Jul 2, 2024

Conversation

sea-bass
Copy link
Owner

@sea-bass sea-bass commented Jun 28, 2024

This PR removes all the extra arguments from the pyrobosim setup and source scripts, using prompts instead to guide the installation, and an environment file named pyrobosim.env to collect persistent user data in the form of environment variables.

Try it out!

Closes #181

Copy link

github-actions bot commented Jun 28, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
__init__.py00100% 
core
   __init__.py90100% 
   dynamics.py430100% 
   gazebo.py136894%55, 124, 230, 244–248
   hallway.py731086%59, 61, 63, 96, 158, 196–199, 205
   locations.py1262183%53, 55, 69, 84–85, 87, 98–99, 101–102, 119, 177, 192, 217, 227, 273, 284–285, 287–288, 312
   objects.py69494%78, 106, 137, 197
   robot.py2144877%140–141, 203, 216, 263, 277–278, 282, 286, 292–293, 295–296, 313–314, 342, 344–345, 366–367, 370–373, 376–378, 403, 407–409, 411, 413–416, 431, 439, 444–445, 448, 468–469, 476, 485, 488, 493, 506
   room.py48197%113
   world.py57113975%146–147, 183–184, 188, 241–242, 244–245, 273–274, 325, 339–340, 342–343, 372–376, 378–380, 382–383, 386, 390–394, 397–399, 402–409, 440, 476–477, 480, 496, 526–527, 538, 541, 563–567, 569–571, 574–575, 578–581, 583, 586, 588–590, 592–594, 596, 615, 625–629, 664–665, 668–671, 688–689, 695–696, 698–699, 701, 703–704, 706, 708–709, 719–720, 723, 725, 739, 741, 748, 795, 826–827, 846–847, 851–852, 887–888, 890, 907–908, 927–931, 943–946, 958–961, 986–987, 989, 1033–1034, 1086, 1166–1167
   yaml_utils.py1061189%64, 68, 152–154, 158–159, 182–183, 207–208
gui
   __init__.py20100% 
   main.py1583279%24, 26, 28–30, 32, 53, 85–86, 189–192, 199–202, 204, 207–213, 217–219, 223–224, 230, 241
   world_canvas.py2305874%29–31, 35–37, 41, 117–118, 124, 126, 128, 191, 195, 246–251, 257–258, 260–262, 267–268, 271, 274–276, 279, 284–285, 287, 314, 336–341, 344, 347–348, 363–365, 368, 385, 414, 432–433, 435–436, 478, 494, 501
manipulation
   __init__.py10100% 
   grasping.py2366174%102, 110–112, 114–122, 124, 132, 462, 464–466, 470–472, 566–568, 571–575, 583, 586–588, 593–594, 600–604, 607–614, 617–619, 628, 630, 632–638
navigation
   __init__.py30100% 
   a_star.py781087%67–72, 74–76, 165
   execution.py34488%46–47, 49–50
   occupancy_grid.py1391489%44–47, 49–53, 56, 192, 226, 234, 238
   path_planner.py26676%33, 36, 38, 42, 85, 90
   planner_base.py591771%29–35, 51, 57–59, 140–145
   prm.py725622%40–44, 46, 50–51, 54, 57–64, 66–67, 76–79, 85, 101–102, 104–109, 111–112, 115–118, 121–126, 135, 144, 154, 156, 158–159, 161, 174–178
   rrt.py172795%228, 353–354, 360–361, 363, 392
   world_graph.py70395%118, 121, 145
planning
   __init__.py00100% 
   actions.py664334%59–60, 62, 66–75, 77–80, 82–86, 88–91, 93–97, 99–100, 102–104, 150–151, 154–158
planning/pddlstream
   __init__.py7185%13
   default_mappings.py90100% 
   planner.py40880%119–126
   primitives.py57296%68, 208
   utils.py85396%66, 99–100
utils
   __init__.py00100% 
   general.py33487%23, 45, 51–52
   knowledge.py1391688%90–91, 100, 135–138, 145, 149–150, 163, 178, 182, 224, 240, 295
   motion.py60690%56, 67–71
   polygon.py1110100% 
   pose.py89396%79, 211, 227
   search_graph.py93396%240–242
   trajectory.py650100% 
TOTAL352959983% 

Tests Skipped Failures Errors Time
168 0 💤 0 ❌ 0 🔥 3m 53s ⏱️

setup/source_pyrobosim.bash Outdated Show resolved Hide resolved
setup/source_pyrobosim.bash Outdated Show resolved Hide resolved
@sea-bass sea-bass changed the title Try fix setup scripts for ROS workflows Improve setup script experience Jun 29, 2024
@sea-bass sea-bass requested a review from eholum June 29, 2024 22:18
@sea-bass sea-bass marked this pull request as ready for review June 29, 2024 22:18
@sea-bass sea-bass requested a review from ibrahiminfinite June 30, 2024 02:41
Copy link
Collaborator

@eholum eholum left a comment

Choose a reason for hiding this comment

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

Definitely simpler! Though I'm not sure what level of error handling and checks you want to put in here.

As I noted in the comment the ROS ws not existing causes silent "failures" but they're not immediately obvious. Those should definitely be checked. Whereas things like me fat fingering a ros distro name probably doesn't matter...

setup/source_pyrobosim.bash Show resolved Hide resolved
setup/setup_pyrobosim.bash Show resolved Hide resolved
@sea-bass sea-bass requested a review from eholum July 2, 2024 01:04
Copy link
Collaborator

@eholum eholum left a comment

Choose a reason for hiding this comment

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

I just have the one note but if you fix that I'm sound as a pound.

setup/setup_pyrobosim.bash Outdated Show resolved Hide resolved
Repository owner deleted a comment from scastro-bdai Jul 2, 2024
@sea-bass sea-bass merged commit 263ee24 into main Jul 2, 2024
7 checks passed
@sea-bass sea-bass deleted the fix-ros-setup branch July 2, 2024 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants