# OpenPy-fx-tools-DSS
Python functions for extracting, executing routines, etc. from projects modeled in OpenDSS
# Install
With pip
``pip install openpy-fx-tools-dss``
# How to use
First, in the IDE (Integrated Development Environment) of preference, we import the library:
```Python
import openpy_fx_tools_dss as fx_dss
```
## Examples
The library has IEEE example circuits (Table 1), which can be found in the OpenDSS installation files.
For the example files the class ``examples_lib()`` is called:
**Table 1.** Sample tests
| **Name** | **Option** | **DSS files** | **xlsx file** |
|------------|------------|---------------|---------------|
| 13BusIEEE | 1 | x | x |
| 37BusIEEE | 2 | x | x |
| 123BusIEEE | 3 | x | x |
```Python
test = fx_dss.examples_lib()
```
To use the .DSS files:
``DSS_path = test.load_examples_DSS()``
To use .xlsx file:
``xlsx_path = test.load_examples_xlsx()``
## OpenDSS to xlsx and vice versa
The functions that generate OpenDSS scripts to a .xlsx file and vice versa are inside the ``xlsx_DSS_xlsx()`` class and are called in the following way:
``xlsx = fx_dss.xlsx_DSS_xlsx()``
### Template xlsx
An .xlsx template with the OpenDSS elements is created by calling the ``create_template_xlsx`` function as follows:
```Python
xlsx.create_template_xlsx(
path_save: str = None,
prj_name: str = 'default',
elem_list: list = [],
all_elem: bool = True
)
```
### xlsx to OpenDSS
The circuit data is entered in the .xlsx template. Each sheet of the template corresponds to the elements that are modeled in OpenDSS. When generating the OpenDSS scripts, only the cells that are not empty are considered.
For this purpose, the ``xlsx_to_OpenDSS`` function is called as follows:
```Python
xlsx.xlsx_to_OpenDSS(
xlsx_path=xlsx_path['xlsx_path'],
path_save=xlsx_path['path_save'],
prj_name=DSS_path['prj_name']
)
```
**Important:**
* Do not alter the names of the sheets, and columns, since the element will not be taken into account.
* The form of data entry must coincide with the OpenDSS specifications.
### OpenDSS to xlsx
From an OpenDSS file, the xlsx template can be generated. For this purpose, the ``OpenDSS_to_xlsx`` function is used as follows:
```Python
xlsx.OpenDSS_to_xlsx(
DSS_path=DSS_path['DSS_path'],
path_save=DSS_path['path_save'],
prj_name=DSS_path['prj_name']
)
```
# License
License: CC BY-NC-SA 4.0
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br />
This work has a license <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
Raw data
{
"_id": null,
"home_page": "https://github.com/jlara6/OpenPy-fx-tools-DSS",
"name": "openpy-fx-tools-dss",
"maintainer": "Jorge A. Lara S.",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "jlara@iee.unsj.edu.ar",
"keywords": "OpenDSS,Distribution stystem,Python,smart grid,openpy-fx-tools-dss,openpy_fx_tools_dss",
"author": "Jorge A. Lara S.",
"author_email": "jlara@iee.unsj.edu.ar",
"download_url": "https://files.pythonhosted.org/packages/d7/74/dbdd191292d6930c78bbb91b733955b91c12cced2d719c8df319879e98c7/openpy_fx_tools_dss-0.1.6.tar.gz",
"platform": null,
"description": "# OpenPy-fx-tools-DSS\nPython functions for extracting, executing routines, etc. from projects modeled in OpenDSS\n# Install\nWith pip\n\n``pip install openpy-fx-tools-dss``\n\n# How to use\nFirst, in the IDE (Integrated Development Environment) of preference, we import the library:\n\n```Python\nimport openpy_fx_tools_dss as fx_dss\n```\n## Examples\nThe library has IEEE example circuits (Table 1), which can be found in the OpenDSS installation files.\nFor the example files the class ``examples_lib()`` is called: \n\n**Table 1.** Sample tests\n\n| **Name** | **Option** | **DSS files** | **xlsx file** |\n|------------|------------|---------------|---------------|\n| 13BusIEEE | 1 | x | x |\n| 37BusIEEE | 2 | x | x |\n| 123BusIEEE | 3 | x | x |\n\n\n```Python\ntest = fx_dss.examples_lib()\n```\n\nTo use the .DSS files:\n\n``DSS_path = test.load_examples_DSS()``\n\nTo use .xlsx file:\n\n``xlsx_path = test.load_examples_xlsx()``\n\n## OpenDSS to xlsx and vice versa \nThe functions that generate OpenDSS scripts to a .xlsx file and vice versa are inside the ``xlsx_DSS_xlsx()`` class and are called in the following way:\n\n``xlsx = fx_dss.xlsx_DSS_xlsx()``\n### Template xlsx\n\nAn .xlsx template with the OpenDSS elements is created by calling the ``create_template_xlsx`` function as follows:\n\n```Python\nxlsx.create_template_xlsx(\n path_save: str = None, \n prj_name: str = 'default', \n elem_list: list = [], \n all_elem: bool = True\n)\n```\n### xlsx to OpenDSS\nThe circuit data is entered in the .xlsx template. Each sheet of the template corresponds to the elements that are modeled in OpenDSS. When generating the OpenDSS scripts, only the cells that are not empty are considered.\nFor this purpose, the ``xlsx_to_OpenDSS`` function is called as follows:\n\n```Python\nxlsx.xlsx_to_OpenDSS(\n xlsx_path=xlsx_path['xlsx_path'],\n path_save=xlsx_path['path_save'],\n prj_name=DSS_path['prj_name']\n)\n```\n\n**Important:**\n\n* Do not alter the names of the sheets, and columns, since the element will not be taken into account. \n* The form of data entry must coincide with the OpenDSS specifications.\n\n\n\n\n### OpenDSS to xlsx\nFrom an OpenDSS file, the xlsx template can be generated. For this purpose, the ``OpenDSS_to_xlsx`` function is used as follows:\n\n```Python\nxlsx.OpenDSS_to_xlsx(\n DSS_path=DSS_path['DSS_path'],\n path_save=DSS_path['path_save'],\n prj_name=DSS_path['prj_name']\n)\n```\n\n# License\nLicense: CC BY-NC-SA 4.0\n\n<a rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc-sa/4.0/\"><img alt=\"Creative Commons License\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png\" /></a><br />\n\nThis work has a license <a rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc-sa/4.0/\">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.\n\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "Python functions for extracting, executing routines, etc. from projects modeled in OpenDSS",
"version": "0.1.6",
"split_keywords": [
"opendss",
"distribution stystem",
"python",
"smart grid",
"openpy-fx-tools-dss",
"openpy_fx_tools_dss"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "565721cfce13b1a30eed4ee44a4886ff",
"sha256": "cb601536623b590913951f72877006f81e6d7231f8c694ae00c1e72eeae1d880"
},
"downloads": -1,
"filename": "openpy_fx_tools_dss-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "565721cfce13b1a30eed4ee44a4886ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 1056437,
"upload_time": "2022-12-29T03:35:33",
"upload_time_iso_8601": "2022-12-29T03:35:33.833091Z",
"url": "https://files.pythonhosted.org/packages/79/eb/6dc1f6342c8e76a06cac40ebeeae6d15123e9b172d29dde073766f550062/openpy_fx_tools_dss-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "cb7cbe6efbf7c5c03b07067c9c267b5e",
"sha256": "72f8d5a0bfaa131db28b52f8a9374e7fde06164f595167a79cdf01c202061562"
},
"downloads": -1,
"filename": "openpy_fx_tools_dss-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "cb7cbe6efbf7c5c03b07067c9c267b5e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 1024832,
"upload_time": "2022-12-29T03:35:36",
"upload_time_iso_8601": "2022-12-29T03:35:36.276726Z",
"url": "https://files.pythonhosted.org/packages/d7/74/dbdd191292d6930c78bbb91b733955b91c12cced2d719c8df319879e98c7/openpy_fx_tools_dss-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-29 03:35:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jlara6",
"github_project": "OpenPy-fx-tools-DSS",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "openpy-fx-tools-dss"
}
JSON
