Skip to content

Latest commit

 

History

History
62 lines (34 loc) · 3.7 KB

README.md

File metadata and controls

62 lines (34 loc) · 3.7 KB
Raw

PNML to Nested-Unit Petri Net (NUPN) Converter

Build Status Codacy Badge Coverity Scan Build Status

PNML2NUPN transforms 1-Safe Place/Transition Petri nets from the Petri Net Markup Language into the Nested-Units Petri Nets format handled by the Caesar.bdd structural analyser tool of the CADP tool suite.

Download PNML2NUPN executable jar from its companion web site, or the releases page of this repository.

Usage

pnml2nupn simply runs on the command line. It is expecting either a set of paths to PNML files, or to folders containing them, or a mix of files and folders. It scans folders recursively, looking for PNML files.

Requirement:

  • Starting from version 4.0.0, pnml2nupn runs on Java17+.
  • In versions 3.x.x, it runs on Java 11+ (starting from 3.0.0, pnml2nupn will not run on Java below 11).
  • Prior versions 2.x.x run on Java 7 to Java 8.

Command-line invocation

The basic command-line invocation is the following (update the name of the jar file with the version you are using, e.g., pnml2nupn-3.0.0.jar):

java -jar pnml2nupn-version.jar pathToPNMLFile [pathToFolder pathToAnotherPNMLFile ...]

To increase the max allocated memory to the heap, in case you are dealing with very large PNML files, pass the -Xmx argument to the JVM. In the following example, the max memory is set to 2 Go:

java -Xmx2g -jar pnml2nupn-version.jar pathToPNMLFile [pathToFolder pathToAnotherPNMLFile ...]

For the complete list of options you can pass to the tool, please have a look at the usage page on the companion site, or look into the provided Shell script (see below).

Invocation using a Shell script

There is a Shell script to help you increase productivity in using the PNML to NUPN Converter. Feel free to use it and adapt it to your environment.

Before you use it, you must first set in this script the path to the Java executable (i.e., java or java.exe) in your OS.

The Shell script also contains properties you can pass to the tool, and a debug environment variable for pnml2nupn, that you can enable or disable.

Output since version 3.0.0

Upon successful execution, this tool will output a single file:

  • A <<*.nupn>> file that contains the Nested-Units Petri Net obtained from the PNML P/T translation. Mappings between PNML places ids and their NUPN counterparts are included at the end of the NUPN file. The same holds for mappings between PNML transition ids and their NUPN counterparts.

Output before version 3.0.0

Upon successful execution, this tool will output 3 files:

  • A <<*.nupn>> file that contains the Nested Unit Petri Net obtained from the PNML P/T translation;

  • A <<*.places>> file that contains the mapping between the places ids from PNML and their counterparts in NUPN;

  • A <<*.trans>> file that contains the mapping between the transitions ids from PNML and their counterparts in NUPN.