Skip to content

Commit

Permalink
README.md: update link to the official docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PMeira authored Mar 26, 2024
1 parent b32c35c commit 9dc0159
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,7 @@ Remember that this package is meant to be a drop-in replacement for the official
1. The basic MATLAB `help` command can be used to get a list of functions and properties available in the objects.
2. The DSS-Python reference can be useful for discoverability, e.g. [The DSS instance](https://dss-extensions.org/dss_python/#the-dss-instance). [DSS Sharp](https://dss-extensions.org/dss_sharp/) reference is also an alternative.
3. We have an online document listing most DSS properties and commands at [DSS-Extensions: OpenDSS Commands and Properties](https://dss-extensions.org/dss_properties.html).
4. This official OpenDSS COM lists the official API contents: [OpenDSSComDoc.pdf](https://sourceforge.net/p/electricdss/code/HEAD/tree/trunk/Version8/Distrib/Doc/OpenDSSComDoc.pdf?format=raw)
5. There is another official document in a less accessible format that can be used for those still learning the basics, but remember we offer a wider range of features: [official OpenDSS_COM.chm on SourceForge](https://sourceforge.net/p/electricdss/code/HEAD/tree/trunk/Version8/Distrib/x64/OpenDSS_COM.chm?format=raw). This includes some basic examples of usage.

This last one is a CHM file (Winhelp, compressed HTML files), Windows supports it natively.
On Linux, there are multiple CHM readers, such as KchmViewer — check your package manager or store for more.
On macOS, [this fork of iCHM](https://github.com/vit9696/iChm/releases/latest) works, and there are some alternatives in the Apple App Store.
Wine also comes with a CHM reader.
4. This official OpenDSS COM lists the official API contents: https://opendss.epri.com/COMInterface.html

## Known differences and history

Expand Down

0 comments on commit 9dc0159

Please sign in to comment.