Merge pull request #234 from snek5000/prepare-snek5000-tgv-0.1.0

Prepare snek5000-tgv 0.1.0

CHANGELOG.md

@@ -32,19 +32,17 @@ Security in case of vulnerabilities.
 
 ## [0.8.0] - 2022-12-05
 
-This is the first stable version and is the result of a huge work (more than
-550 commits and [60 closed
-issues](https://github.com/snek5000/snek5000/milestone/1)). To summarize, we
-work a lot on stability, on improving the API, the logging and the user
-experience, and on improving our
-[documentation](https://snek5000.readthedocs.io) and
-[tutorials](https://snek5000.readthedocs.io/en/latest/tutorials.html). The
-following lists are a very incomplete lists of the additions, changes and
-deprecations.
+This is the first stable version and is the result of a huge work (more than 550 commits
+and [60 closed issues](https://github.com/snek5000/snek5000/milestone/1)). To summarize,
+we work a lot on stability, on improving the API, the logging and the user experience,
+and on improving our [documentation](https://snek5000.readthedocs.io) and
+[tutorials](https://snek5000.readthedocs.io/en/latest/tutorials.html). The following
+lists are a very incomplete lists of the additions, changes and deprecations.
 
 ### Added
 
-- Commands [`snek-make`](https://snek5000.readthedocs.io/en/latest/how-to/snek-make.html),
+- Commands
+  [`snek-make`](https://snek5000.readthedocs.io/en/latest/how-to/snek-make.html),
   [`snek-restart`](https://snek5000.readthedocs.io/en/latest/how-to/restart.html),
   `snek-info`, `snek-ipy-load` and `snek-generate-config`.
 - Functions {func}`snek5000.util.restart.load_for_restart`,

docs/examples/snek5000-tgv/README.md

@@ -1,6 +1,15 @@
-Orphan:
+# Snek5000 solver for DNS of Taylor-Green Vortices (TGV)
 
-# Verification: DNS of the Taylor-Green vortex at Re=1600
+This [Snek5000] solver demonstrate how to write a solver for a particular usecase taken
+from the [NekExamples repo]. Something completely different than a high speed train...
 
-This example would reuse the `tgv.usr` file and the reference data given in
-[NekExamples repo](https://github.com/Nek5000/NekExamples/tree/master/tgv).
+## Install
+
+```bash
+pip install snek5000-tgv
+```
+
+For more details, see https://snek5000.readthedocs.io/en/latest/install.html
+
+[nekexamples repo]: https://github.com/Nek5000/NekExamples/tree/master/tgv
+[snek5000]: https://github.com/snek5000/snek5000

docs/examples/snek5000-tgv/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
-name = snek5000_tgv
-version = 0.0.1
+name = snek5000-tgv
+version = 0.1.0
 description = Taylor-Green vortex
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -12,7 +12,7 @@ package_dir=
     =src
 packages=find:
 install_requires =
-    snek5000
+    snek5000 >= 0.8.0rc1
 
 [options.entry_points]
 snek5000.solvers =

setup.cfg

@@ -68,7 +68,7 @@ docs =
     linkify-it-py
     scipy
     # TODO: add these solvers when they are on PyPI.
-    # phill
+    # snek5000-phill
     # snek5000-cbox
 
 tests =