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

Remove the scalar and vector keywords from data names in configuration #142

Merged
merged 4 commits into from
Jan 21, 2025

Conversation

IshaanDesai
Copy link
Member

@IshaanDesai IshaanDesai commented Jan 16, 2025

The scalar and vector keyword values for data name dictionaries are no longer necessary as the preCICE v3.x API does not distinguish between the data dimensions it works with. No functionality in the Micro Manager relies on this user information.

Checklist:

  • I made sure that the CI passed before I ask for a review.
  • I added a summary of the changes (compared to the last release) in the CHANGELOG.md.
  • If necessary, I made changes to the documentation and/or added new content.
  • I will remember to squash-and-merge, providing a useful summary of the changes of this PR.

@IshaanDesai IshaanDesai self-assigned this Jan 16, 2025
@IshaanDesai IshaanDesai changed the title Remove the scalar and vector keywords that are required for each data name Remove the scalar and vector keywords from data names in configuration Jan 16, 2025
@IshaanDesai IshaanDesai added the breaking change A change will break backwards compatibilty label Jan 16, 2025
@IshaanDesai
Copy link
Member Author

The two-scale heat conduction tutorial case produces reasonable results:

Screenshot from 2025-01-16 17-17-16

@IshaanDesai IshaanDesai marked this pull request as ready for review January 16, 2025 16:18
@IshaanDesai IshaanDesai requested a review from uekerman January 16, 2025 16:18
Copy link
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

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

LGTM. I did not test anything though.
Requires also updates to the tutorials.

docs/configuration.md Outdated Show resolved Hide resolved
Comment on lines +106 to +107
self._write_data_names, list
), "Write data entry is not a list"
Copy link
Member

Choose a reason for hiding this comment

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

Once we have the schema, such error message will no longer be needed 😊

@IshaanDesai IshaanDesai merged commit a436880 into develop Jan 21, 2025
10 checks passed
@IshaanDesai IshaanDesai deleted the remove_data_spec branch January 21, 2025 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change A change will break backwards compatibilty
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants