update build system (#519)

* replace setup.py with pyporject.toml for easier maintenance and compatibility with PEP 517.

* updated pypi publish Action to utilize build instead of 'python setup.py sdist bdis_wheel' as recommended by https://packaging.python.org/en/latest/discussions/setup-py-deprecated/

* updated docs to reflect changes to build system.

* updated test execution location because /examples is not installed as a package.

* fix typo in RTD instructions

* Revert "updated test execution location because /examples is not installed as a package."

This reverts commit 943d1ae.

* copied /examples/distr/distr_data.py to /mpisppy/tests/ and updated some imports accordingly.

* correcting import error introduced in an earlier commit

Author: bwpriest

.github/workflows/publish-to-test-pypi.yml

@@ -17,10 +17,11 @@ jobs:
         python-version: 3.11
     - name: Install mpi-sppy 
       run: |
-        python -m pip install --user --upgrade setuptools wheel
+        python -m pip install --user --upgrade pip
+        pip install build
     - name: Build a binary wheel and a source tarball
       run: | 
-        python3 setup.py sdist bdist_wheel
+        python -m build
     - name: Publish distribution to Test PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
       with:

.gitignore

@@ -131,5 +131,9 @@ dmypy.json
 # .svn
 .svn/
 
+# emacs artifacts
+*~
+*#*
+
 # .DS_Store
 .DS_Store

.readthedocs.yml

@@ -4,17 +4,19 @@
 # Required
 version: 2
 
-
 build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.9"
+   os: ubuntu-22.04
+   tools:
+      python: "3.9"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: doc/src/conf.py
+   configuration: doc/src/conf.py
 
 # we need mpi-sppy for automodule
 python:
-  install:
-    - requirements: requirements-doc.txt
+   install:
+      - method: pip
+        path: .
+        extra_requirements:
+           - doc

README.rst

@@ -28,6 +28,10 @@ Here are two methods that seem to work well for installation, at least when cons
 
    * ``pip install mpi4py``
 
+#. It is also possible to automate mpi4py installation through pip  as an optional dependency when installing mpi-sppy from pip or from source by adding the `[mpi]` extras flag.
+
+   * ``pip install -e .[mpi]`` (after cloning and moving to the repo root directory)
+
 To test
 your installation, cd to the directory where you installed mpi-sppy
 (it is called ``mpi-sppy``) and then give this command.

doc/src/install_mpi.rst

@@ -16,6 +16,10 @@ Here are two methods that seem to work well for installation, at least when cons
 
    * ``pip install mpi4py``
 
+#. It is also possible to automate mpi4py installation through pip  as an optional dependency when installing mpi-sppy from pip or from source by adding the `[mpi]` extras flag.
+
+   * ``pip install -e .[mpi]`` (after cloning and moving to the repo root directory)
+
 To test
 your installation, cd to the directory where you installed mpi-sppy
 (it is called ``mpi-sppy``) and then give this command.

doc/src/quick_start.rst

@@ -1,13 +1,15 @@
 Quick Start
 ===========
 
-If you installed from github, run `setup.py` from the mpi-sppy directory.
+If you installed from github, install from source using pip in editable mode from the mpi-sppy repo root directory.
 
 ::
    
-   python setup.py develop
+   pip install -e .
 
 This step is not needed if you installed using pip.
+You can also include the extras flags ``mpi`` to install a compliant version
+of mpi4py or ``docs`` to install documentation dependencies from pip.
 
 
 Verify installation

examples/stoch_distr/globalmodel.py

@@ -14,7 +14,7 @@
 
 import pyomo.environ as pyo
 import stoch_distr
-import examples.distr.distr_data as distr_data
+import mpisppy.tests.examples.distr.distr_data as distr_data
 from mpisppy.utils import config
 
 def _parse_args():
@@ -98,4 +98,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()

examples/stoch_distr/stoch_distr.py

@@ -9,7 +9,7 @@
 # Network Flow - various formulations
 import pyomo.environ as pyo
 import mpisppy.utils.sputils as sputils
-import examples.distr.distr_data as distr_data
+import mpisppy.tests.examples.distr.distr_data as distr_data
 import numpy as np
 
 # In this file, we create a (linear) inter-region minimal cost distribution problem.
@@ -396,4 +396,4 @@ def inparser_adder(cfg):
     cfg.add_to_config("ensure_xhat_feas",
                       description="adds slacks with high costs to ensure the feasibility of xhat yet maintaining the optimal",
                       domain=bool,
-                      default=False)
+                      default=False)

examples/stoch_distr/stoch_distr_admm_cylinders.py

@@ -11,7 +11,7 @@
 # Driver file for stochastic admm
 import mpisppy.utils.stoch_admmWrapper as stoch_admmWrapper
 
-import examples.distr.distr_data as distr_data
+import mpisppy.tests.examples.distr.distr_data as distr_data
 import stoch_distr
 
 from mpisppy.spin_the_wheel import WheelSpinner

examples/stoch_distr/stoch_distr_ef.py

@@ -13,7 +13,7 @@
 # Solves the stochastic distribution problem 
 import stoch_distr
 import stoch_distr_admm_cylinders
-import examples.distr.distr_data as distr_data
+import mpisppy.tests.examples.distr.distr_data as distr_data
 import pyomo.environ as pyo
 
 import mpisppy.utils.sputils as sputils
@@ -93,4 +93,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()