Skip to content

Commit 6dca551

Browse files
authored
Initial version of java power grid model
Commit includes 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)
1 parent 103d166 commit 6dca551

27 files changed

Lines changed: 2131 additions & 13 deletions
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
2+
#
3+
# SPDX-License-Identifier: MPL-2.0
4+
5+
name: Java & Gradle Setup
6+
description: Setup runtime
7+
8+
inputs:
9+
java_version:
10+
description: 'The Java version to install.'
11+
required: false
12+
default: '25'
13+
gradle_version:
14+
description: 'The Gradle version to install. It do not force using this gradle version in other workflow steps, normally the installed gradle version of the project will be used.'
15+
required: false
16+
default: '9.1.0'
17+
fetch-depth:
18+
description: 'Number of commits to fetch. 0 indicates all history for all branches and tags.'
19+
default: '1'
20+
enable_caching:
21+
description: 'If build and configuration caching should be enabled or disabled.'
22+
default: 'true'
23+
enable_daemon:
24+
description: 'If build should be done using a separate gradle daemon.'
25+
default: 'false'
26+
27+
runs:
28+
using: "composite"
29+
steps:
30+
- name: Checkout code
31+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # 7.0.1
32+
with:
33+
fetch-depth: ${{ inputs.fetch-depth }}
34+
35+
- name: Set up JDK
36+
uses: actions/setup-java@03ad4de0992f5dab5e18fcb136590ce7c4a0ac95 # 5.6.0
37+
with:
38+
java-version: ${{ inputs.java_version }}
39+
distribution: 'temurin'
40+
41+
- name: Setup Gradle
42+
uses: gradle/actions/setup-gradle@3f131e8634966bd73d06cc69884922b02e6faf92 # 6.2.0
43+
with:
44+
gradle-version: ${{ inputs.gradle_version }}
45+
46+
- name: Cache Gradle
47+
if: ${{ inputs.enable_caching == 'true' }}
48+
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 #v6.1.0
49+
with:
50+
path: |
51+
~/.gradle/caches
52+
~/.gradle/wrapper
53+
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties', '**/settings.gradle*') }}
54+
restore-keys: |
55+
${{ runner.os }}-gradle-
56+
57+
- name: Configure Gradle properties
58+
shell: bash
59+
env:
60+
CACHING: ${{ inputs.enable_caching }}
61+
DAEMON: ${{ inputs.enable_daemon }}
62+
run: |
63+
set -euo pipefail
64+
mkdir -p ~/.gradle
65+
{
66+
echo "ci=true"
67+
echo "org.gradle.caching=${CACHING}"
68+
echo "org.gradle.configuration-cache=${CACHING}"
69+
echo "org.gradle.daemon=${DAEMON}"
70+
} >> ~/.gradle/gradle.properties
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
2+
#
3+
# SPDX-License-Identifier: MPL-2.0
4+
5+
name: Java CI with Gradle for library
6+
7+
on:
8+
push:
9+
workflow_dispatch:
10+
11+
concurrency:
12+
group: ${{ github.workflow }}-${{ github.ref }}
13+
cancel-in-progress: true
14+
15+
jobs:
16+
build-and-test:
17+
name: Build & Test
18+
runs-on: ubuntu-latest
19+
outputs:
20+
build_tag: ${{ steps.create_tag.outputs.build_tag }}
21+
environment:
22+
name: ci
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # 7.0.1
26+
with:
27+
fetch-depth: 1
28+
persist-credentials: false
29+
30+
- name: Setup runtime
31+
uses: ./.github/actions/setup-runtime
32+
33+
- name: Cache Gradle
34+
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 #v6.1.0
35+
with:
36+
path: |
37+
~/.gradle/caches
38+
~/.gradle/wrapper
39+
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/settings.gradle*') }}
40+
41+
- name: Optimize Gradle
42+
shell: bash
43+
run: |
44+
mkdir -p ~/.gradle
45+
echo "org.gradle.caching=true" >> ~/.gradle/gradle.properties
46+
echo "org.gradle.configuration-cache=true" >> ~/.gradle/gradle.properties
47+
48+
- name: Build & Run Tests
49+
run: ./gradlew build --configuration-cache
50+
51+
reuse-compliance:
52+
name: REUSE Compliance
53+
uses: ./.github/workflows/reuse-compliance.yml

‎LICENSES/Apache-2.0.txt‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+

‎README.md‎

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,33 @@ SPDX-License-Identifier: MPL-2.0
66

77
[![Power Grid Model logo](https://raw.githubusercontent.com/PowerGridModel/.github/main/artwork/svg/color.svg)](#)
88

9-
# Power Grid Model template repository
9+
# libpower-grid-model-java
10+
11+
## Usage
12+
13+
The PGM methods are available through class `org.lfenergy.pgm.PowerGridModelC`. The method names are identical to the method names in the C-documentation.
14+
15+
To load the native library there are two options:
16+
- on supported architectures, the library can be autoloaded using `PGMLoader.autoload()`
17+
- on other architecture, you can build and load the library yourself using `System.load(...)`, and verify if you've loaded it correctly using `PGMLoader.check()`.
18+
19+
## Supported architectures
20+
21+
- macOS ARM64
22+
- macOS x86-64
23+
- Linux ARM64
24+
- Linux x86-64
25+
- Windows x86-64
1026

11-
This is a template repository for the Power Grid Model project.
12-
Only common and mandatory content is included in this repository.
13-
The derived repositories should review and edit content relevant to the best practices and standards.
1427

1528
## Checklist after creating a repository from this template
1629

1730
Update the following items manually before publishing your repository:
1831

19-
- [ ] Rename the repository and update all references in this file.
20-
- [ ] Replace all `pgm-template-repo` references across the repository, especially in this README and REUSE.toml.
21-
- [ ] Replace the project title and description in this README.
22-
- [ ] Ensure all third-party licenses are present in [LICENSES](https://github.com/PowerGridModel/pgm-template-repo/tree/main/LICENSES).
32+
- [x] Rename the repository and update all references in this file.
33+
- [x] Replace all `pgm-template-repo` references across the repository, especially in this README and REUSE.toml.
34+
- [x] Replace the project title and description in this README.
35+
- [ ] Ensure all third-party licenses are present in [LICENSES](https://github.com/PowerGridModel/libpower-grid-model-java/tree/main/LICENSES).
2336

2437
### Optional checks
2538

@@ -28,22 +41,22 @@ Change these if applicable.
2841
- [ ] Replace Power Grid Model project-specific links (for example contributing, support, release, security, and code of conduct links)
2942
with links for your project.
3043
- [ ] Add logos and badges corresponding to relevant pages
31-
- [ ] Verify [LICENSE](https://github.com/PowerGridModel/pgm-template-repo/blob/main/LICENSE) copyright holder and year(s).
44+
- [ ] Verify [LICENSE](https://github.com/PowerGridModel/libpower-grid-model-java/blob/main/LICENSE) copyright holder and year(s).
3245
Also verify SPDX copyright headers in source and documentation files.
3346
- [ ] Include documents present in [Home page of PGM org](https://github.com/PowerGridModel/.github/) in documentation if they are created.
3447

3548
## License
3649

3750
This project is licensed under the Mozilla Public License, version 2.0 - see
38-
[LICENSE](https://github.com/PowerGridModel/pgm-template-repo/blob/main/LICENSE) for details.
51+
[LICENSE](https://github.com/PowerGridModel/libpower-grid-model-java/blob/main/LICENSE) for details.
3952

4053
## Licenses third-party libraries
4154

4255
This project includes third-party libraries,
4356
which are licensed under their own respective Open-Source licenses.
4457
SPDX-License-Identifier headers are used to show which license is applicable.
4558
The concerning license files can be found in the
46-
[LICENSES](https://github.com/PowerGridModel/pgm-template-repo/tree/main/LICENSES) directory.
59+
[LICENSES](https://github.com/PowerGridModel/libpower-grid-model-java/tree/main/LICENSES) directory.
4760

4861
## Contributing
4962

‎REUSE.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
# SPDX-License-Identifier: MPL-2.0
44

55
version = 1
6-
SPDX-PackageName = "pgm-template-repo"
6+
SPDX-PackageName = "libpower-grid-model-java"
77
SPDX-PackageSupplier = "Power Grid Model project <powergridmodel@lfenergy.org>"
8-
SPDX-PackageDownloadLocation = "https://github.com/PowerGridModel/pgm-template-repo"
8+
SPDX-PackageDownloadLocation = "https://github.com/PowerGridModel/libpower-grid-model-java"
99

1010
[[annotations]]
1111
path = "./**"

0 commit comments

Comments
 (0)