Skip to content

Python usage documentation#236

Open
zack-rma wants to merge 5 commits intomainfrom
docs/python
Open

Python usage documentation#236
zack-rma wants to merge 5 commits intomainfrom
docs/python

Conversation

@zack-rma
Copy link
Contributor

@zack-rma zack-rma commented Mar 6, 2026

Description

Adds documentation describing current Python usages within WRIMS-Engine.

Motivation and Context

Documentation addresses #206

Types of changes

Yes/No Pull Request Type Description
Bug fix non-breaking change which fixes an issue
New feature non-breaking change which adds functionality
Breaking change fix or feature that would cause existing functionality to change
Y Documentation change non-breaking change which modifies or updates documentation
New tests new unit tests, test scenarios, or test case documentation
Triggers regression testing change affects downstream modules and will require regression testing
Other

Notes for Reviewers

Please consider the following when reviewing this PR:

  • Correctness: Does the code do what it claims? Are edge cases handled appropriately?
  • Clarity: Is the code readable, maintainable and aligned with SOLID design principles?
  • Impact: Will this change affect other parts of the system? Any potential regressions?
  • Testing: Are the test cases sufficient and appropriate? Are there gaps in coverage?
  • Documentation: Does this require updates to code comments, README, or other docs?

@zack-rma zack-rma added the documentation Improvements or additions to documentation label Mar 6, 2026
@zack-rma zack-rma changed the title Initial Python usage documentation Python usage documentation Mar 7, 2026
@zack-rma zack-rma marked this pull request as ready for review March 9, 2026 20:47
@zack-rma zack-rma requested a review from rma-psmorris March 9, 2026 20:48
@zack-rma zack-rma moved this to Needs Review in WRIMS 3 Development Mar 9, 2026
[Pull Request #67](https://github.com/CentralValleyModeling/wrims-engine/pull/67).

#### Pros:
- Already integrated as a Gradle dependency.

Choose a reason for hiding this comment

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

This needs to be revised as Graal is in the project as a prototype/proof of concept example. That shouldn't carry much weight went it comes to JEP vs Graal as it is not use in production or test code for engine.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Revised


### Option 3: Maintain the Status Quo

Keep both GraalPy (for tests) and JEP (for `Functionsuitablehabitat`) without change.

Choose a reason for hiding this comment

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

This needs revision given GraalPy is only present as an example

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Revised


#### Pros:
- Zero effort is required immediately.
- GraalPy provides modern Python functionality for future use.

Choose a reason for hiding this comment

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

We arent using it for this yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Revised

exists to validate JEP is currently functioning as intended.
- Requires continued inclusion of an additional DLL file in the WRIMS-GUI project.
- JEP may become stale or incompatible with future Java/Python versions.
- No test coverage exists to validate JEP is currently functioning as intended.

Choose a reason for hiding this comment

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

this is true for all options

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Needs Review

Development

Successfully merging this pull request may close these issues.

2 participants