Metadata-Version: 2.3
Name: SFILES2
Version: 1.1.0
Summary: Conversion between PFDs/P&IDs and SFILES 2.0 strings.
Project-URL: Homepage, https://www.pi-research.org/
Project-URL: Source, https://github.com/process-intelligence-research/SFILES2
Author-email: "Artur M. Schweidtmann" <A.Schweidtmann@tudelft.nl>, Gabriel Vogel <G.Vogel@tudelft.nl>, Edwin Hirtreiter <edwin.hirtreiter@tum.de>, Lukas Schulze Balhorn <L.Schulzebalhorn@tudelft.nl>
Keywords: SFILES 2.0, PFD, chemical engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: ipykernel
Requires-Dist: ipython~=7.30.1
Requires-Dist: matplotlib==3.8.4
Requires-Dist: networkx==3.2.1
Requires-Dist: numpy==2.1.3
Requires-Dist: pathfinding==1.0.1
Requires-Dist: pyflowsheet~=0.2.2
Requires-Dist: tabulate==0.8.9
Description-Content-Type: text/markdown

# SFILES 2.0 
This repository is published together with the paper: *SFILES 2.0: An extended text-based flowsheet representation*<br>
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:

```sh
pip install SFILES2
```

## Exploring the Repository and Demonstrations

For users who want to explore the functionality with the provided demonstrations and example files:
```sh
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 pyproject.toml file to install all required packages:
```sh
pip install .
```
### 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:

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