SFILES 2.0 by 
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:
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.pyfor 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 | |
|
| Antonio Rocha Azevedo | |
|
| Artur M. Schweidtmann | |
License
This project is licensed under the MIT License.
Contact
📧 Contact
Metadata
Release files for SFILES2 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sfiles2-1.2.0.tar.gz | 1.2 MB | Without provenance | Details for sfiles2-1.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sfiles2-1.2.0-py3-none-any.whl | Python 3 | none | any | Details for sfiles2-1.2.0-py3-none-any.whl |
Total release size: 1.2 MB
Release files / sfiles2-1.2.0.tar.gz
| Download URL | sfiles2-1.2.0.tar.gz |
|---|---|
| Size | 1.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0ef8febdcc96ffdedacb1887ef5ccd2948cd018d0fd797ef3d29624eefb9430a
|
|
BLAKE2b-256 checksum How to use checksums |
333a490ee753063186f0aade27d7b13df9a300e5106a8b3defa7bae38a7ffb3c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Release files / sfiles2-1.2.0-py3-none-any.whl
| Download URL | sfiles2-1.2.0-py3-none-any.whl |
|---|---|
| Size | 35.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
74b91857a77b4fcf3d6e5af1f807c102c2ad070b5a686a75e9d963faefe126e1
|
|
BLAKE2b-256 checksum How to use checksums |
4479fbe29f076dbf3dc1dd68ef85dcf029de4898dc7cae662b2cd29ed853fb8e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Security for SFILES2 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.