JSON-Nets editor

Description

JSON-Nets editor is a highly adaptable process modelling tool that combines Petri Nets principles with the JSON data model and can be configured for different application domains. For example, it has been used in the Scope3transparent project, funded in the German National Climate Initiative, as a carbon analysis tool (Scope3tool) for electronics production processes.

For more information on the underlying concepts, see our paper on JSON-Nets. For more information on its usage in the Scope3transparent project see our paper on Scope3tool.

Usage

You can try the configuration for carbon analysis (Scope3tool) online. Scope3tool supports modelling of processes, integration of carbon footprint data, simulations and visualization of simulation results. Further instructions are available in the tool.

The basic configuration of the JSON-Nets editor is available to try here. Usage requires knowledge of the JSON syntax as well as different JSON technologies for inscriptions:

• Places are inscribed with JSON-Schema.
• Arcs are inscribed with a JSONPath.
• Transitions are inscribed with Jsonnet.

Roadmap

Note that the editor is a research prototoype and not production-ready. We are currently working on the following features:

• Extended simulation support
• Improved support for custom configurations
• Improved support for data exchange with external APIs
• Additional QoL-Features like copy/paste of model elements

Contributing

If you want to contribute, or have any comments, write an email to andreas.fritsch@kit.edu

Authors

Main Developer: Andreas Fritsch. Contributions: Martin Forell, Hanna Lagemann, Thomas Sowa.

Development

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint

Deployment on github pages

Paths in index.html need to be manually changed from /* to /json-nets/*

License

JSON-Nets editor is published under MIT license. If you use the JSON-Nets editor in your research work, please cite our paper on JSON-Nets.

Acknowlegment

The project Scope3transparent is supported by the Federal Ministry for Economic Affairs and Climate Action (BMWK) as part of the National Climate Initiative on the basis of a decision by the German Bundestag.