Move Python examples to standard location

.github/workflows/main.yml

@@ -301,7 +301,7 @@ jobs:
       - name: Run the examples
         # See https://unix.stackexchange.com/a/392973 for an explanation of the -exec part
         run: |
-          find interfaces/cython/cantera/examples -type f -iname "*.py" \
+          find samples/python -type f -iname "*.py" \
           -exec sh -c 'for n; do echo "$n" | tee -a results.txt && python3 "$n" >> results.txt || exit 1; done' sh {} +
         env:
           PYTHONPATH: build/python
@@ -364,6 +364,7 @@ jobs:
           test -f ${CONDA_PREFIX}/bin/ck2yaml
           test -f ${CONDA_PREFIX}/share/cantera/data/gri30.yaml
           test -d ${CONDA_PREFIX}/share/cantera/samples
+          test -d ${CONDA_PREFIX}/share/cantera/samples/python
           test -d ${CONDA_PREFIX}/lib/python${{ env.PYTHON_VERSION }}/site-packages/cantera
       - name: Test Essentials
         # ensure that Python package loads and converter scripts work
@@ -428,6 +429,7 @@ jobs:
         test -f ${CONDA_PREFIX}/Scripts/ck2yaml
         test -f ${CONDA_PREFIX}/share/cantera/data/gri30.yaml
         test -d ${CONDA_PREFIX}/share/cantera/samples
+        test -d ${CONDA_PREFIX}/share/cantera/samples/python
         test -d ${CONDA_PREFIX}/Lib/site-packages/cantera
     - name: Test Essentials
       # ensure that Python package loads and converter scripts work

SConstruct

@@ -2075,7 +2075,7 @@ def postInstallMessage(target, source, env):
         ))
 
     if env["python_package"] == "full":
-        env["python_example_loc"] = pjoin(env["python_module_loc"], "cantera", "examples")
+        env["python_example_loc"] = pjoin(env["ct_sampledir"], "python")
         install_message.append(locations_message.format(
             name="Python package", location=env_dict["python_module_loc"]
         ))

doc/example-keywords.py

@@ -128,7 +128,7 @@ def get_all_keywords():
     skip = set(text.splitlines())
 
     all_keywords = Counter()
-    for d in (cantera_root / "interfaces/cython/cantera/examples").glob("**"):
+    for d in (cantera_root / "samples" / "python").glob("**"):
         if d.is_dir():
             for f in d.glob("*.py"):
                 if f.name.startswith("_") or f.name in skip:

interfaces/cython/SConscript

@@ -12,6 +12,9 @@ localenv = env.Clone()
 dataFiles = localenv.RecursiveInstall("cantera/data", "#build/data")
 build(dataFiles)
 
+# Install Python samples
+install(localenv.RecursiveInstall, "$inst_sampledir/python", "#samples/python")
+
 # Get information needed to build the Python module
 script = """\
 from sysconfig import *
@@ -114,7 +117,8 @@ env['python_module'] = mod
 env['python_extension'] = ext
 
 localenv.Depends(mod, [ext, dataFiles, setup_cfg, readme, license,
-                       "setup.py", "pyproject.toml", "cantera/test/README.txt"])
+                       "setup.py", "pyproject.toml",
+                       "cantera/test/README.txt", "cantera/examples/README.txt"])
 localenv.Depends(ext, localenv['cantera_staticlib'])
 
 for f in (multi_glob(localenv, 'cantera', 'py') +

interfaces/cython/cantera/examples/README.txt

@@ -0,0 +1,5 @@
+Starting with Cantera 3.0, Python examples are no longer packaged with the Python
+module. Examples illustrating the usage of the Python module can be found on Cantera's
+website (https://cantera.org). Alternatively, examples can be accessed in the directory
+"samples/python" of the source code, which can be retrieved from the project's GitHub
+repository (https://github.com/Cantera/cantera).

interfaces/cython/setup.cfg.in

@@ -47,15 +47,13 @@ python_requires = >=@py_min_ver_str@
 packages =
     cantera
     cantera.data
-    cantera.examples
 
 [options.package_data]
 cantera.data = *.*, */*.*
-cantera.examples = */*.*
-# The module extension needs to be here since we don't want setuptools to
-# compile the extension, so there are no `source` files in
-# the setup.py extension.
-cantera = *.pxd, *@module_ext@, test/*.txt
+# The module extension needs to be here since we don't want setuptools to compile
+# the extension, so there are no ``source`` files in the setup.py ``extension`` and
+# we have to treat the module as package data.
+cantera = *.pxd, *@module_ext@, test/*.txt, examples/*.txt
 
 [options.extras_require]
 hdf5 = h5py

interfaces/python_sdist/setup.cfg.in

@@ -47,15 +47,13 @@ python_requires = >=@py_min_ver_str@
 packages =
     cantera
     cantera.data
-    cantera.examples
 
 # These options include data in the sdist and wheel if the files are also listed in
 # MANIFEST.in. Note that only files that are inside the "cantera" packages will be
 # included in the wheel.
 [options.package_data]
 cantera.data = *.*, */*.*
-cantera.examples = */*.*
-cantera = *.pxd
+cantera = *.pxd, test/*.txt, examples/*.txt
 
 # These options exclude data from the wheel file but not from the sdist
 [options.exclude_package_data]

test/python/test_reactor.py

@@ -1565,7 +1565,7 @@ class CombustorTestImplementation:
     """
     These tests are based on the sample:
 
-        interfaces/cython/cantera/examples/reactors/combustor.py
+        samples/python/reactors/combustor.py
 
     with some simplifications so that they run faster and produce more
     consistent output.
@@ -1671,7 +1671,7 @@ class WallTestImplementation:
     """
     These tests are based on the sample:
 
-        interfaces/cython/cantera/examples/reactors/reactor2.py
+        samples/python/reactors/reactor2.py
 
     with some simplifications so that they run faster and produce more
     consistent output.