Skip to content

Commit ed5ef6d

Browse files
committed
General doc/text updates
- setup.py: Adjust description -- adding "alternative" more explicitly to avoid confusion vs. EPRI's distribution. - General text: use DSS-Extensions (with hyphen), DSS-Python.
1 parent 26c4ca2 commit ed5ef6d

File tree

7 files changed

+17
-10
lines changed

7 files changed

+17
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ If you are having issues using this Python interface, feel free to open an Issue
4040
Thanks to @tshort, Davis, @temcdrm, @GordStephen, @Muxelmann and @PMeira for their contributions, as well as all the users for their valuable feedback.
4141

4242
See also our repositories for [DSS-Python](https://github.com/dss-extensions/dss_python) for the underlying Python package used in this package, and
43-
[DSS C-API](https://github.com/dss-extensions/dss_capi) for the modified and extended OpenDSS codebase used in DSS Extensions.
43+
[DSS C-API](https://github.com/dss-extensions/dss_capi) for the modified and extended OpenDSS codebase used in DSS-Extensions.

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
View the last compiled version of the API docs at https://dss-extensions.org/OpenDSSDirect.py/
22

3-
More links at https://dss-extensions.org/ and other notes at [DSS Extensions — OpenDSS: Overview of Python APIs](https://github.com/dss-extensions/dss-extensions/blob/main/python_apis.md).
3+
More links at https://dss-extensions.org/ and other notes at [DSS-Extensions — OpenDSS: Overview of Python APIs](https://github.com/dss-extensions/dss-extensions/blob/main/python_apis.md).

docs/notebooks/Example-OpenDSSDirect.py.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"cell_type": "markdown",
1313
"metadata": {},
1414
"source": [
15-
"OpenDSSDirect.py is a package in the [DSS Extensions](https://dss-extensions.org/) project. As such, it doesn't require EPRI's OpenDSS to be installed. OpenDSSDirect.py provides it's own customized engine through [DSS-Python](https://dss-extensions.org/dss_python/), which in turn enables us to run the DSS engine on Windows, Linux and macOS (including newer Apple ARM processors).\n",
15+
"OpenDSSDirect.py is a package in the [DSS-Extensions](https://dss-extensions.org/) project. As such, it doesn't require EPRI's OpenDSS to be installed. OpenDSSDirect.py provides it's own customized engine through [DSS-Python](https://dss-extensions.org/dss_python/), which in turn enables us to run the DSS engine on Windows, Linux and macOS (including newer Apple ARM processors).\n",
1616
"\n",
1717
"After the installation, you can just import the module and start using it without further steps:"
1818
]

docs/notebooks/GettingStarted.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@
1212
"cell_type": "markdown",
1313
"metadata": {},
1414
"source": [
15-
"`OpenDSSDirect.py` is a package in the [DSS Extensions](https://dss-extensions.org/) project. As such, it doesn't require EPRI's OpenDSS to be installed. `OpenDSSDirect.py` provides it's own customized engine through [DSS-Python](https://dss-extensions.org/dss_python/), which in turn enables us to run the DSS engine on Windows, Linux and macOS (including newer Apple ARM processors)."
15+
"`OpenDSSDirect.py` is a package in the [DSS-Extensions](https://dss-extensions.org/) project. As such, it doesn't require EPRI's OpenDSS to be installed. `OpenDSSDirect.py` provides it's own customized engine through [DSS-Python](https://dss-extensions.org/dss_python/), which in turn enables us to run the DSS engine on Windows, Linux and macOS (including newer Apple ARM processors)."
1616
]
1717
},
1818
{
1919
"attachments": {},
2020
"cell_type": "markdown",
2121
"metadata": {},
2222
"source": [
23-
"For a comparison of the general Python-level API, including a list of our extra functions, please check [DSS Extensions — OpenDSS: Overview of Python APIs](https://github.com/dss-extensions/dss-extensions/blob/main/python_apis.md). That documents introduces and compares DSS-Python, OpenDSSDirect.py, and the official COM implementation."
23+
"For a comparison of the general Python-level API, including a list of our extra functions, please check [DSS-Extensions — OpenDSS: Overview of Python APIs](https://github.com/dss-extensions/dss-extensions/blob/main/python_apis.md). That documents introduces and compares DSS-Python, OpenDSSDirect.py, and the official COM implementation."
2424
]
2525
},
2626
{

docs/notebooks/VoltageProfilePlot.ipynb

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,8 @@
144144
"name": "stderr",
145145
"output_type": "stream",
146146
"text": [
147-
"/home/meira/bin/python/lib/python3.8/site-packages/dss/plot.py:1244: UserWarning: This is still an initial, work-in-progress implementation of plotting for DSS Extensions\n",
148-
" warnings.warn('This is still an initial, work-in-progress implementation of plotting for DSS Extensions')\n"
147+
"/home/meira/bin/python/lib/python3.8/site-packages/dss/plot.py:1244: UserWarning: This is still an initial, work-in-progress implementation of plotting for DSS-Extensions\n",
148+
" warnings.warn('This is still an initial, work-in-progress implementation of plotting for DSS-Extensions')\n"
149149
]
150150
}
151151
],
@@ -173,9 +173,16 @@
173173
}
174174
],
175175
"source": [
176-
"\n",
177176
"dss.Text.Command('plot profile')"
178177
]
178+
},
179+
{
180+
"attachments": {},
181+
"cell_type": "markdown",
182+
"metadata": {},
183+
"source": [
184+
"For examples of what DSS plots are currently available, see https://github.com/dss-extensions/dss_python/blob/master/docs/examples/Plotting.ipynb"
185+
]
179186
}
180187
],
181188
"metadata": {

opendssdirect/Basic.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ def CompatFlags(*args):
168168
169169
- 0x1 (bit 0): If enabled, don't check for NaNs in the inner solution loop. This can lead to various errors.
170170
This flag is useful for legacy applications that don't handle OpenDSS API errors properly. Through the
171-
development of DSS Extensions, we noticed this is actually a quite common issue.
171+
development of DSS-Extensions, we noticed this is actually a quite common issue.
172172
- 0x2 (bit 1): Toggle worse precision for certain aspects of the engine. For example, the sequence-to-phase
173173
(`As2p`) and sequence-to-phase (`Ap2s`) transform matrices. On DSS C-API, we fill the matrix explicitly
174174
using higher precision, while numerical inversion of an initially worse precision matrix is used in the

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def run(self):
3636
setup(
3737
name="OpenDSSDirect.py",
3838
version=version,
39-
description="Python direct-mode interface to OpenDSS",
39+
description="Python direct-mode interface to an alternative implementation of OpenDSS",
4040
long_description=long_description,
4141
long_description_content_type='text/markdown',
4242
url="https://github.com/dss-extensions/OpenDSSDirect.py",

0 commit comments

Comments
 (0)