-
Notifications
You must be signed in to change notification settings - Fork 2
remove scripting api's marked as unused #9
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
1df78af
remove scripting api's marked as unused
adamkorynta 2d92df3
update README.md
adamkorynta f39abb0
remove unused transitive dependencies
adamkorynta 65a8526
update to use gradle action for dedicated caching
adamkorynta 80fec2c
add in dependency submission for gradle SBOM generation
adamkorynta 8a38a84
remove example scripts of removed API's
adamkorynta 269cc39
code review updates
adamkorynta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| version: 2 | ||
|
|
||
| updates: | ||
| - package-ecosystem: "gradle" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| open-pull-requests-limit: 5 | ||
|
|
||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| open-pull-requests-limit: 5 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| name: Gradle CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| pull_request: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| build: | ||
| name: Build and test | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v7 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Set up Java | ||
| uses: actions/setup-java@v5 | ||
| with: | ||
| distribution: temurin | ||
| java-version: 21 | ||
|
|
||
| - name: Set up Gradle | ||
| uses: gradle/actions/setup-gradle@v6 | ||
|
|
||
| - name: Make Gradle wrapper executable | ||
| run: chmod +x ./gradlew | ||
|
|
||
| - name: Build and test | ||
| run: ./gradlew clean build | ||
|
|
||
| dependency-submission: | ||
| name: Submit Gradle dependencies | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
| permissions: | ||
| contents: write | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v7 | ||
|
|
||
| - name: Set up Java | ||
| uses: actions/setup-java@v5 | ||
| with: | ||
| distribution: temurin | ||
| java-version: 21 | ||
|
|
||
| - name: Set up Gradle | ||
| uses: gradle/actions/setup-gradle@v6 | ||
|
|
||
| - name: Submit Gradle dependencies | ||
| uses: gradle/actions/dependency-submission@v6 | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,75 @@ | ||
| # REGI-Headless | ||
|
|
||
| This is a temporary readme file and will be updated in the future. | ||
| > [!IMPORTANT] | ||
| > **Notice: Project Refactor in Progress** | ||
| > This project is undergoing a large refactor for [CWMS Data API](https://github.com/USACE/cwms-data-api) support. | ||
| > It will transition from a Java project consuming Jython scripts to a **Python project** that | ||
| > utilizes **JPype** to call underlying REGI Java libraries. | ||
|
|
||
| `REGI-Headless` is a Java-based command-line tool and library designed to run | ||
| **REGI** calculations in a headless environment. | ||
| It allows users to execute complex hydrological calculations and manage gate settings via Jython | ||
| scripts without the need for a graphical interface. | ||
|
|
||
| ## Features | ||
|
|
||
| - **Headless Execution**: Run REGI calculations as part of automated workflows or on servers. | ||
| - **Database Integration**: Connects to CWMS data retrieval and storage. | ||
| - **Modular Calculations**: Includes support for: | ||
| - Inflow calculations (Clone, Compute, Auto-Adjust, Balance All, etc.) | ||
| - Flow Group and gate settings calculations. | ||
|
|
||
| ## Project Structure | ||
|
|
||
| - `regi-headless/`: Core Java implementation, including `RegiCLI`. | ||
| - `district-scripts/`: Example scripts and district-specific configurations. | ||
| - `docs/`: Additional documentation. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Java JDK 21 or higher. | ||
|
|
||
| ### CWMS Data API Configuration | ||
|
|
||
| The library reads the following environment variables when establishing the CWMS Data API data source: | ||
|
|
||
| - `CDA_URL`: Base URL for the CWMS Data API endpoint. | ||
| - `API_KEY`: API key used for CWMS Data API authentication and authorization. | ||
| - `OFFICE_ID`: CWMS office identifier used to scope the session. | ||
|
|
||
| The factory uses these values to authenticate, resolve the current user, and persist the connected office and time zone into the REGI project. | ||
|
|
||
| ### Building | ||
|
|
||
|
|
||
| ```powershell | ||
| ./gradlew build | ||
| ``` | ||
|
|
||
| Details TBD. | ||
|
|
||
| ## Usage | ||
|
|
||
| TBD | ||
|
|
||
| ### Command Line Options | ||
|
|
||
| TBD | ||
|
|
||
| ### Example | ||
|
|
||
| TBD | ||
|
|
||
| ## Testing | ||
|
|
||
| TBD | ||
|
|
||
| ## Maintainers | ||
|
|
||
| See [MAINTAINERS.md](MAINTAINERS.md) for a list of project maintainers. | ||
|
|
||
| ## License | ||
|
|
||
| See [LICENSE](LICENSE) for licensing information. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 0 additions & 18 deletions
18
buildSrc/src/main/groovy/regi-headless.deps-conventions.gradle
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,6 @@ | ||
|
|
||
| def checkForNexusCredentials() { | ||
| if(!project.hasProperty('nexusUser')) { | ||
| println ('Please set the nexusUser property in the GRADLE_USER_HOME ($userHome/.gradle/gradle.properties) file or via -PnexusUser= .') | ||
| } | ||
| if(!project.hasProperty('nexusPassword')) { | ||
| println ('Please set the nexusPassword property in the GRADLE_USER_HOME ($userHome/.gradle/gradle.properties) file or via -PnexusPassword= .') | ||
| } | ||
| } | ||
|
|
||
| repositories { | ||
| maven { | ||
| url 'https://www.hec.usace.army.mil/nexus/repository/maven-public' | ||
| } | ||
| maven { | ||
| url 'https://www.hec.usace.army.mil/nexus/repository/hec-internal' | ||
| credentials { | ||
| checkForNexusCredentials() | ||
| username "$nexusUser" | ||
| password "$nexusPassword" | ||
| } | ||
| } | ||
| mavenCentral() | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.