Dss-python

Released on 2024-02-09.

- Upgrade the backend to [**AltDSS/DSS C-API 0.14.0**](https://github.com/dss-extensions/dss_capi/releases/tag/0.14.0). **A lot** of changes there, please check the changelog. Includes many small bugfixes, improvements, and ports of a few changes from the official OpenDSS codebase, matching OpenDSS v9.8.0.1.

- Enums:
- Move to DSS-Python-Backend to allow easier sharing among all Python packages from DSS-Extensions.
- Convert enum comments to docstrings for better user experience.
- New `DSSCompatFlags.ActiveLine`.
- New `DSSJSONFlags.SkipTimestamp`, `DSSJSONFlags.SkipBuses`, `DSSJSONFlags.IncludeDefaultObjs`.
- New `DSSSaveFlags` (used in the new function `Circuit.Save`)
- New `EnergyMeterRegisters` and `GeneratorRegisters` to simplify handling register indexes from EnergyMeters (`EnergyMeterRegisters`), Generators, PVSystems, and Storage objects (these last three use `GeneratorRegisters`).
- Use enums in a few more methods.

- Packaging: Migrate build system to `pyproject.toml` and Hatch.
- Implement the DSSEvents interface. Note that this is not a popular interface and we haven't seen it used in Python with COM yet. OpenDSS comes with a couple of examples using VBA in Excel though.
- Drop `CheckForError()`; use `_check_for_error()` instead (same function, but the latter doesn't pollute the public scope).
- Expose `Circuit.Save()` function
- Expose `Circuit.FromJSON()` function
- Move `DSS.Obj` to the new [AltDSS-Python package](https://github.com/dss-extensions/AltDSS-Python) (`pip install altdss`, `from altdss import altdss`).
- **Breaking change**: the main object classes previously used indices starting at 1, but it seemed unnatural in Python and when used with the rest of the API, so they now behave as normal batches and start at 0. Affects both the `find()` method and the brackets (e.g. `altdss.Load[0]`) syntax.
- **Lots** of new features.
- Use weakrefs to avoid accidentally extending the lifetime of DSSContexts.
- Update documentation framework (Sphinx) to use Markdown, based on MyST and autodoc2.

0.14.x

Released on 2023-06-27.

- Upgrade the backend to [**AltDSS/DSS C-API 0.13.4**](https://github.com/dss-extensions/dss_capi/releases/tag/0.13.4). Includes a bugfix to CapControl, some more error handling, DSSEvents backend functions. This matches the changes in OpenDSS v9.6.1.3, plus our custom changes as usual.
- Use better DSSContext pointer to IDSS mapping.
- Plotting: handle empty monitors better, ignore invalid channels.
- Documentation updated.

Released on 2023-06-12.

- Upgrade the backend to [**AltDSS/DSS C-API 0.13.3**](https://github.com/dss-extensions/dss_capi/releases/tag/0.13.3). Includes important fixes to some OpenDSS components affected by bugs for several years. This matches the changes in OpenDSS v9.6.1.2, plus our custom changes as usual.
- Add `DSS.Error.UseExceptions` to allow disabling the automatic mapping of error numbers to Python exceptions. When disabling, users take full responsibility to actually check for errors through the `DSS.Error` interface.
- Add `DSSCompatFlags.SaveCalcVoltageBases`.
- Transformers: add a warning in the docstrings of `WdgCurrents`, `WdgVoltages` (these don't work well when the transformer has open terminals).
- Plotting: handle GICLines in circuit plots.

Released on 2023-05-25.

- Append DSS-Python's version in `DSS.Version`.
- Complement and fix most plot types, leaving only a couple of plots without implementation. An example notebook will be added later.
- Upgrade the backend to DSS C-API v0.13.2.
- Fix some batch property setters, namely when the values are lists of lists, lists of arrays, or 2-d arrays.
- Update Obj and Batch to include newer DSS properties.
- Add JSON option `SkipDSSClass`.
- Coupled with the backend changes, the JSON output should be more well-behaved for Transformer and Line variations.

Released on 2023-04-13.

- Fix issue with newer NumPy versions with YMatrix (`GetCompressedYMatrix`), after the removal of `numpy.complex`.
- Use some mode enums.

Released on 2023-04-03.

Same as version 0.13.1, except that the organization of the module has changed to facilitate fast iteration of the Python side of the code.

We introduced the new package `dss_python_backend` that will contain all native libs and CFFI bindings from this point on. This leaves DSS-Python itself as a pure Python package, which is much easier to package and distribute.

0.13.x