# dside
[](https://dside.readthedocs.io/en/latest/?badge=latest)
[](https://pypi.org/project/dside)
[](https://pepy.tech/project/dside)
Design space identification tool for plotting and analysing design spaces (2D and 3D). Constraints with respect to key performance indicators (KPIs) are used to categorize the samples. Concave hulls (alpha shape) are used to identify design space (DSp) and quantify the size of the space. Given nominal operating point (NOP), an acceptable operating region (AOR) can be quantified to find the maximum multivariate allowable disturbance that the process can still handle while satisfying all constraints (multivariate proven acceptable range - MPAR).
## Installation
Currently, dside requires pandas, numpy, and matplotlib. dside can be installed with the following commands.
```bash
pip install dside
```
## Quick Overview
Use this tool to visualize 2D and 3D design spaces, obtain mathematical representations of the design space boundary in the form of alpha shapes, calculate the size of the design space, and investigate nominal operating points in terms of performance and flexibility (acceptable ranges). Identification of multi-region spaces is possible.
```
import dside
# 1. Create instance of ds with data from DataFrame df
ds = dside.DSI(df)
# 2. Screen the points using the constraints (dictionary)
ds.screen(constraints)
# 3. Find DSp boundaries based on vnames (list of variable names)
ds.find_DSp(vnames)
# 4. Plot the design space and the samples
ds.plot(vnames)
# 5. Plot the nominal point and AOR based on point x (list/numpy array)
ds.find_AOR(x)
# 6. Save the results in detailed output.txt file
ds.send_output('output')
```
## Citation
Please cite the following <a href="https://doi.org/10.1016/j.cherd.2023.08.016" target="_blank">publication</a> if you are using dside for your own research.
```text
@article{sachio2023dsp,
title={A model-based approach towards accelerated process development: A case study on chromatography},
author = {Steven Sachio and Cleo Kontoravdi and Maria M. Papathanasiou},
journal = {Chemical Engineering Research and Design},
volume = {197},
pages = {800-820},
year = {2023},
issn = {0263-8762},
doi = {https://doi.org/10.1016/j.cherd.2023.08.016},
url = {https://www.sciencedirect.com/science/article/pii/S0263876223005166},
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/stvsach/dside",
"name": "dside",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Steven Sachio",
"author_email": "stevensachio1506@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/12/80/1b2e6920d302d8d4700127a0ff34a8d9fb88bd04ff9e475f7154ba292ccc/dside-2.2.0.tar.gz",
"platform": null,
"description": "# dside\r\n\r\n[](https://dside.readthedocs.io/en/latest/?badge=latest)\r\n[](https://pypi.org/project/dside)\r\n[](https://pepy.tech/project/dside)\r\n\r\nDesign space identification tool for plotting and analysing design spaces (2D and 3D). Constraints with respect to key performance indicators (KPIs) are used to categorize the samples. Concave hulls (alpha shape) are used to identify design space (DSp) and quantify the size of the space. Given nominal operating point (NOP), an acceptable operating region (AOR) can be quantified to find the maximum multivariate allowable disturbance that the process can still handle while satisfying all constraints (multivariate proven acceptable range - MPAR).\r\n\r\n\r\n## Installation\r\nCurrently, dside requires pandas, numpy, and matplotlib. dside can be installed with the following commands.\r\n```bash\r\npip install dside\r\n```\r\n\r\n## Quick Overview\r\nUse this tool to visualize 2D and 3D design spaces, obtain mathematical representations of the design space boundary in the form of alpha shapes, calculate the size of the design space, and investigate nominal operating points in terms of performance and flexibility (acceptable ranges). Identification of multi-region spaces is possible.\r\n\r\n```\r\nimport dside\r\n# 1. Create instance of ds with data from DataFrame df\r\nds = dside.DSI(df)\r\n# 2. Screen the points using the constraints (dictionary)\r\nds.screen(constraints)\r\n# 3. Find DSp boundaries based on vnames (list of variable names)\r\nds.find_DSp(vnames)\r\n# 4. Plot the design space and the samples\r\nds.plot(vnames)\r\n# 5. Plot the nominal point and AOR based on point x (list/numpy array)\r\nds.find_AOR(x)\r\n# 6. Save the results in detailed output.txt file\r\nds.send_output('output')\r\n```\r\n\r\n\r\n\r\n\r\n## Citation\r\n\r\nPlease cite the following <a href=\"https://doi.org/10.1016/j.cherd.2023.08.016\" target=\"_blank\">publication</a> if you are using dside for your own research.\r\n\r\n```text\r\n@article{sachio2023dsp,\r\n title={A model-based approach towards accelerated process development: A case study on chromatography},\r\n author = {Steven Sachio and Cleo Kontoravdi and Maria M. Papathanasiou},\r\n journal = {Chemical Engineering Research and Design},\r\n volume = {197},\r\n pages = {800-820},\r\n year = {2023},\r\n issn = {0263-8762},\r\n doi = {https://doi.org/10.1016/j.cherd.2023.08.016},\r\n url = {https://www.sciencedirect.com/science/article/pii/S0263876223005166},\r\n}\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Design space identification tool for plotting and analysing design spaces (2D and 3D).",
"version": "2.2.0",
"project_urls": {
"Homepage": "https://github.com/stvsach/dside"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af6b871d0e30a95e2cbfe656784c69279ce5f51c6590e132f07396a4e1d2cdb6",
"md5": "bf0ab6abb2d918c89673a49cba8354d6",
"sha256": "b9a40a5665342fc0b5f35ef7c8eebff9bc4cce80df8a3331faf0cec976fc6af2"
},
"downloads": -1,
"filename": "dside-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf0ab6abb2d918c89673a49cba8354d6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 18373,
"upload_time": "2023-10-27T18:09:24",
"upload_time_iso_8601": "2023-10-27T18:09:24.210729Z",
"url": "https://files.pythonhosted.org/packages/af/6b/871d0e30a95e2cbfe656784c69279ce5f51c6590e132f07396a4e1d2cdb6/dside-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12801b2e6920d302d8d4700127a0ff34a8d9fb88bd04ff9e475f7154ba292ccc",
"md5": "a35cb79f952797c9fa1af85dba02dad8",
"sha256": "236a8f2eaf65bdadb9399baa707dbb0d31cfd79718e7fa2a8f352253fb977cee"
},
"downloads": -1,
"filename": "dside-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a35cb79f952797c9fa1af85dba02dad8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 19623,
"upload_time": "2023-10-27T18:09:26",
"upload_time_iso_8601": "2023-10-27T18:09:26.357295Z",
"url": "https://files.pythonhosted.org/packages/12/80/1b2e6920d302d8d4700127a0ff34a8d9fb88bd04ff9e475f7154ba292ccc/dside-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-27 18:09:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stvsach",
"github_project": "dside",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "matplotlib",
"specs": []
}
],
"lcname": "dside"
}
JSON
