Initial version - #5

Open

gerritdrost wants to merge 19 commits into

mainfrom

initial-version

gerritdrost commented Aug 6, 2026

Merge instructions

This PR is a merger of work by @Mahmuttumkaya, @wei-qiang and me. A merge without squash has our preference as it retains authorship of the code, which has our preference.

From now on we aim to provide concise PR's which can then be squash merged.

Changes in this PR

Java project that implements a wrapper to the PGM C library. Currently implemented:

a Gradle build pipeline that downloads PGM binaries and headers and uses JExtract to generate a wrapper
Java code to:
- automatically load the included PGM binaries for supported platforms,
- OR check if (a manually loaded) PGM binary is available, and optionally if version matches the ones of the headers used to generate the Java wrapper (for all unsupported platforms that do support C and Java)
automatic application of code style and license headers in Java files
basic CI pipeline that builds the project, performs code style checks and runs unit tests
A Java translation of the PGM example (power_grid_model_c_example/main.c)

Future improvements

A non-exhaustive list of things we should improve in the future:

clean up the build setup (move the custom tasks into a buildSrc-dir, which would clean up the mess in build.gradle)
automatic application of license headers in non-Java files
write/improve documentation

gerritdrost and others added 14 commits

August 4, 2026 15:24


          Initial commit of java/gradle project

Signed-off-by: Gerrit Drost <gerrit.drost@alliander.com>


          Work on automatically generating wrapper using JExtract

f6bf4cb

Signed-off-by: Mahmut Tumkaya <mahmut.tumkaya@alliander.com>


          First attempt at building using gradle.

eccd04d

Signed-off-by: Gerrit Drost <gerrit.drost@alliander.com>


          Fully working code generation for PGM wrapper using JExtract in gradle

c8073eb

Signed-off-by: Mahmut Tumkaya <mahmut.tumkaya@alliander.com>


          Getting Java code for loading/checking PGM ready for production

6a83c42

Signed-off-by: Gerrit Drost <gerrit.drost@alliander.com>


          Add and apply checkstyle and PMD

523aae1

Signed-off-by: Wei-Qiang Zhou <wei-qiang.zhou@alliander.com>


          Move example class to lfenergy package

e6d2b7d

Signed-off-by: Gerrit Drost <gerrit.drost@alliander.com>


          Introduce spotless

30dd17b

- uses DSA code style (through eclipse code style file)
- adds licence header to all Java files

Signed-off-by: Wei-Qiang Zhou <wei-qiang.zhou@alliander.com>


          Add license header to gradle files (#2)

4eeed0a

- Add license header to gradle files
- Remove license header from gradle-wrapper.properties

Signed-off-by: Wei-Qiang Zhou <wei-qiang.zhou@alliander.com>


          GitHub actions (#3)

6accce4

- Add github workflow
- Move fileTree call out of doLast
- Add license header
- Remove author and description in actions

Signed-off-by: Wei-Qiang Zhou <wei-qiang.zhou@alliander.com>


          Update gradle wrapper

1a808f2

Signed-off-by: Gerrit Drost <gerrit.drost@alliander.com>


          Fix root project name

bedd8a3

Signed-off-by: Gerrit Drost <gerrit.drost@alliander.com>


          Rename last occurence of jpgm to libpower-grid-model-java in exceptio…

fe5ce1f

…n message

Signed-off-by: Gerrit Drost <gerrit.drost@alliander.com>


          Improve README.md, remove all occurences of pgm-template-repo

3e49eaa

Signed-off-by: Gerrit Drost <gerrit.drost@alliander.com>

TonyXiang8787 mentioned this pull request

Initial version of libpower-grid-model-java #4

Closed

TonyXiang8787 added the feature label

gerritdrost commented

View reviewed changes

.github/actions/setup-runtime/action.yml Outdated

gerritdrost commented

View reviewed changes

config/pmd/ruleset.xml Outdated

gerritdrost commented

View reviewed changes

build.gradle

+                  publications {
+                      mavenJava(MavenPublication) {
+                          from components.java
+                          artifactId = 'lib-power-grid-model'

gerritdrost Aug 6, 2026

Author

Is this name right?


          Remove DSA references

1bb372f

Signed-off-by: Djamel van der Sluis <djamel.van.der.sluis@alliander.com>

gerritdrost deployed to ci

August 14, 2026 07:58

— with

GitHub Actions Active


          Add Apache-2.0 license to gradle wrapper files

7f20ac4

Signed-off-by: Wei-Qiang Zhou <wei-qiang.zhou@alliander.com>

gerritdrost deployed to ci

August 14, 2026 08:32

— with

GitHub Actions Active


          Remove PMD, Checkstyle and Spotless (#9)

319a4e1

Signed-off-by: Wei-Qiang Zhou <wei-qiang.zhou@alliander.com>

wei-qiang deployed to ci

August 20, 2026 12:44

— with

GitHub Actions Active

nitbharambe reviewed

View reviewed changes

.github/workflows/java-gradle-ci.yml

Comment on lines +31 to +32

		id-token: write # Needed to load credentials
		contents: read # Needed to read repository (content)

nitbharambe Aug 21, 2026

Member

These are unused right?

nitbharambe reviewed

View reviewed changes

.github/workflows/java-gradle-ci.yml

+                  env:
+                    LOCAL_IMAGE_TAG: ${{ inputs.local_image_tag }}
+                    DEPLOY_BRANCH: ${{ inputs.deploy_branch }}
+                    IMAGE_REPOSITORY_PREFIX: ${{ inputs.image_repository_prefix }}${{ inputs.namespace }}

nitbharambe Aug 21, 2026 •

edited

Loading

Member

These inputs aren't mentioned above.
And the env variables are unused as well?

nitbharambe reviewed

View reviewed changes

.github/workflows/java-gradle-ci.yml

Comment on lines +70 to +78

+                    - name: Create Build Tag
+                      id: create_tag
+                      uses: ./.github/actions/create-build-tag
+                    - name: Repository Name
+                      id: repo
+                      shell: bash
+                      run: |
+                        echo "name=${GITHUB_REPOSITORY#*/}" >> "$GITHUB_OUTPUT"

nitbharambe Aug 21, 2026

Member

Maybe this and the create-build-tag action is unused as well.


          Add Reuse in workflow Java Gradle CI (#15)

533c2f4

Add a reusable-workflow job in java gradle ci to execute reuse-compliance as part of the main CI pipeline

Signed-off-by: Mahmut Tumkaya <mahmut.tumkaya@alliander.com>

Mahmuttumkaya deployed to ci

August 21, 2026 08:18

— with

GitHub Actions Active

nitbharambe commented Aug 21, 2026

Member

Great PR! This would concludes DGC's review on things apart from java things.
Feel free to remove the checklist from README when done.

Maybe already addressed and answered:
Regarding licenses automatically applying: a .license file can be added for the expected files instead which serves as fallback for the inital header comments on file. If the file name itself is changing, then maybe it can be handled via CI.


          Set distribution to temurin (#10)

83c534d

Signed-off-by: Wei-Qiang Zhou <wei-qiang.zhou@alliander.com>

gerritdrost deployed to ci

August 21, 2026 08:27

— with

GitHub Actions Active

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

Labels