REopt_API icon indicating copy to clipboard operation
REopt_API copied to clipboard

Tracking for API -> REopt.jl

Open Bill-Becker opened this issue 9 months ago • 0 comments

This PR adds tracking information to pass to REopt.jl which calls the REoptTracking API for user and run tracking.

Below was generated from Github Copilot and is a little verbose and unnecessary.

This pull request introduces updates to the REopt.jl integration, including changes to dependency configuration, new metadata fields, and enhancements to the run_jump_model function. The most important changes focus on improving metadata handling and enabling better API and web tool support.

Updates to dependency configuration:

  • julia_src/Manifest.toml: Updated the REopt dependency to include a new repo-rev (track-api) and repo-url pointing to the official repository. This ensures the latest version of the code is used.

Enhancements to metadata handling:

  • reoptjl/models.py: Added a new portfolio_uuid field to the metadata dictionary, allowing for better tracking of portfolio-level data.

Improvements to the run_jump_model function:

  • reoptjl/src/run_jump_model.py: Enhanced the run_jump_model function to:
    • Add support for distinguishing between web tool runs and direct API runs using new flags (webtool_run and direct_api_run).
    • Include additional metadata fields (webtool_user_uuid, webtool_portfolio_uuid, and api_run_uuid) for improved traceability.
    • Added a debug print statement to display the Settings dictionary for easier debugging.

Bill-Becker avatar Apr 19 '25 03:04 Bill-Becker