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

Sofast Command Line Update #242

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

braden6521
Copy link
Collaborator

Purpose

Fixed the out-of-date SofastCLI script to reflect changes made to the ProcessedSofastFixed class. Also added more documentation where lacking or nonexistent.

Summary of changes

  • Fixed how ProcessedSofastFixed was instantiated and called
  • Added module docstring
  • Make "help" command
  • Added inline documentation to help with user input at bottom of file.

Implementation notes

Ran a simple Laptop SOFAST case on Braden's laptop

Submission checklist

  • Target branch is develop, not main
  • Existing tests are updated or new tests were added
  • opencsp/test/test_DocStringsExist.py are verified to include this change or have been updated accordingly
  • .rst file(s) under doc/ are verified to include this change or have been updated accordingly

Additional information

This function is in contrib/. Therefore, there are no unit tests and no readthedocs documentation.

@braden6521 braden6521 marked this pull request as ready for review February 19, 2025 20:10
@braden6521 braden6521 requested a review from rcbrost February 19, 2025 20:12
@braden6521 braden6521 added the enhancement New feature or request label Feb 19, 2025
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.

1 participant