Echtzeitsysteme
/
gips
mirror of https://github.com/Echtzeitsysteme/gips.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Graph-Based ILP Problem Specification Tool
611 Commits 11 Branches 1 Tag 29 MiB
Java 69.6%
Xtend 30.3%
Go to file
Maximilian Kratz f6e7410a3c
Merge pull request #130 from Echtzeitsysteme/hotfix/xtext-2330-mwe2-2160-compatibility 
Incompatibility with `Xtext v2.33.0` and `MWE2 v2.16.0`: Fixes broken dependencies
 		2023-12-05 14:18:01 +01:00
org.emoflon.gips.build Adds missing PatternSumExpression to the branching in generateBuilder 2023-11-15 14:21:02 +01:00
org.emoflon.gips.core Renames the master MWE2 file for naming consistency 2023-11-10 09:55:17 +01:00
org.emoflon.gips.core.dependencies Hotfix: Removes old Gurobi lib references in classpath file 2023-09-22 17:17:38 +02:00
org.emoflon.gips.feature Fixes package/plug-in vendor information 2022-07-28 10:23:38 +02:00
org.emoflon.gips.gipsl Fixes broken dependencies 2023-12-05 14:13:58 +01:00
org.emoflon.gips.gipsl.ide Fixes missing export of bin files 2022-07-28 11:42:36 +02:00
org.emoflon.gips.gipsl.ui Bugfix: Fixes a typo in the GIPSL project template provider 2023-11-13 10:43:44 +01:00
org.emoflon.gips.intermediate Fixes broken dependencies 2023-12-05 14:13:58 +01:00
org.emoflon.gips.updatesite Fixes copy paste error on update site project: index.html 2022-11-15 10:04:21 +01:00
.gitignore Adds .gitkeep for missing xtend-gen folders 2022-01-12 13:19:15 +01:00
CITATION.cff Adapts: CITATION, README, and PSF to new name 2022-05-03 12:41:04 +02:00
LICENSE Adds first version of README, LICENSE, CITATION 2022-03-15 17:29:29 +01:00
README.md Renames the master MWE2 file for naming consistency 2023-11-10 09:55:17 +01:00
devProjectSet.psf Change git protocol from SSH to HTTPS in PSF file 2023-03-27 13:18:18 +02:00

README.md

GIPS

GIPS is an open-source framework for Graph-Based ILP Problem Specification.

Installation (development)

  • Install AdoptOpenJDK 17 (HotSpot JVM) or newer.
  • Install eMoflon::IBeX as described here.
  • Install at least one of the supported ILP solvers:
    • Install Gurobi in version 10.0.3 and activate a license for your computer.
      • Currently, Gurobi is the default ILP solver used in GIPS because of the great performance.
    • Install GLPK in the newest version (4.6.5) and add it to your path.
      • GLPK is an open-source ILP solver that can be used without a charge.
    • Install CPLEX in version 22.1.1 and activate a license for your computer (if neccessary).
      • CPLEX is a commercial alternative to the other ILP solvers implemented in GIPS.
  • Clone this Git repository to your local machine and import it into Eclipse: File -> Import -> General -> Existing Projects into Workspace. Import all projects.
    • As an alternative, you can use this PSF file for the import.
  • Inside the Eclipse development workspace ...
    • ... Run Run all GIPS MWE2 files.launch from org.emoflon.gips.core/launch with right click Run As -> Build all GIPS MWE2 files.
    • ... build all projects (Project -> Clean... -> Clean all projects) to trigger code generation.
  • Launch a runtime workspace (while using a runtime Eclipse) as stated in the eMoflon::IBeX installation steps to start using GIPS.

A good start point to verify your installation is to run some of the GIPS examples or the GIPS tests.

Code-Style

This project uses the built-in code-style and code-formatter of Eclipse. Before contributing, please set-up your Eclipse code-style settings as follows:

  • Window -> Preferences -> Java
    • -> Code Style -> Clean Up -> Active profile: -> "Eclipse [built-in]" (default)
    • -> Code Style -> Formatter -> Active profile: -> "Eclipse [built-in]" (default)
    • -> Code Style -> _Organize Imports: -> "java, javax, org, com" (default)
    • -> Editor -> _Save Actions:
      • Check "Perform the selected actions on save"
      • Check "Format source code"
      • Check "Format all lines"
      • Check "Organize imports"
      • Check "Additional actions"

By using this settings, you should be unable to commit unformatted code.

Installation (user)

  • Install AdoptOpenJDK 17 (HotSpot JVM) or newer.
  • Install eMoflon::IBeX as described here.
  • Install at least one of the supported ILP solvers:
    • Install Gurobi in version 10.0.3 and activate a license for your computer.
      • Currently, Gurobi is the default ILP solver used in GIPS because of the great performance.
    • Install GLPK in the newest version (4.6.5) and add it to your path.
      • GLPK is an open-source ILP solver that can be used without a charge.
    • Install CPLEX in version 22.1.1 and activate a license for your computer (if neccessary).
      • CPLEX is a commercial alternative to the other ILP solvers implemented in GIPS.
  • Install GIPS from the public Eclipse update site: https://echtzeitsysteme.github.io/gips-updatesite/snapshot/updatesite/
  • Launch a runtime workspace (while using a runtime Eclipse) as stated in the eMoflon::IBeX installation steps to start using GIPS.

Usage (running simulations)

Please refer to the GIPS examples reposiory.

Tests

Please refer to the GIPS tests repository.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for more details.