/openLCA-ApiDoc

Generated Java and gRPC API documentation of the openLCA backend

Primary LanguageTypeScriptMozilla Public License 2.0MPL-2.0

openLCA-ApiDoc

A new documentation for the IPC interface of openLCA 2 is currently under development, the current version is available here: https://greendelta.github.io/openLCA-ApiDoc/ipc/

This repository contains the generated documentation of the Java and gRPC API of the openLCA 2.0 backend. The Java API can be used with any programming language that runs on the JVM (Java, Kotlin, Scala, Clojure, Jython ...). openLCA comes with an embedded Jython interpreter so that you can also script against this API directly in openLCA (the interpreter in openLCA will also auto-import most of the classes of the openLCA backend so that you do not have to write the import paths for them). Additionally, you can start a gRPC server in openLCA 2.0 (Tools > Developer tools > IPC server > check gRPC) or start a stand-alone gRPC server with the openLCA backend:

...gRPC is a modern open source high performance Remote Procedure Call (RPC) framework that can run in any environment (from the website)

Note that openLCA 2.0 is still heavily under development and not officially released yet.

Documentation of the Java API:

Documentation of the gRPC API: