Skip to content

Installation

Every package embeds the binaries it needs, so no library file has to be placed by hand.

Package Download Size
Python inscoper_nbo-1.4.5-cp313-cp313-win_amd64.whl 10.2 MB
Java inscoper-nbo-1.4.5.jar 5.2 MB
C++ — Windows x64 inscoper_nbo-1.4.5-cpp-windows-x64.zip 4.1 MB
C++ — Linux aarch64 inscoper_nbo-1.4.5-cpp-linux-aarch64.zip 7.6 MB

Packages built for this version

The table lists what the pipeline published with this documentation version. A package absent from a version is listed as such; use the version selector to reach another one.

Every package carries LICENSE and NOTICE: the Apache License 2.0 the library is distributed under, and the attribution required by the Creative Commons Attribution 3.0 license of the NBO schema. The Python wheel and the Java JAR hold them internally, under the package directory and under META-INF/ respectively; the C++ archives hold them at the root. Keep both files with any redistribution. See License.

Python

The wheel targets Windows on x64.

  1. Install it from the folder holding the downloaded file: 

    pip install inscoper_nbo-*.whl

  2. Check the installation by reading the library version: 

    import inscoper_nbo
print(inscoper_nbo.NBOUtils.getVersion())

Python version

The wheel filename states the Python version it was built for, and pip refuses to install it on another one. On platforms with no published wheel, use the C++ library directly.

Java

The JAR carries the native library inside it.

  1. Add inscoper-nbo-<version>.jar to the classpath.
  2. Nothing else: the JAR extracts and loads the native library itself.
import com.inscoper.nbo.NBOUtils;

System.out.println(NBOUtils.getVersion());

Permissions

The JVM needs write access to its temporary directory to extract the embedded native library.

C++

The archive holds include/ and lib/, one archive per platform.

Platform Archive holds
Windows x64 inscoper_nbo.dll, inscoper_nbo.lib, and the public headers
Linux aarch64 libinscoper_nbo.so and the public headers
  1. Add include/ to the include paths of your project.
  2. Link against lib/inscoper_nbo.lib on Windows, or lib/libinscoper_nbo.so on Linux.
  3. Make inscoper_nbo.dll reachable at run time, from the directory of the executable or from PATH. On Linux, make the shared library reachable through LD_LIBRARY_PATH or the run path of the binary.
#include <NBO/NBO/NBOUtils.h>
#include <iostream>

int main() {
    std::cout << Inscoper::NBO::NBOUtils::getVersion() << std::endl;
}

Architecture match

Match the architecture of your application, x64 or aarch64, with the library you link.

Next steps

The Quickstart builds and exports a first NBO document. The examples then cover the model one mechanism at a time.