Skip to main content

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

Project description

SFILES 2.0 by Process Intelligence Research logo

Overview

SFILES 2.0 is an open-source Python package for converting process flow diagrams (PFDs) and piping and instrumentation diagrams (P&IDs) into an extended text-based representation. This package is developed in conjunction with the paper:

SFILES 2.0: An extended text-based flowsheet representation

The repository provides tools for:

  • Representing flowsheets as graphs
  • Converting graphs to SFILES 2.0 strings and back
  • Demonstrating the notation rules, structure, and conversion algorithm for SFILES 2.0

Citation

If you use SFILES 2.0 in your work, please cite:

@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}
}

Table of contents

Installation

Install the package via pip:

pip install SFILES2

To explore the source code and examples:

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

Demonstrations

Use the following to explore SFILES 2.0 capabilities:

  • Run the Jupyter notebook demonstration.ipynb
  • Or execute run_demonstration.py for a CLI-based example

These demonstrate SFILES 2.0 strings for a variety of PFDs and P&IDs.

Contributors

Gabriel Vogel
Edwin Hirtreiter
Lukas Schulze Balhorn
Artur M. Schweidtmann

License

This project is licensed under the MIT License.

Contact

📧 Contact

🌐 Process Intelligence Research

fernandezbap

https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white

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.1.1.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sfiles2-1.1.1-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sfiles2-1.1.1.tar.gz
Algorithm Hash digest
SHA256 3df3b77470de33ea3ca80a6c58e2abc8b503bf8c9efb7413e89b0de26f35775c
MD5 aabe7c6e884786fce181f2d72607f6c3
BLAKE2b-256 badc2617f302fcfbe7f1264eced817c2dd4ae0b17e5d9cef5be73e455675947c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sfiles2-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 27.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.6

File hashes

Hashes for sfiles2-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1720774a22a4504d4eebeeb58ab5c9f277d91e80f6f40158795975b356268bbc
MD5 b85418fa6c3e59115d28d9110e4516a8
BLAKE2b-256 3be8a56c4ba9fb0719809a77ca715e41331fa58b6c97edff1f978d2efa014a77

See more details on using hashes here.

Supported by

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