Merge pull request #497 from ax3l/setup.py-install-variants

setup.py/PyPI: Environment Variant Control

Author: ax3l

CHANGELOG.rst

@@ -42,7 +42,7 @@ Other
 - NLohmann-JSON: updated to 3.5.0+ #467
 - Docs:
 
-  - PyPI install method #450 #451
+  - PyPI install method #450 #451 #497
   - more info on MPI #449
   - new "first steps" section #473 #478
   - update invasive test info #474

README.md

@@ -120,12 +120,15 @@ Optional language bindings:
 
 [![Spack Package](https://img.shields.io/badge/spack.io-openpmd--api-brightgreen.svg)](https://spack.io)
 [![Conda Package](https://img.shields.io/badge/conda.io-openpmd--api-brightgreen.svg)](https://anaconda.org/conda-forge/openpmd-api)
-[![PyPI Package](https://img.shields.io/badge/pypi.org-openPMD--api-yellow.svg)](https://pypi.org/project/openPMD-api)
+[![PyPI Package](https://img.shields.io/badge/pypi.org-openpmd--api-yellow.svg)](https://pypi.org/project/openPMD-api)
+[![From Source](https://img.shields.io/badge/from_source-CMake-brightgreen.svg)](https://cmake.org)
 
 Choose *one* of the install methods below to get started:
 
 ### [Spack](https://spack.io)
 
+[![Spack Status](https://img.shields.io/badge/method-recommended-brightgreen.svg)](https://spack.io)
+
 ```bash
 # optional:               +python +adios1 -mpi
 spack install openpmd-api
@@ -135,6 +138,7 @@ spack load -r openpmd-api
 ### [Conda](https://conda.io)
 
 [![Conda Version](https://img.shields.io/conda/vn/conda-forge/openpmd-api.svg)](https://anaconda.org/conda-forge/openpmd-api)
+[![Conda Status](https://img.shields.io/badge/method-recommended-brightgreen.svg)](https://anaconda.org/conda-forge/openpmd-api)
 [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/openpmd-api.svg)](https://anaconda.org/conda-forge/openpmd-api)
 
 ```bash
@@ -146,16 +150,28 @@ conda install -c conda-forge openpmd-api
 
 [![PyPI Version](https://img.shields.io/pypi/v/openPMD-api.svg)](https://pypi.org/project/openPMD-api)
 [![PyPI Format](https://img.shields.io/pypi/format/openPMD-api.svg)](https://pypi.org/project/openPMD-api)
-[![PyPI Status](https://img.shields.io/badge/status-experimental-yellow.svg)](https://pypi.org/project/openPMD-api)
+[![PyPI Status](https://img.shields.io/badge/method-experimental-yellow.svg)](https://pypi.org/project/openPMD-api)
 [![PyPI Downloads](https://img.shields.io/pypi/dm/openPMD-api.svg)](https://pypi.org/project/openPMD-api)
 
+Behind the scenes, this install method *compiles from source* against the found installations of HDF5, ADIOS and/or MPI (in system paths, from other package managers, or loaded via a module system, ...).
+The current status for this install method is *experimental*.
+Please feel free to [report](https://github.com/openPMD/openPMD-api/issues/new/choose) how this works for you.
+
+```bash
+# optional:             --user
+pip install openpmd-api
+```
+
+or with MPI support:
 ```bash
-# optional:            [mpi] --user
-pip install openPMD-api
+# optional:                                --user
+openPMD_USE_MPI=ON pip install openpmd-api
 ```
 
 ### From Source
 
+[![Source Status](https://img.shields.io/badge/method-advanced-brightgreen.svg)](https://cmake.org)
+
 openPMD can then be installed using [CMake](https://cmake.org/):
 
 ```bash

docs/source/install/install.rst

@@ -67,8 +67,15 @@ Please feel free to `report <https://github.com/openPMD/openPMD-api/issues/new/c
 
 .. code-block:: bash
 
-   # optional:            [mpi] --user
-   pip install openPMD-api
+   # optional:             --user
+   pip install openpmd-api
+
+or with MPI support:
+
+.. code-block:: bash
+
+   # optional:                                --user
+   openPMD_USE_MPI=ON pip install openpmd-api
 
 .. _install-cmake:
 

setup.py

@@ -47,6 +47,8 @@ def build_extension(self, ext):
             '-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=' + extdir,
             '-DCMAKE_PYTHON_OUTPUT_DIRECTORY=' + extdir,
             '-DPYTHON_EXECUTABLE=' + sys.executable,
+            # variants
+            '-DopenPMD_USE_MPI:BOOL=' + openPMD_USE_MPI,
             # skip building tests & examples
             '-DBUILD_TESTING:BOOL=OFF',
             '-DBUILD_EXAMPLES:BOOL=OFF',
@@ -95,9 +97,22 @@ def build_extension(self, ext):
 with open('./README.md', encoding='utf-8') as f:
     long_description = f.read()
 
+# Allow to control options via environment vars.
+# Work-around for https://github.com/pypa/setuptools/issues/1712
+# note: changed default for MPI
+openPMD_USE_MPI = os.environ.get('openPMD_USE_MPI', 'OFF')
+
+# https://cmake.org/cmake/help/v3.0/command/if.html
+if openPMD_USE_MPI.upper() in ['1', 'ON', 'YES', 'TRUE', 'YES']:
+    openPMD_USE_MPI = "ON"
+else:
+    openPMD_USE_MPI = "OFF"
+
 # Get the package requirements from the requirements.txt file
 with open('./requirements.txt') as f:
     install_requires = [line.strip('\n') for line in f.readlines()]
+    if openPMD_USE_MPI == "ON":
+        install_requires.append('mpi4py>=2.1.0')
 
 # keyword reference:
 #   https://packaging.python.org/guides/distributing-packages-using-setuptools
@@ -128,9 +143,13 @@ def build_extension(self, ext):
     python_requires='>=3.5, <3.8',
     # tests_require=['pytest'],
     install_requires=install_requires,
-    extras_require={
-        'mpi': ['mpi4py'],
-    },
+    # we would like to use this mechanism, but pip / setuptools do not
+    # influence the build and build_ext with it.
+    # therefore, we use environment vars to control.
+    # ref: https://github.com/pypa/setuptools/issues/1712
+    # extras_require={
+    #     'mpi': ['mpi4py>=2.1.0'],
+    # },
     # cmdclass={'test': PyTest},
     # platforms='any',
     classifiers=[