Skip to content

Commit 4f265df

Browse files
committed
[skip ci] Minor doc updates, update links
1 parent 8b81796 commit 4f265df

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ flowchart TD
2828

2929
</center>
3030

31-
AltDSS-Python is one of three Python projects under DSS-Extensions. See [DSS-Extensions — OpenDSS: Overview of Python APIs](https://dss-extensions.org/python_apis.html) for a brief comparison between these and the official COM API. Both OpenDSSDirect.py and DSS-Python expose the classic OpenDSS API (closer to the COM implementation), including most of its limitations. AltDSS-Python, on the other hand, exposes all OpenDSS objects, batch operations, and a more intuitive API. If required, users can mix all three packages in the same project to access some of their unique features, or just to avoid changing legacy/stable code.
31+
AltDSS-Python is one of three Python projects under DSS-Extensions. See [DSS-Extensions — OpenDSS: Overview of Python APIs](https://dss-extensions.org/python_apis.html) for a brief comparison between these and the official COM API. Both OpenDSSDirect.py and DSS-Python expose the classic OpenDSS API (closer to the COM implementation). AltDSS-Python, on the other hand, exposes all OpenDSS objects, batch operations, and a more intuitive API. If required, users can mix all three packages in the same project to access some of their unique features, or just to avoid changing legacy/stable code.
3232

33-
Since the base code is share, other features from [DSS-Python such as plotting](https://dss-extensions.org/dss_python/examples/Plotting.html) can be used here. Other examples from DSS-Python or OpenDSSDirect.py can be adapted quite easily too.
33+
Since the base code is shared, other features from [DSS-Python such as plotting](https://dss-extensions.org/DSS-Python/examples/Plotting.html) can be used here. Other examples from DSS-Python or OpenDSSDirect.py can be adapted quite easily too.
3434

3535
## What is AltDSS?
3636

docs/examples/GettingStarted.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1236,7 +1236,7 @@
12361236
"\u001b[0;31mTypeError\u001b[0m Traceback (most recent call last)",
12371237
"Cell \u001b[0;32mIn[47], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[43mbus0\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mName\u001b[49m\n",
12381238
"File \u001b[0;32m~/projects/dss/altdss-python/altdss/Bus.py:100\u001b[0m, in \u001b[0;36mBus.Name\u001b[0;34m(self)\u001b[0m\n\u001b[1;32m 97\u001b[0m \u001b[38;5;129m@property\u001b[39m\n\u001b[1;32m 98\u001b[0m \u001b[38;5;28;01mdef\u001b[39;00m \u001b[38;5;21mName\u001b[39m(\u001b[38;5;28mself\u001b[39m) \u001b[38;5;241m-\u001b[39m\u001b[38;5;241m>\u001b[39m \u001b[38;5;28mstr\u001b[39m:\n\u001b[1;32m 99\u001b[0m \u001b[38;5;250m \u001b[39m\u001b[38;5;124;03m'''Name of Bus'''\u001b[39;00m\n\u001b[0;32m--> 100\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_get_string(\u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43m_lib\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mAlt_Bus_Get_Name\u001b[49m\u001b[43m(\u001b[49m\u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43m_ptr\u001b[49m\u001b[43m)\u001b[49m)\n",
1239-
"File \u001b[0;32m~/projects/dss/dss_python/dss/_cffi_api_util.py:82\u001b[0m, in \u001b[0;36mCtxLib._error_checked\u001b[0;34m(self, _errorPtr, f, *args)\u001b[0m\n\u001b[1;32m 81\u001b[0m \u001b[38;5;28;01mdef\u001b[39;00m \u001b[38;5;21m_error_checked\u001b[39m(\u001b[38;5;28mself\u001b[39m, _errorPtr, f, \u001b[38;5;241m*\u001b[39margs):\n\u001b[0;32m---> 82\u001b[0m result \u001b[38;5;241m=\u001b[39m \u001b[43mf\u001b[49m\u001b[43m(\u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43margs\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m 83\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m _errorPtr[\u001b[38;5;241m0\u001b[39m] \u001b[38;5;129;01mand\u001b[39;00m Base\u001b[38;5;241m.\u001b[39m_use_exceptions:\n\u001b[1;32m 84\u001b[0m error_num \u001b[38;5;241m=\u001b[39m _errorPtr[\u001b[38;5;241m0\u001b[39m]\n",
1239+
"File \u001b[0;32m~/projects/dss/DSS-Python/dss/_cffi_api_util.py:82\u001b[0m, in \u001b[0;36mCtxLib._error_checked\u001b[0;34m(self, _errorPtr, f, *args)\u001b[0m\n\u001b[1;32m 81\u001b[0m \u001b[38;5;28;01mdef\u001b[39;00m \u001b[38;5;21m_error_checked\u001b[39m(\u001b[38;5;28mself\u001b[39m, _errorPtr, f, \u001b[38;5;241m*\u001b[39margs):\n\u001b[0;32m---> 82\u001b[0m result \u001b[38;5;241m=\u001b[39m \u001b[43mf\u001b[49m\u001b[43m(\u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43margs\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m 83\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m _errorPtr[\u001b[38;5;241m0\u001b[39m] \u001b[38;5;129;01mand\u001b[39;00m Base\u001b[38;5;241m.\u001b[39m_use_exceptions:\n\u001b[1;32m 84\u001b[0m error_num \u001b[38;5;241m=\u001b[39m _errorPtr[\u001b[38;5;241m0\u001b[39m]\n",
12401240
"\u001b[0;31mTypeError\u001b[0m: initializer for ctype 'void *' must be a cdata pointer, not InvalidatedDSSBus"
12411241
]
12421242
}

docs/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ For alternatives for other programming languages, including in MATLAB, C++, C#/.
1919
```mermaid
2020
flowchart TD
2121
C["AltDSS engine/DSS C-API\n(libdss_capi)"] --> P["DSS-Python: Backend"]
22-
P --- DSSPY["<a href='https://dss-extensions.org/dss_python/'>DSS-Python\n(dss package)</a>"]
22+
P --- DSSPY["<a href='https://dss-extensions.org/DSS-Python/'>DSS-Python\n(dss package)</a>"]
2323
P --- ODDPY["<a href='https://dss-extensions.org/opendssdirect.py'>OpenDSSDirect.py\n(opendssdirect package)</a>"]
2424
P --- ALTDSSPY["AltDSS-Python\n(altdss package)"]
2525
```
2626

2727
</center>
2828

29-
AltDSS-Python is one of three Python projects under DSS-Extensions. See [DSS-Extensions — OpenDSS: Overview of Python APIs](https://dss-extensions.org/python_apis.html) for a brief comparison between these and the official COM API. Both OpenDSSDirect.py and DSS-Python expose the classic OpenDSS API (closer to the COM implementation), including most of its limitations. AltDSS-Python, on the other hand, exposes all OpenDSS objects, batch operations, and a more intuitive API. If required, users can mix all three packages in the same project to access some of their unique features, or just to avoid changing legacy/stable code.
29+
AltDSS-Python is one of three Python projects under DSS-Extensions. See [DSS-Extensions — OpenDSS: Overview of Python APIs](https://dss-extensions.org/python_apis.html) for a brief comparison between these and the official COM API. Both OpenDSSDirect.py and DSS-Python expose the classic OpenDSS API (closer to the COM implementation). AltDSS-Python, on the other hand, exposes all OpenDSS objects, batch operations, and a more intuitive API. If required, users can mix all three packages in the same project to access some of their unique features, or just to avoid changing legacy/stable code.
3030

31-
Since the base code is share, other features from [DSS-Python such as plotting](https://dss-extensions.org/dss_python/examples/Plotting.html) can be used here. Other examples from DSS-Python or OpenDSSDirect.py can be adapted quite easily too.
31+
Since the base code is shared, other features from [DSS-Python such as plotting](https://dss-extensions.org/DSS-Python/examples/Plotting.html) can be used here. Other examples from DSS-Python or OpenDSSDirect.py can be adapted quite easily too.
3232

3333
## What is AltDSS?
3434

@@ -69,7 +69,7 @@ Note that the general interaction through .DSS scripts is unchanged and users ca
6969

7070
Besides the naming issue, although both DSS-Python and OpenDSSDirect.py acquired features since 2018, when DSS-Extensions was born, adding a lot of the features from AltDSS would break compatibility in a major way. Initially, more Pythonic and extra features were expected to land on OpenDSSDirect.py. Looking into the list of publications and public repositories using both packages suggests that breaking the API to introduce features is not advisable.
7171

72-
Moreover, many users still see OpenDSSDirect.py and think that it uses OpenDSSDirect.DLL. That is not the case, and even when it was (before August 2018), the Linux and macOS builds of OpenDSS were not supported by EPRI, the original OpenDSS developer. Effectively, OpenDSSDirect.py (OpenDSSDirect.jl is in a similar situation) never used an official binary on non-Windows platforms, since there is not as of February 2024.
72+
Moreover, many users still see OpenDSSDirect.py and think that it uses OpenDSSDirect.DLL. That is not the case, and even when it was (before August 2018), the Linux and macOS builds of OpenDSS were not supported by EPRI, the original OpenDSS developer. Effectively, OpenDSSDirect.py (OpenDSSDirect.jl is in a similar situation) never used an official binary on non-Windows platforms, since there is not any as of February 2024.
7373

7474
That said, we hope both new and experienced OpenDSS users find it easy to adopt it.
7575

@@ -97,12 +97,12 @@ altdss package <apidocs/index.rst>
9797
:maxdepth: 1
9898
:hidden:
9999
:caption: External links
100-
GitHub repository <https://github.com/dss-extensions/dss_python>
101-
Package on PyPI <https://pypi.python.org/pypi/OpenDSSDirect.py/>
100+
GitHub repository <https://github.com/dss-extensions/AltDSS-Python>
101+
Package on PyPI <https://pypi.python.org/pypi/altdss/>
102102
Test/example circuits <https://github.com/dss-extensions/electricdss-tst>
103103
DSS-Extensions/FAQ <https://github.com/dss-extensions/dss-extensions#faq>
104104
OpenDSSDirect.py <https://dss-extensions.org/OpenDSSDirect.py>
105-
DSS-Python <https://dss-extensions.org/dss_python/>
105+
DSS-Python <https://dss-extensions.org/DSS-Python/>
106106
DSS-Extensions Discussions <https://github.com/orgs/dss-extensions/discussions>
107107
OpenDSS forum <https://sourceforge.net/p/electricdss/discussion/>
108108
OpenDSS documentation <https://opendss.epri.com/opendss_documentation.html>

0 commit comments

Comments
 (0)