Adding java gurobi multi excel file example

Author: merschformann

java-gurobi-multiknapsack-multiexcel/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/go
+{
+  "name": "Java",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  "image": "ghcr.io/nextmv-io/runtime/java:latest",
+  "features": {
+    "ghcr.io/devcontainers/features/java:1": {
+      "installMaven": "true",
+      "jdkDistro": "tem",
+      "version": "21"
+    }
+  },
+  "workspaceMount": "source=${localWorkspaceFolder}/.,target=/app,type=bind",
+  "workspaceFolder": "/app",
+  "mounts": [
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/gurobi.lic,target=/root/gurobi.lic,type=bind,consistency=cached"
+  ],
+  "containerEnv": {
+    "GRB_LICENSE_FILE": "/root/gurobi.lic"
+  }
+}

java-gurobi-multiknapsack-multiexcel/.gitignore

@@ -0,0 +1,5 @@
+gurobi.lic
+.vscode/
+main.jar
+target/
+*.xlsx

java-gurobi-multiknapsack-multiexcel/README.md

@@ -0,0 +1,66 @@
+# Nextmv Java Gurobi Knapsack
+
+Example for running a Java `Maven` application on the Nextmv Platform using the
+Gurobi solver. We solve a knapsack Mixed Integer Programming problem.
+
+1. Setup license:
+    1. **Local**:
+        - You can simply place the `gurobi.lic` file in your _home directory_
+        (like Gurobi expects it). If you are using the dev container, it will be
+        mounted inside of the container for you.
+    1. **Platform**: Don't forget to also define the license file as a
+        [secret][secret] in your Nextmv Application as well. This can be easily
+        done via [console].
+        - Define a file secret with the name `gurobi.lic` and the content of
+          your license file.
+        - Define an environment variable secret with the name `GRB_LICENSE_FILE`
+          and the value `./gurobi.lic` to point Gurobi to the license file.
+1. Generate a `main.jar`.
+
+    ```bash
+    mvn package
+    ```
+
+1. Run the app.
+
+    ```bash
+    java -jar main.jar --input input.json
+    ```
+
+1. If above steps were successful, you can push the app to the Nextmv Platform.
+   E.g., using the [Nextmv CLI][install-cli]:
+
+    ```bash
+    nextmv push --app-id <your-app-id>
+    ```
+
+## Mirror running on Nextmv Cloud locally
+
+Docker needs to be installed.
+
+To run the application in the same Docker image as the one used on Nextmv
+Cloud, you can use the following command:
+
+```bash
+mvn package && cat input.json | docker run -i --rm \
+-v $(pwd):/app ghcr.io/nextmv-io/runtime/java:latest \
+java -jar /app/main.jar
+```
+
+You can also debug the application by running it in a Dev Container. This
+workspace recommends to install the Dev Container extension for VSCode. If you
+have the extension installed, you can open the workspace in a container by using
+the command `Dev Containers: Reopen in Container`.
+
+## Next steps
+
+- Open `src/main/java/com/nextmv/example/Main.java` and modify the model.
+- Visit our [docs][docs] and [blog][blog]. Need more assistance?
+  [Contact][contact] us!
+
+[docs]: https://docs.nextmv.io
+[console]: https://cloud.nextmv.io
+[secret]: https://www.nextmv.io/docs/using-nextmv/reference/secret-collections
+[install-cli]: https://docs.nextmv.io/docs/using-nextmv/setup/install#nextmv-cli
+[blog]: https://www.nextmv.io/blog
+[contact]: https://www.nextmv.io/contact

java-gurobi-multiknapsack-multiexcel/app.yaml

@@ -0,0 +1,11 @@
+# This manifest holds the information the app needs to run on the Nextmv Cloud.
+type: java
+runtime: ghcr.io/nextmv-io/runtime/java:latest
+
+# Directives to compile a binary from the app.
+pre-push: mvn package
+
+# List all files/directories that should be included in the app. Globbing
+# (e.g.: configs/*.json) is supported.
+files:
+  - main.jar

java-gurobi-multiknapsack-multiexcel/inputs/input.xlsx

@@ -0,0 +1,25 @@
+{
+  "folders": [
+    {
+      "path": "."
+    }
+  ],
+  "launch": {
+    "configurations": [
+      {
+        "type": "java",
+        "name": "Main",
+        "request": "launch",
+        "mainClass": "com.nextmv.example.Main",
+        "projectName": "GurobiJava",
+        "args": ["--input", "input.json", "--output", "output.json"]
+      }
+    ]
+  },
+  "extensions": {
+    "recommendations": ["ms-vscode-remote.remote-containers"]
+  },
+  "settings": {
+    "java.configuration.updateBuildConfiguration": "interactive"
+  }
+}

java-gurobi-multiknapsack-multiexcel/java-gurobi-knapsack.code-workspace

@@ -0,0 +1,128 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>com.nextmv.example</groupId>
+  <artifactId>GurobiJava</artifactId>
+  <version>1.0.0</version>
+  <packaging>jar</packaging>
+
+  <name>${project.groupId}:${project.artifactId}</name>
+  <description>Sample using Gurobi via Java.</description>
+  <url>https://github.com/nextmv-io</url>
+
+  <licenses>
+    <license>
+      <name>The Apache License, Version 2.0</name>
+      <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
+    </license>
+  </licenses>
+
+  <developers>
+    <developer>
+      <name>Nextmv Team</name>
+      <email>support@nextmv.io</email>
+      <organization>Nextmv</organization>
+      <organizationUrl>https://www.nextmv.io</organizationUrl>
+    </developer>
+  </developers>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <exec.mainClass>com.nextmv.example.Main</exec.mainClass>
+    <maven.compiler.source>21</maven.compiler.source>
+    <maven.compiler.target>21</maven.compiler.target>
+  </properties>
+
+  <dependencies>
+    <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-api -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-api</artifactId>
+      <version>2.25.0</version>
+    </dependency>
+    <!-- https://mvnrepository.com/artifact/com.gurobi/gurobi -->
+    <dependency>
+      <groupId>com.gurobi</groupId>
+      <artifactId>gurobi</artifactId>
+      <version>12.0.2</version>
+      <type>jar</type>
+      <scope>compile</scope>
+    </dependency>
+    <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
+    <dependency>
+      <groupId>com.google.code.gson</groupId>
+      <artifactId>gson</artifactId>
+      <version>2.13.1</version>
+    </dependency>
+    <!-- https://mvnrepository.com/artifact/org.apache.poi/poi -->
+    <dependency>
+      <groupId>org.apache.poi</groupId>
+      <artifactId>poi</artifactId>
+      <version>5.4.1</version>
+    </dependency>
+    <!-- https://mvnrepository.com/artifact/org.apache.poi/poi-ooxml -->
+    <dependency>
+      <groupId>org.apache.poi</groupId>
+      <artifactId>poi-ooxml</artifactId>
+      <version>5.4.1</version>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-source-plugin</artifactId>
+        <version>3.2.0</version>
+        <executions>
+          <execution>
+            <id>attach-sources</id>
+            <goals>
+              <goal>jar-no-fork</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-gpg-plugin</artifactId>
+        <version>1.6</version>
+        <executions>
+          <execution>
+            <id>sign-artifacts</id>
+            <phase>verify</phase>
+            <goals>
+              <goal>sign</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <executions>
+          <execution>
+            <phase>package</phase>
+            <goals>
+              <goal>single</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <archive>
+            <manifest>
+              <mainClass>com.nextmv.example.Main</mainClass>
+            </manifest>
+          </archive>
+          <descriptorRefs>
+            <descriptorRef>jar-with-dependencies</descriptorRef>
+          </descriptorRefs>
+          <outputDirectory>.</outputDirectory>
+          <finalName>main</finalName>
+          <appendAssemblyId>false</appendAssemblyId>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>

java-gurobi-multiknapsack-multiexcel/pom.xml

@@ -0,0 +1,128 @@
+package com.nextmv.example;
+
+import org.apache.poi.ss.usermodel.*;
+import org.apache.poi.xssf.usermodel.XSSFWorkbook;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+public class ExcelReader {
+
+  public Input readExcelFile(String filePath) throws IOException {
+    FileInputStream file = new FileInputStream(filePath);
+    Workbook workbook = new XSSFWorkbook(file);
+
+    List<Item> items = readItemsSheet(workbook);
+    List<Knapsack> knapsacks = readKnapsacksSheet(workbook);
+
+    workbook.close();
+    file.close();
+
+    return new Input(items, knapsacks);
+  }
+
+  private List<Item> readItemsSheet(Workbook workbook) {
+    List<Item> items = new ArrayList<>();
+    Sheet sheet = workbook.getSheet("items");
+
+    Iterator<Row> rowIterator = sheet.iterator();
+    // Skip header row
+    if (rowIterator.hasNext()) {
+      rowIterator.next();
+    }
+
+    while (rowIterator.hasNext()) {
+      Row row = rowIterator.next();
+      String id = row.getCell(0).getStringCellValue();
+      double value = row.getCell(1).getNumericCellValue();
+      double weight = row.getCell(2).getNumericCellValue();
+
+      items.add(new Item(id, value, weight));
+    }
+
+    return items;
+  }
+
+  private List<Knapsack> readKnapsacksSheet(Workbook workbook) {
+    List<Knapsack> knapsacks = new ArrayList<>();
+    Sheet sheet = workbook.getSheet("knapsacks");
+
+    Iterator<Row> rowIterator = sheet.iterator();
+    // Skip header row
+    if (rowIterator.hasNext()) {
+      rowIterator.next();
+    }
+
+    while (rowIterator.hasNext()) {
+      Row row = rowIterator.next();
+      String id = row.getCell(0).getStringCellValue();
+      double capacity = row.getCell(1).getNumericCellValue();
+
+      knapsacks.add(new Knapsack(id, capacity));
+    }
+
+    return knapsacks;
+  }
+}
+
+class Input {
+  private List<Item> items;
+  private List<Knapsack> knapsacks;
+
+  public Input(List<Item> items, List<Knapsack> knapsacks) {
+    this.items = items;
+    this.knapsacks = knapsacks;
+  }
+
+  public List<Item> getItems() {
+    return items;
+  }
+
+  public List<Knapsack> getKnapsacks() {
+    return knapsacks;
+  }
+}
+
+class Item {
+  private String id;
+  private double value;
+  private double weight;
+
+  public Item(String id, double value, double weight) {
+    this.id = id;
+    this.value = value;
+    this.weight = weight;
+  }
+
+  public String getId() {
+    return id;
+  }
+
+  public double getValue() {
+    return value;
+  }
+
+  public double getWeight() {
+    return weight;
+  }
+}
+
+class Knapsack {
+  private String id;
+  private double capacity;
+
+  public Knapsack(String id, double capacity) {
+    this.id = id;
+    this.capacity = capacity;
+  }
+
+  public String getId() {
+    return id;
+  }
+
+  public double getCapacity() {
+    return capacity;
+  }
+}