| Name | SFILES2 JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | Conversion between PFDs/P&IDs and SFILES 2.0 strings. |
| upload_time | 2024-11-18 17:30:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
sfiles 2.0
pfd
chemical engineering
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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}
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "SFILES2",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "SFILES 2.0, PFD, chemical engineering",
"author": null,
"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>",
"download_url": "https://files.pythonhosted.org/packages/9e/0e/a952f9b7fce37ca61222860cd96d6a5490e60f2252a3c0ed30e48b0ce9db/sfiles2-1.1.0.tar.gz",
"platform": null,
"description": "# SFILES 2.0 \nThis repository is published together with the paper: *SFILES 2.0: An extended text-based flowsheet representation*<br>\nThe 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. \n\n## Installation\n\nTo install the SFILES 2.0 package via `pip`, simply run:\n\n```sh\npip install SFILES2\n```\n\n## Exploring the Repository and Demonstrations\n\nFor users who want to explore the functionality with the provided demonstrations and example files:\n```sh\ngit clone https://github.com/process-intelligence-research/SFILES2.git\n```\nAfter creating and activating a new virtual environment (python 3.9), you can use the pyproject.toml file to install all required packages:\n```sh\npip install .\n```\n### Demonstration of functionality\nYou 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`.\n\n## References\n\nIf you use this package or find it helpful in your research, please consider citing:\n\n```text\n@article{vogel2023sfiles,\n title={SFILES 2.0: an extended text-based flowsheet representation},\n author={Vogel, Gabriel and Hirtreiter, Edwin and Schulze Balhorn, Lukas and Schweidtmann, Artur M},\n journal={Optimization and Engineering},\n volume={24},\n number={4},\n pages={2911--2933},\n year={2023},\n publisher={Springer}\n}\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Conversion between PFDs/P&IDs and SFILES 2.0 strings.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://www.pi-research.org/",
"Source": "https://github.com/process-intelligence-research/SFILES2"
},
"split_keywords": [
"sfiles 2.0",
" pfd",
" chemical engineering"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9bae632396192ce82c5828ff50f9a4f23a697f4d3d827dd4530bdd5d00874eca",
"md5": "ba66c51b0ebb4c407650b783a7424a8f",
"sha256": "9ea23c111fc71d8b0707de57cabcb3946965c63c64599f8885c48e8e64f0abe0"
},
"downloads": -1,
"filename": "sfiles2-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba66c51b0ebb4c407650b783a7424a8f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 26401,
"upload_time": "2024-11-18T17:30:12",
"upload_time_iso_8601": "2024-11-18T17:30:12.617646Z",
"url": "https://files.pythonhosted.org/packages/9b/ae/632396192ce82c5828ff50f9a4f23a697f4d3d827dd4530bdd5d00874eca/sfiles2-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e0ea952f9b7fce37ca61222860cd96d6a5490e60f2252a3c0ed30e48b0ce9db",
"md5": "4eaf02c228ea24e58eeb51e63571dddf",
"sha256": "438d46729b51c5fc6a79d0c606c66f8000a40455b09f99cd6d2f765e60772ceb"
},
"downloads": -1,
"filename": "sfiles2-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "4eaf02c228ea24e58eeb51e63571dddf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 420245,
"upload_time": "2024-11-18T17:30:15",
"upload_time_iso_8601": "2024-11-18T17:30:15.003620Z",
"url": "https://files.pythonhosted.org/packages/9e/0e/a952f9b7fce37ca61222860cd96d6a5490e60f2252a3c0ed30e48b0ce9db/sfiles2-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 17:30:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "process-intelligence-research",
"github_project": "SFILES2",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sfiles2"
}
