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 setup opt-carma script according to install guide #2449

Merged
merged 2 commits into from
Oct 17, 2024

Conversation

MishkaMN
Copy link
Contributor

@MishkaMN MishkaMN commented Oct 10, 2024

PR Details

Description

During creation of CDASim comprehensive tutorial guide, I needed to include a step to setup CARMA. That writeup prompted opportunity to clean up our script that is referenced in our CARMA installation guide here: https://usdot-carma.atlassian.net/wiki/spaces/CRMPLT/pages/488472599/Setup+CARMA+Platform+Runtime

Changes include:

  • No longer downloads autoware.ai just to copy its yolo contents. CARMA doesn't use camera at the moment so it is not needed. That repo is almost 400 MB+ so it is not ideal.
  • Added support for setting up common static folders needed for CDASim because it is not documented anywhere, and my current write-up and existing installation guide will include them.

Related GitHub Issue

NA

Related Jira Key

https://usdot-carma.atlassian.net/browse/CXC-94

Motivation and Context

I am writing CDASim tutorial guide. And its configuration step required some changes to our installation guides, which I discovered these issues.

How Has This Been Tested?

local integration tested by calling scripts in #2449
and building images locally

Types of changes

  • Defect fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that cause existing functionality to change)

Checklist:

  • I have added any new packages to the sonar-scanner.properties file
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
    CARMA Contributing Guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@MishkaMN MishkaMN requested a review from adev4a October 10, 2024 19:39
@MishkaMN MishkaMN self-assigned this Oct 10, 2024
@MishkaMN MishkaMN added the enhancement New feature or request label Oct 10, 2024
Copy link

sonarcloud bot commented Oct 10, 2024

@MishkaMN MishkaMN requested a review from adev4a October 11, 2024 19:27
if [ "$ADD_SIM_FOLDER" == "true" ]; then
echo "Adding folders used for CDASim to be able to save logs"
mkdir -p /opt/carma/logs/carma_1 /opt/carma/logs/carma_2 /opt/carma-simulation/logs /opt/carma-simulation/scripts /opt/carma-streets/scripts
sudo chgrp -R $GRP_ID /opt/carma/
Copy link
Contributor

@adev4a adev4a Oct 12, 2024

Choose a reason for hiding this comment

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

MishkaMN added a commit to usdot-fhwa-stol/carma-config that referenced this pull request Oct 14, 2024
<!-- Thanks for the contribution, this is awesome. -->

# PR Details
## Description
This PR fixes multiple issues related to having carma start out of the
box following the CARMA install guide.
- Updated example_calibration_folder to include trajectory_follower
folder so that carma doesn't shut down automatically not being able to
find the file.
- Removed the annoying `git checkout docker-compose.yml
docker-compose-background.yml` commands that overwrites any developer
changes locally. This prompted little factorizaton to reduce code
duplication if separate if clauses.
- Fixed a syntax error introduced in this PR recently:
#388

This also supports opt/carma folder setup script here:
usdot-fhwa-stol/carma-platform#2449

NOTE: This repo does need some improvements in general which I didn't
address here:
- build-image.sh script (possibly more) is largely the same in all
folders and may need code refactoring to reduce duplication
- not sure if `-d` option is really useful or operational anymore after
we introduced `.env` to handle docker org and tags.
<!--- Describe your changes in detail -->

## Related Issue
https://usdot-carma.atlassian.net/browse/CXC-94
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an
issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps
to reproduce -->
<!--- Please link to the issue here: -->

## Motivation and Context
I am writing CDASim tutorial guide. And its configuration step required
some changes to our installation guides, which I discovered these
issues.
<!--- Why is this change required? What problem does it solve? -->

## How Has This Been Tested?
local integration tested by calling scripts in
usdot-fhwa-stol/carma-platform#2449
and building images locally
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [X] Defect fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that cause existing functionality
to change)

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->

- [ ] I have added any new packages to the sonar-scanner.properties file
- [X] My change requires a change to the documentation.
- [X] I have updated the documentation accordingly.
- [X] I have read the **CONTRIBUTING** document.
[CARMA Contributing
Guide](https://github.com/usdot-fhwa-stol/carma-platform/blob/develop/Contributing.md)
- [X] I have added tests to cover my changes.
- [X] All new and existing tests passed.
@MishkaMN MishkaMN requested a review from adev4a October 17, 2024 16:14
@MishkaMN MishkaMN merged commit 5227889 into develop Oct 17, 2024
4 checks passed
@MishkaMN MishkaMN deleted the feature/update-setup-opt-script branch October 17, 2024 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants