openLCA Application Documentation

The openLCA repository is a multi-project workspace containing the source code for the openLCA Java application, which runs on the Eclipse Rich Client Platform (Eclipse RCP). The repository is organized into the following sub-projects:

• olca-app: The main source code for the openLCA RCP application.
• olca-app-build: Scripts for creating distribution packages for Windows, Linux, and macOS.
• olca-app-html: Source code for the HTML views used within the application (e.g., start page, report views).
• olca-refdata: Build scripts for reference databases (units, flows, locations, etc.) packaged with the app.

The openLCA matrix export allows you to export a product system into platform-independent matrices for use in external tools.

Supported file formats include:

• CSV: Comma-separated, UTF-8 encoded text files.
• MS Excel: .xlsx files.
• Python: Uses Numpy/SciPy formats (.npy for dense and .npz for sparse). A Python export also includes a helper library (lib.py) and a script (main.py) with usage examples.

Regardless of the format chosen, the set of exported matrices and index files remains the same; only the file extensions change.

When you must use variables within a string, follow these patterns to ensure compatibility with different languages:

1. Avoid colons (:): Colons translate poorly. Use hyphens (-) or parentheses (()) instead.
   • Preferred: M.OpenInEditor + " - " + name
   • Preferred: M.UpstreamTotal + " (" + percentage + "%)"
2. Avoid pluralization logic: If possible, avoid differentiating between singular and plural words. Use a format like DaysAgo=Day(s) ago to cover both cases.

// Use hyphens instead of colons
String label = M.OpenInEditor + " - " + name;

// Use parentheses for values
String total = M.UpstreamTotal + " (" + percentage + "%)";

// Use neutral pluralization
// messages.properties: DaysAgo=Day(s) ago

Actions in the graphical editor are derived from JFace Actions and are implemented via GEF. They can be selection-specific or CommandStack-specific.

Because all changes must pass through the EditPart to ensure model integrity, the EditPart provides the execution capability.

Example: Execution of 'Minimize All'

When a user triggers a 'Minimize All' action, the following sequence occurs:

1. For each targeted MinMaxComponent:
   • A Request(REQ_MIN) is created and forwarded to its EditPart.
   • The EditPart forwards the request to its EditPolicy.
   • The EditPolicy creates (or forwards) a Command.
2. All individual commands are packed into a CompoundCommand.
3. The CompoundCommand is executed only if all constituent commands are executable.
4. The action is completed via the menu click.

Figures are the visual components created by EditParts.

• Model Synchronization: When a model is modified, it notifies the EditPart via a listener. The EditPart then calls the propertyChange method to refresh the corresponding Figure, connections, or children.
• Child Hierarchy: An EditPart's children's figures are added to the contentPane of the parent figure. Note that an EditPartA child's figure is not necessarily a direct child of FigureA; it may be a child of FigureA.contentPane.

The OpenLCA graphical editor is built using the Eclipse Graphical Editor Framework (GEF), following the Model-View-Controller (MVC) pattern. The architecture separates responsibilities into three distinct layers:

• Models: Contain the actual data to be displayed (e.g., processes, products, results).
• Views (Figures): The visual representation of the model's data.
• Controllers (EditParts): Handle the logic behind user actions and coordinate transformations between the model and the view.

When a model changes, it notifies the corresponding EditPart, which then refreshes the visual Figure or its connections.

As an alternative to the Eclipse PDE Export, you can use Maven with Tycho to build the olca-app plugin and create distributable products for Linux, macOS (Intel and ARM), and Windows.

Prerequisites:

1. Java 21 installed and JAVA_HOME set.
2. Maven 3.9+ installed.
3. olca-modules must be built and installed locally:

   cd olca-modules
   mvn clean install

Build Command: Run the following from the olca-app-build directory. For release builds (without the SNAPSHOT qualifier), add the -Prelease flag.

Output: Distributable products are created in the olca-app-build/build/ directory.

cd olca-app-build
# For standard build
mvn clean verify

# For release builds
mvn clean verify -Prelease

To generate the .icns file for the macOS distribution, you must first create a high-resolution 1024x1024 PNG image. Then, use the create_icns.sh script located in the olca-app-build directory to convert the PNG into the macOS icon format.

create_icns.sh logo.png