Replies: 1 comment
-
EPRI has released most of docs at https://opendss.epri.com/opendss_documentation.html in a more accessible format. With that, this can be closed without further action. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Since some of our packages are intended to be drop-in replacements for the official COM implementation, a lot of the official documents, help files and examples can be used with little to no modifications. Even for the packages without the same layout as the COM object, the same concepts still apply, with some slight changes.
Conversely, a lot of our documentation can be used with the official OpenDSS implementation (just ignore anything marked "API Extension"). After all, we track and port almost all changes in the upstream version here.
For links to specific docs, please see the individual repositories or https://github.com/dss-extensions/dss-extensions#api-documentation
OpenDSS_COM.chm
We noticed that users are unaware of how to use some of the documents from the official OpenDSS, especially
OpenDSS_COM.chm
, hence this post. This includes some basic examples of usage in MATLAB.This is a Winhelp file, which contains compiled HTML files linked together. Windows supports it natively and Wine also comes with a CHM reader.
On Linux, there are multiple CHM readers, such as KchmViewer — check your package manager or store for more (avoid Okular, it doesn't work correctly for this file):
On macOS, this fork of iChm works, and there are alternatives in the Apple App Store (beware of "in-app purchases" though).
For completeness, this is how the file is displayed on Windows 10:
Feedback?
I'll leave this open for potential feedback. We can add a specific page in the docs detailing this for some of the more common scenarios, but there is a lot of freedom, multiple ways to use the documents. For example, one could also try to use the chm2pdf tool to convert the CHM file to PDF, which is a more accessible format that any web browser supports nowadays.
Especially if you're a non-Windows user:
Beta Was this translation helpful? Give feedback.
All reactions