Nutils 9

src/SUMMARY.md

@@ -21,6 +21,7 @@
     - [Sampling](tutorial-sampling.md)
     - [2D Laplace Problem](tutorial-laplace2d.md)
 - [Release History](release.md)
+    - [Nutils 9 Jook-Sing](release-9.md)
     - [Nutils 8 Idiyappam](release-8.md)
     - [Nutils 7 Hiyamugi](release-7.md)
     - [Nutils 6 Garak-Guksu](release-6.md)

src/examples.md

@@ -7,7 +7,7 @@ concise examples demonstrating different areas of physics and varying
 computational techniques.
 
 The examples are taken from both the Nutils
-[repository](https://github.com/evalf/nutils/tree/master/examples) and user
+[repository](https://github.com/evalf/nutils/tree/main/examples) and user
 contributed repositories, and are tested regularly to confirm validity against
 different versions of Nutils.
 
@@ -20,7 +20,7 @@ test Nutils against, and, in doing so, they may even help themselves by
 preventing future Nutils version from accidentally breaking their code.
 
 Examples should resemble the [official
-examples](https://github.com/evalf/nutils/tree/master/examples) from the Nutils
+examples](https://github.com/evalf/nutils/tree/main/examples) from the Nutils
 repository. In particular, they:
 - use `cli.run` to call main function;
 - have reasonable default parameters corresponding to a simulation that is relevant but not overly expensive;

src/install-matrix.md

@@ -23,7 +23,7 @@ The Scipy matrix backend becomes available when [Scipy](https://www.scipy.org/)
 is installed, either using the platform's package manager or via pip:
 
 ```sh
-python -m pip install --user scipy
+python -m pip install scipy
 ```
 
 In addition to a sparse direct solver, the Scipy backend provides many
@@ -59,3 +59,11 @@ sudo tee /etc/ld.so.conf.d/mkl.conf << EOF > /dev/null
 EOF
 sudo ldconfig -v
 ```
+
+If it is impossible to install MKL system wide, for instance because of lacking
+administrative powers, then an easy way of installing it with user privileges
+is to use pip. Nutils will automatically load the libraries from pip's default
+installation path.
+```sh
+python -m pip install mkl
+```

src/install-nutils.md

@@ -2,49 +2,44 @@
 
 Nutils is installed via Python's [Pip](https://pip.pypa.io/en/stable/) package
 installer, which most Python distributions install by default. In the following
-instructions we add the flag `--user` for a local installation that does not
-require system privileges, which is recommended but not required.
+instructions we assume that pip is run with sufficient privileges to install
+modules system wide, or (more common) that a [virtual
+environment](https://docs.python.org/3/library/venv.html) is active for local
+installation.
 
 The following command installs the stable version of Nutils from the package
 archive, along with its dependencies [Numpy](https://numpy.org/),
 [Treelog](https://github.com/evalf/treelog) and
 [Stringly](https://github.com/evalf/stringly):
 
 ```sh
-python -m pip install --user nutils
+python -m pip install nutils
 ```
 
 To install the most recent development version we use Github's ability to
 generate zip balls:
 
 ```sh
-python -m pip install --user --force-reinstall \
-  https://github.com/evalf/nutils/archive/refs/heads/master.zip
+python -m pip install https://github.com/evalf/nutils/archive/refs/heads/main.zip
 ```
 
 Alternatively, if the [Git](https://git-scm.com/) version control system is
 installed, we can use pip's ability to interact with it directly to install the
 same version as follows:
 
 ```sh
-python -m pip install --user --force-reinstall \
-  git+https://github.com/evalf/nutils.git@master
+python -m pip install git+https://github.com/evalf/nutils.git@main
 ```
 
-This notation has the advantage that even a specific commit (rather than a
-branch) can be installed directly by specifying it after the `@`.
+This notation has the advantage that even a specific tag or commit (rather than
+a branch name) can be installed directly by specifying it after the `@`.
 
-Finally, if we do desire a checkout of Nutils' source code, for instance to
+Finally, if we do desire a checkout of the Nutils source code, for instance to
 make changes to it, then we can instruct pip to install directly from the
 location on disk:
 
 ```sh
 git clone https://github.com/evalf/nutils.git
 cd nutils
-python -m pip install --user .
+python -m pip install .
 ```
-
-In this scenario it is possible to add the `--editable` flag to install Nutils
-by reference, rather than by making a copy, which is useful in situations of
-active development. Note, however, that pip requires manual intervention to
-revert back to a subsequent installation by copy.

src/install-quality.md

@@ -5,12 +5,23 @@ used in conjunction with Nutils to make life a little bit better.
 
 ## BottomBar
 
-[BottomBar](https://github.com/evalf/bottombar) is a context manager for Python
-that prints a status line at the bottom of a terminal window. When it is
+[BottomBar](https://pypi.org/project/bottombar/) is a context manager for
+Python that prints a status line at the bottom of a terminal window. When it is
 installed, `cli.run` automatically activates it to display the location of the
 html log (rather than only logging it at the beginning and end of the
-simulation) as well as runtime and memory usage information.
+simulation) as well as runtime and (optionally) memory usage information.
 
 ```sh
 python -m pip install bottombar
 ```
+
+## Psutil
+
+[Psutil](https://pypi.org/project/psutil/) is a cross platform library for
+retrieving information on the running process. If it is installed in
+conjunction with bottombar, `cli.run` automatically adds an entry that shows
+the current memory usage.
+
+```sh
+python -m pip install psutil
+```

src/install-remote.md

@@ -29,9 +29,8 @@ location ~ ^/~(.+?)(/.*)?$ {
 ```
 
 Finally, the terminal output can be made to show the http address rather than
-the local uri by adding the following line to the `~/.nutilsrc` configuration
-file:
+the local uri by setting the `NUTILS_OUTROOTURI` environment variable, e.g.:
 
 ```
-outrooturi = 'https://mydomain.tld/~myusername/'
+export NUTILS_OUTROOTURI="http://mydomain.tld/~myname/"
 ```

src/release-1.md

@@ -2,4 +2,4 @@
 
 Nutils 1 was released on August 4th, 2014 and saw no point releases.
 - [Download](https://github.com/evalf/nutils/archive/refs/tags/v1.0.zip) (zip)
-- [API Reference](http://docs.nutils.org/en/v1.0/)
+- [API Reference](https://docs.nutils.org/en/v1.0/)

src/release-2.md

@@ -2,7 +2,7 @@
 
 Nutils 2 was released on February 18th, 2016 and saw no point releases.
 - [Download](https://github.com/evalf/nutils/archive/refs/tags/v2.0.zip) (zip)
-- [API Reference](http://docs.nutils.org/en/v2.0/)
+- [API Reference](https://docs.nutils.org/en/v2.0/)
 
 ## What's New?
 

src/release-3.md

@@ -4,7 +4,7 @@ Nutils 3 was released on August 22nd, 2018 and saw one point release for fixes
 and backports. The most recent and final version in this series is Nutils 3.1,
 released on February 5th, 2018.
 - [Download](https://github.com/evalf/nutils/archive/refs/tags/v3.1.zip) (zip)
-- [API Reference](http://docs.nutils.org/en/v3.1/)
+- [API Reference](https://docs.nutils.org/en/v3.1/)
 
 ## What's New?
 

src/release-4.md

@@ -4,7 +4,7 @@ Nutils 4 was released on June 11th, 2019 and saw one point release for fixes
 and backports. The most recent and final version in this series is Nutils 4.1
 was released on August 28th, 2018.
 - [Download](https://github.com/evalf/nutils/archive/refs/tags/v4.1.zip) (zip)
-- [API Reference](http://docs.nutils.org/en/v4.1/)
+- [API Reference](https://docs.nutils.org/en/v4.1/)
 
 ## What's New?
 

src/release-5.md

@@ -4,7 +4,7 @@ Nutils 5 was released on April 3rd, 2020 and saw two point releases for fixes
 and backports. The most recent and final version in this series is Nutils 5.2,
 released on June 11th, 2019.
 - [Download](https://github.com/evalf/nutils/archive/refs/tags/v5.2.zip) (zip)
-- [API Reference](http://docs.nutils.org/en/v5.2/)
+- [API Reference](https://docs.nutils.org/en/v5.2/)
 
 ## What's New?
 

src/release-6.md

@@ -4,7 +4,7 @@ Nutils 6 was released on April 29th, 2020 and saw three point releases for
 fixes and backports. The most recent and final version in this series is Nutils
 6.3, released on November 18th, 2021.
 - [Download](https://github.com/evalf/nutils/archive/refs/tags/v6.3.zip) (zip)
-- [API Reference](http://docs.nutils.org/en/v6.3/)
+- [API Reference](https://docs.nutils.org/en/v6.3/)
 
 ## What's New?
 

src/release-7.md

@@ -4,7 +4,7 @@ Nutils 7 was released on January 1st, 2022 and saw three point releases for
 fixes and backports. The most recent and final version in this series is Nutils
 7.3, released on June 20th, 2023.
 - [Download](https://github.com/evalf/nutils/archive/refs/tags/v7.3.zip) (zip)
-- [API Reference](http://docs.nutils.org/en/v7.3/)
+- [API Reference](https://docs.nutils.org/en/v7.3/)
 
 ## What's New?
 

src/release-8.md

@@ -4,7 +4,7 @@ Nutils 8 was released on July 28th, 2023 and saw eight point releases for fixes
 and backports. The most recent and final version in this series is Nutils 8.8,
 released on July 9th, 2024.
 - [Download](https://github.com/evalf/nutils/archive/refs/tags/v8.8.zip) (zip)
-- [API Reference](http://docs.nutils.org/en/v8.8/)
+- [API Reference](https://docs.nutils.org/en/v8.8/)
 
 ## What's New?