From eaa0590df3077a84068ae6a288b395a581ba9a60 Mon Sep 17 00:00:00 2001 From: "Kai T. Ohlhus" Date: Wed, 12 Jan 2022 14:16:51 +0900 Subject: [PATCH] doc: minor changes --- doc/Makefile | 1 - doc/_config.yml | 2 +- doc/_toc.yml | 4 +++- doc/s00_getting_started.ipynb | 8 +++++++- doc/s01_installation.ipynb | 3 +-- doc/s02_conic_programming.ipynb | 7 +++---- doc/s08_free_variables.ipynb | 1 + doc/s10_conic_solvers.ipynb | 1 + 8 files changed, 17 insertions(+), 10 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index cddfdc1..81c53fb 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -24,7 +24,6 @@ $(TARGET_LATEX): $(SRC) $(TARGET_PDF): $(SRC) sed -i 's/\\begin{split}\\tag\*{\$$\\Box\$$}\\end{split}/\\tag\*{\$$\\Box\$$}/g' $(TARGET_LATEX) - sed -i '/^\\setmainlanguage.*/i \\\\usepackage{xeCJK}\n\\setCJKmainfont{IPAMincho}\n\\setCJKsansfont{IPAGothic}\n\\setCJKmonofont{IPAGothic}' $(TARGET_LATEX) cd $(TARGET_LATEX_DIR) && $(MAKE) publish: $(TARGET_HTML) diff --git a/doc/_config.yml b/doc/_config.yml index 641b769..04c9088 100644 --- a/doc/_config.yml +++ b/doc/_config.yml @@ -1,7 +1,7 @@ # Book settings # Learn more at https://jupyterbook.org/customize/config.html -title: "VSDP manual" +title: "VSDP 2020 manual" author: "C. Jansson et al." copyright: "2018-2022" logo: "res/sdp_cone.png" diff --git a/doc/_toc.yml b/doc/_toc.yml index fa626d3..954b983 100644 --- a/doc/_toc.yml +++ b/doc/_toc.yml @@ -1,7 +1,7 @@ format: jb-book root: s00_getting_started.ipynb parts: - - caption: Contents + - caption: Manual chapters: - file: s01_installation.ipynb - file: s02_conic_programming.ipynb @@ -16,4 +16,6 @@ parts: chapters: - file: s09_numerical_results.ipynb - file: s10_conic_solvers.ipynb + # For PDF move section of s11_references.ipynb + # into previous file, to avoid double header. - file: s11_references.ipynb diff --git a/doc/s00_getting_started.ipynb b/doc/s00_getting_started.ipynb index ba0829b..868cc64 100644 --- a/doc/s00_getting_started.ipynb +++ b/doc/s00_getting_started.ipynb @@ -6,6 +6,11 @@ "source": [ "# Getting started\n", "\n", + "Latest version of this manual \n", + "or .\n", + "\n", + "## Abstract\n", + "\n", "**VSDP (Verified SemiDefinite-quadratic-linear Programming)** is a software\n", "package for the computation of verified results in conic programming.\n", "It supports the constraint cone consisting of the product of semidefinite cones,\n", @@ -30,7 +35,7 @@ "metadata": {}, "source": [ "The latest version of VSDP provides easy access to the\n", - "[conic solvers](s10_conic_solvers.ipynb):\n", + "[conic solvers](conic_solvers):\n", "- [CSDP](https://github.com/coin-or/Csdp),\n", " [GLPK](https://www.gnu.org/software/glpk),\n", " [LINPROG](https://www.mathworks.com/help/optim/ug/linprog.html),\n", @@ -67,6 +72,7 @@ "## Contributors\n", "\n", "- [Christian Jansson](https://www.tuhh.de/ti3/jansson/)\n", + " ()\n", "- Marko Lange ()\n", "- Viktor Härter\n", "- Kai Torben Ohlhus ()" diff --git a/doc/s01_installation.ipynb b/doc/s01_installation.ipynb index f93077f..7c9ea97 100644 --- a/doc/s01_installation.ipynb +++ b/doc/s01_installation.ipynb @@ -51,8 +51,7 @@ "[`vsdp-2020-master.zip`](https://github.com/vsdp/vsdp-2020/archive/refs/heads/master.zip)\n", "and extract it to an arbitrary location.\n", "\n", - "Legacy versions of VSDP are available from\n", - ".\n", + "Legacy versions of VSDP are available from .\n", "\n", "### Using git\n", "\n", diff --git a/doc/s02_conic_programming.ipynb b/doc/s02_conic_programming.ipynb index b922648..a193d31 100644 --- a/doc/s02_conic_programming.ipynb +++ b/doc/s02_conic_programming.ipynb @@ -180,8 +180,7 @@ "free variables are converted into the difference of non-negative variables.\n", "Besides the major disadvantage that this transformation is numerical unstable,\n", "it also increases the number of variables of the particular problems.\n", - "In VSDP [free variables](s08_free_variables.ipynb)\n", - "can be handled in a numerical stable manner." + "In VSDP [free variables](free_variables) can be handled in a numerical stable manner." ] }, { @@ -291,7 +290,7 @@ "metadata": {}, "source": [ "$$\n", - "\\begin{align}\n", + "\\begin{aligned}\n", "\\mathcal{K} &:=&\n", "\\mathbb{R}^{n_{f}} &\\times\n", "\\mathbb{R}^{n_{l}}_{+} \\times\n", @@ -302,7 +301,7 @@ "\\mathbb{R}^{n_{l}}_{+} \\times\n", "\\mathbb{L}^{q_{1}} \\times \\ldots \\times \\mathbb{L}^{q_{n_{q}}} \\times\n", "\\mathbb{S}^{s_{1}}_{+} \\times \\ldots \\times \\mathbb{S}^{s_{n_{s}}}_{+}.\n", - "\\end{align}\n", + "\\end{aligned}\n", "$$" ] }, diff --git a/doc/s08_free_variables.ipynb b/doc/s08_free_variables.ipynb index 19643d0..246d6f7 100644 --- a/doc/s08_free_variables.ipynb +++ b/doc/s08_free_variables.ipynb @@ -19,6 +19,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ + "(free_variables)=\n", "# Free Variables\n", "\n", "Free variables often occur in practice.\n", diff --git a/doc/s10_conic_solvers.ipynb b/doc/s10_conic_solvers.ipynb index b30a3fa..15f297a 100644 --- a/doc/s10_conic_solvers.ipynb +++ b/doc/s10_conic_solvers.ipynb @@ -4,6 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ + "(conic_solvers)=\n", "# Conic solvers\n", "\n", "In this section we provide some notes about our usage experience with VSDP\n",