SFILES2 1.0.2

Conversion between PFDs/P&IDs and SFILES 2.0 strings.

SFILES 2.0

This repository is published together with the paper: SFILES 2.0: An extended text-based flowsheet representation
The repository contains functionality for the conversion between PFD-graphs/P&ID-graphs and SFILES 2.0 strings. In the paper, we describe the structure of the graphs, notation rules of the SFILES 2.0, and the conversion algorithm.

Installation

To install the SFILES 2.0 package via pip, simply run:

pip install SFILES2

Exploring the Repository and Demonstrations

For users who want to explore the functionality with the provided demonstrations and example files:

git clone https://github.com/process-intelligence-research/SFILES2.git

After creating and activating a new virtual environment (python 3.9), you can use the requirements.txt file to install all required packages:

pip install -r requirements.txt

Demonstration of functionality

You can either have a look at the demonstration.ipynb which demonstrates SFILES 2.0 strings for a variety of PFDs and P&IDs or run the python file run_demonstration.py.

References

If you use this package or find it helpful in your research, please consider citing:

@article{vogel2023sfiles,
  title={SFILES 2.0: an extended text-based flowsheet representation},
  author={Vogel, Gabriel and Hirtreiter, Edwin and Schulze Balhorn, Lukas and Schweidtmann, Artur M},
  journal={Optimization and Engineering},
  volume={24},
  number={4},
  pages={2911--2933},
  year={2023},
  publisher={Springer}
}