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

Make STEMMUS_SCOPE BMI-able #208

Merged
merged 17 commits into from
Jan 3, 2024
Merged

Make STEMMUS_SCOPE BMI-able #208

merged 17 commits into from
Jan 3, 2024

Conversation

BSchilperoort
Copy link
Contributor

@BSchilperoort BSchilperoort commented Nov 16, 2023

Description

This PR will make STEMMUS_SCOPE compatible with a full BMI implemented in Python.

The documentation on this is still to-do (once PyStemmusScope has the BMI implemented EcoExtreML/STEMMUS_SCOPE_Processing#89)

Checklist

  • Add a reference to related issues.
  • @mentions of the person or team responsible for reviewing proposed changes.
  • This pull request has a descriptive title.
  • Code is written according to the guidelines.
  • The checks by MISS_HIT style checker and linter, below the pull request, are successful (green).
  • Documentation is available.
  • Add changes to the changelog file under section Unreleased.
  • Model runs successfully.
  • Ask a maintainer to re-generate exe file if matlab codes are changed. About how to create an exe file, see exe readme.

@BSchilperoort BSchilperoort added this to the save/load model state milestone Nov 16, 2023
@BSchilperoort BSchilperoort changed the title Split up in init/ipdate/finalize, save&load state. Make STEMMUS_SCOPE BMI-able Nov 16, 2023
@BSchilperoort
Copy link
Contributor Author

@SarahAlidoost first local test of running the model's initialization, update and finalize steps separately seems to be successful! Thanks for the hard work of cleaning up the code and removing all globals 🥳

src/STEMMUS_SCOPE.m Outdated Show resolved Hide resolved
Copy link
Member

@SarahAlidoost SarahAlidoost left a comment

Choose a reason for hiding this comment

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

@BSchilperoort nice work, thank you. I was able to run the model using the source code. In general, the BMI implementation is awesome. Just some minor comments, meantime, I am going to test the exe file with a new version of rutime 😄

@BSchilperoort
Copy link
Contributor Author

BSchilperoort commented Dec 20, 2023

I've adressed all your comments @SarahAlidoost, and made some other changes I wanted to make.

You can now start the BMI mode without passing in a valid config:

./STEMMUS_SCOPE "" bmi

The config is then passed with initialize:

> Finished command. Select run mode: 
initialize "/path/to/cfg.txt"

Copy link
Member

@SarahAlidoost SarahAlidoost left a comment

Choose a reason for hiding this comment

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

@BSchilperoort thanks, please see my comments on new changes and one old comment here.

@SarahAlidoost
Copy link
Member

The config is then passed with initialize:

./STEMMUS_SCOPE "" initialize "/path/to/cfg.txt"

this command is not correct. It returns error:

Error using STEMMUS_SCOPE_exe
Too many input arguments.

MATLAB:TooManyInputs

@BSchilperoort
Copy link
Contributor Author

Thanks for the review! I have committed your suggestions and addressed your comments.

Copy link
Member

@SarahAlidoost SarahAlidoost left a comment

Choose a reason for hiding this comment

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

@BSchilperoort awesome 👍 thanks for fixing the issues, feel free to merge 🚀

@BSchilperoort BSchilperoort merged commit 0c5e75a into main Jan 3, 2024
1 check passed
@BSchilperoort BSchilperoort deleted the BMI-compatible branch January 3, 2024 13:04
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.

2 participants