Skip to main content

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

Project description

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{hirtreiter2024toward,
  title={Toward automatic generation of control structures for process flow diagrams with large language models},
  author={Hirtreiter, Edwin and Schulze Balhorn, Lukas and Schweidtmann, Artur M},
  journal={AIChE Journal},
  volume={70},
  number={1},
  pages={e18259},
  year={2024},
  publisher={Wiley Online Library}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sfiles2-1.0.1.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

sfiles2-1.0.1-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

Details for the file sfiles2-1.0.1.tar.gz.

File metadata

  • Download URL: sfiles2-1.0.1.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for sfiles2-1.0.1.tar.gz
Algorithm Hash digest
SHA256 5e1c049a634961566c734054d8deb6a3802feef33efb22a8f304de4e6d7d872c
MD5 8c6bfee05f885706484b89d00e35edd2
BLAKE2b-256 e8c60166367d948ce636b98a71df77738767866bbe479b253c437c8110b969bc

See more details on using hashes here.

File details

Details for the file sfiles2-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: sfiles2-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 26.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for sfiles2-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c19b30f1943eb20ec0d0039a67f620b354446c06b443fc543749f125f13b9e39
MD5 dbf7cd88cd244c052fc84e36a137486c
BLAKE2b-256 09d8d9e41f93910eecee9679af4212027b341d3db44f1cff5e1b1bef785bd731

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page