Skip to content

Commit

Permalink
Mention Reference Manual in CHANGES and legacy User's Manual.
Browse files Browse the repository at this point in the history
  • Loading branch information
rdzman committed Dec 5, 2023
1 parent f5456b0 commit e4d70c1
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
3 changes: 3 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ since 8.0b1
numerical error with multiple generators at a bus.
*Thanks to Mirko Todorovski.*

#### 11/20/23
- Add initial MATPOWER Reference Manual to new Sphinx documentation.

#### 6/6/23
- Fix minor bug in `size()` method of `mp.mapped_array.size()` resulting
in fatal error if called with two output arguments.
Expand Down
13 changes: 10 additions & 3 deletions docs/src/MATPOWER-manual/MATPOWER-manual.tex
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,8 @@
\newcommand{\mum}[0]{\href{\mumurl}{\matpower{} User's Manual}}
\newcommand{\mdmurl}[0]{https://matpower.org/documentation/dev-manual}
\newcommand{\mdm}[0]{\href{\mdmurl}{\matpower{} Developer's Manual}}
\newcommand{\mrmurl}[0]{https://matpower.org/documentation/ref-manual}
\newcommand{\mrm}[0]{\href{\mrmurl}{\matpower{} Reference Manual}}
\newcommand{\mipsmanurl}[0]{https://matpower.org/docs/MIPS-manual-\mipsver.pdf}
\newcommand{\mpommanurl}[0]{https://matpower.org/docs/MP-Opt-Model-manual-\mpomver.pdf}
\newcommand{\mostmanurl}[0]{https://matpower.org/docs/MOST-manual-\mostver.pdf}
Expand Down Expand Up @@ -868,9 +870,10 @@ \subsubsection{User's Manuals}

\subsubsection{\matpower{} Documentation Website}

The new \href{https://matpower.org/documentation/}{\matpower{} Documentation site}~\cite{mp_docs} is intended to be the home for all future MATPOWER documentation. It is very much a work-in-progress and currently contains only the new:
The new \href{https://matpower.org/documentation/}{\matpower{} Documentation site}~\cite{mp_docs} is intended to be the home for all future MATPOWER documentation. It is very much a work-in-progress and currently contains the new:
\begin{itemize}
\item \mdm{}~\cite{dev_manual}
\item \mrm{}~\cite{ref_manual}
\end{itemize}

As new documentation is written and legacy manuals are rewritten, they will be found here in HTML and PDF formats. The site is generated by \href{https://www.sphinx-doc.org/}{Sphinx}~\cite{sphinx} and the content is written in reStructuredText (reST) format.
Expand Down Expand Up @@ -8486,7 +8489,7 @@ \subsubsection*{Major Redesign}
\item \emph{Flexible Framework} -- Provides new top-level functions (note underscores) \code{run\_pf()}, \code{run\_cpf()}, \code{run\_opf()} for running power flow (PF), continuation power flow (CPF) and optimal power flow (OPF), along with new \matpower{} Extension API for user access to the full customization capability of \mpcore{}.
\item \emph{Legacy Framework} -- Allows \mpcore{} modeling to be used internally by legacy \code{runpf()}, \code{runcpf()}, \code{runopf()}, etc. Facilitates use of legacy test suite, but is restricted to legacy customization mechanisms.
\end{itemize}
See the new \mdm{}\footnote{\url{\mdmurl}} and \TNfive{}~\cite{zimmerman2020} for details of the new architecture. The User's Manual has not yet been updated for the flexible framework.
See the new \mdm{}\footnote{\url{\mdmurl}}, \mrm{}\footnote{\url{\mrmurl}} and \TNfive{}~\cite{zimmerman2020} for details of the new architecture. The User's Manual has not yet been updated for the flexible framework.

The features based on \mpcore{} are available under MATLAB 9.1 or Octave 6.2 or newer, where the legacy framework uses \mpcore{}'s new modeling by default for:
\begin{itemize}
Expand Down Expand Up @@ -8566,6 +8569,7 @@ \subsubsection*{New Case Files}
\subsubsection*{New Documentation}
\begin{itemize}
\item \mdm{}~\cite{dev_manual} -- describes the architecture of the new \mpcore{} and \matpower{} flexible framework
\item \mrm{}~\cite{ref_manual} -- reference for the functions and classes in the new \mpcore{} and \matpower{} flexible framework
\item \TNfive{} ``\mpe{}: A Unified \matpower{} Element Model, with Corresponding Functions and Derivatives''~\cite{zimmerman2020}
\end{itemize}

Expand Down Expand Up @@ -8723,7 +8727,10 @@ \subsubsection*{Incompatible Changes}
\matpower Documentation website. [Online]. Available: \url{https://matpower.org/documentation/}.

\bibitem{dev_manual}
R.~D. Zimmerman. \mdm. 2022. [Online]. Available: \url{\mdmurl}.
R.~D. Zimmerman. \mdm. 2023. [Online]. Available: \url{\mdmurl}.

\bibitem{ref_manual}
R.~D. Zimmerman. \mrm. 2023. [Online]. Available: \url{\mrmurl}.

\bibitem{sphinx}
Sphinx. [Software]. Available: \url{https://www.sphinx-doc.org/}
Expand Down

0 comments on commit e4d70c1

Please sign in to comment.