mfem · sshiraiwa · Sep 18, 2025 · Sep 18, 2025 · Sep 18, 2025 · Sep 18, 2025
diff --git a/INSTALL.md b/INSTALL.md
@@ -2,24 +2,23 @@
 
 ## Basic serial install
 
-Most users (on Linux and Mac) will be fine using the binary bundled in the default `pip` install:
+For serial version, most users (on Linux and Mac) will be fine using the binary bundled in the default `pip` install:
 
 ```shell
 pip install mfem
 ```
 The above installation will download and install a *serial* version of `MFEM`.
 
-##  Environmental variables
-Build script checks the following environmental variables
-- CC : c compiler for parallel build
-- CXX : c++ compiler for serial build
-- MPICC : c compiler for parallel build
-- MPICXX : c++ compiler for parallel build
-- CXX11FLAG : C++11 flag for C++ compiler
-- MPIINC : the location of MPI.h (if this variable is set, the parallle PyMFEM is build with CXX, not MPICXX)
-
 
 ##  Building from source
+To build it from source, clone the repository and use pip command
+
+```shell
+git clone git@github:mfem/PyMFEM.git
+cd PyMFEM
+pip install . --user
+```
+
 PyMFEM has many options for installation, when building from source, including:
  - Serial and parallel (MPI) wrappers
  - Using pre-built local dependencies
@@ -28,32 +27,28 @@ PyMFEM has many options for installation, when building from source, including:
    - `gslib`
    - `libceed`
    - `metis`
-
-Most of the options for PyMFEM can be used directly when installing via `pip install . or python setup.py install`, e.g.
-```shell
-git clone git@github:mfem/PyMFEM.git
-cd PyMFEM
-pip install . --user
-
-or
-
-python setup.py install --user
-```
+
+Build script checks the following environmental variables
+  - CC : c compiler for parallel build
+  - CXX : c++ compiler for serial build
+  - MPICC : c compiler for parallel build
+  - MPICXX : c++ compiler for parallel build
+  - CXX11FLAG : C++11 flag for C++ compiler
+  - MPIINC : the location of MPI.h (if this variable is set, the parallle PyMFEM is build with CXX, not MPICXX)
 
 Note that `python setup.py install` is deprecated and will be removed soon in favor of `pip`.
 When installing via `pip`, options are specified using the `-C` flag using the syntax `-C"name=value"`; e.g. the `--with-parallel` option is now specified as `-C"with-parallel=Yes`.
 The name and value of each option should be written explicitly with a dedicated -C flag.
 
 For example, parallel (MPI) support and GSlib support is built with  `--with-parallel`
-and `--with-gslib' flags as follows.
+and `--with-gslib` flags as follows.
 
 ```shell
-python setup.py install --with-parallel --with-gslib
-or
 pip install . -C"with-parallel=Yes" -C"with-gslib=Yes"
 ```
 
-Note: this option turns on building `metis` and `Hypre`
+(Warning) The migration to `pip install . ` is on-going effort and Some of the example commands are not tested yet, which are indicated by using old conversion of "python setup.py install XXXX"
+
 
 ## Commonly used flags
 
@@ -63,12 +58,6 @@ Note: this option turns on building `metis` and `Hypre`
 | `--mfem-branch=<reference>` | Download/install MFEM using a specific reference (`git` `branch`, `hash`, or `tag`) |
 | `--user` | Install in user's site-package |
 
-In order to see the full list of options, use
-
-```shell
-python setup.py install --help
-```
-
 ## Advanced options
 
 ### Suitesparse

diff --git a/README.md b/README.md
@@ -18,24 +18,25 @@ pip install mfem            # binary install is available only on linux platform
 
 ### Build with additional features (MPI, GPU, GPU-Hypre, GSLIB, SuiteSparse, libCEED, LAPACK)
 
-The setup script accept various options. Download the package manually and run the script. Examples below downloads and build parallel version of MFEM library (linked with Metis and Hypre) and installs under <prefix>/mfem. See INSTALL.md for various other options
+The setup script accept various options. Download the package manually and run the script. Examples below downloads and build parallel version of MFEM library (linked with Metis and Hypre) and installs under <prefix>/mfem. See [INSTALL](INSTALL.md) for various other options
 
+#### Download source and build
 ```shell
-# Download source and build
 $ git clone https://github.com/mfem/PyMFEM.git
 
 # Build it from local source with MPI
 $ pip install ./ -C"with-parallel=Yes" --verbose
+```
 
-
-# Cleaning
+#### Cleaning
+```shell
 $ python setup.py clean --all # clean external dependencies + wrapper code
-
-# Run test
+```
+#### Run test
+```shell
 cd test
 python test_examples.py -serial
-
-# For other configurations, see INSTALL.md
+```
 
 ## Usage
 This example (modified from `ex1.cpp`) solves the Poisson equation,
@@ -118,7 +119,9 @@ plt.show()
 
 
 ## License
-PyMFEM is licensed under BSD-3.
+PyMFEM is licensed under BSD-3 license. All new contributions
+must be made under this license. See [License](LICENSE) for details.
+
 Please refer the developers' web sites for the external libraries
 * MFEM: https://mfem.org/
 * Hypre: https://computing.llnl.gov/projects/hypre-scalable-linear-solvers-multigrid-methods

diff --git a/docs/development_memo.txt b/docs/development_memo.txt
@@ -12,22 +12,25 @@ $ twine check dist/*        # check syntax
 $ python3 -m twine upload --repository testpypi dist/*    # upload at testpypi
 $ python3 -m twine upload dist/*                          # uploade to the official
 
-### building step-by-step
-pip download -i  https://test.pypi.org/simple/ mfem
-python3 setup.py install --prefix=~/sandbox --verbose --with-parallel
-
-### test inside virtualenv
-virtualenv env
-source env/bin/activate
+### check test PyPI distribution
+pip3 install -i  https://test.pypi.org/simple  mfem==4.8.0rc10  -verbose
 
-### test verious pip combinations
-pip3 install -i  https://test.pypi.org/simple  mfem --no-binary mfem --verbose
-pip3 install -i  https://test.pypi.org/simple  mfem --no-binary mfem --verbose --prefix=~/sandbox
 
-virtualenv env
-source env/bin/activate
-pip3 install -i  https://test.pypi.org/simple  mfem --no-binary mfem --verbose
+### building step-by-step
+git clone https://github.com/mfem/PyMFEM.git
+cd PyMFEM
 
+1)  build external libraries
+pip install . -C"ext-only=Yes" --verbose
+pip install . -C"with-parallel=Yes" -C"ext-only=Yes" --verbose
+
+2) generate wrapper codes
+pip install . -C"skip-ext=Yes"  -C"swig=Yes" --verbose
+pip install . -C"with-parallel=Yes" -C"skip-ext=Yes"  -C"swig=Yes" --verbose
+
+3) compile wrapper
+pip install . -C"skip-ext=Yes"  -C"skip-swig=Yes" --verbose
+pip install . -C"with-parallel=Yes" -C"skip-ext=Yes"  -C"skip-swig=Yes" --verbose
 
 ### Test linux binary build locally using docker (1) for Python <= 3.9
 

diff --git a/mfem/__init__.py b/mfem/__init__.py
@@ -20,5 +20,5 @@ def debug_print(message):
 
     print(message)
 
-__version__ = '4.8.0rc10'
+__version__ = '4.8.0'
 
diff --git a/mfem/_par/array.i b/mfem/_par/array.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") array
 %feature("autodoc", "1");
 

diff --git a/mfem/_par/arrays_by_name.i b/mfem/_par/arrays_by_name.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") arrays_by_name
 %{
 #include "mfem.hpp"

diff --git a/mfem/_par/attribute_sets.i b/mfem/_par/attribute_sets.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") attribute_sets
 %{
 #include "mfem.hpp"

diff --git a/mfem/_par/auxiliary.i b/mfem/_par/auxiliary.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module (package="mfem._par") auxiliary
 
 %{

diff --git a/mfem/_par/bilinearform.i b/mfem/_par/bilinearform.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par", directors="1")  bilinearform
 %{
 #include "fem/bilinearform.hpp"

diff --git a/mfem/_par/bilininteg.i b/mfem/_par/bilininteg.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par", directors="1")  bilininteg
 %{
 #include "mfem.hpp"

diff --git a/mfem/_par/blockmatrix.i b/mfem/_par/blockmatrix.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") blockmatrix
 
 %{

diff --git a/mfem/_par/blockoperator.i b/mfem/_par/blockoperator.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") blockoperator
 
 %{

diff --git a/mfem/_par/blockvector.i b/mfem/_par/blockvector.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") blockvector
 
 %{

diff --git a/mfem/_par/bounds.i b/mfem/_par/bounds.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") bounds
 
 %{

diff --git a/mfem/_par/coefficient.i b/mfem/_par/coefficient.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 /*
    coefficient.i
    SWIG interface file for coefficient.hpp

diff --git a/mfem/_par/common_functions.i b/mfem/_par/common_functions.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") common_functions
 
 %{

diff --git a/mfem/_par/communication.i b/mfem/_par/communication.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") communication
 %feature("autodoc", "1");
 

diff --git a/mfem/_par/complex_fem.i b/mfem/_par/complex_fem.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 /*
 
    complex_fem.i

diff --git a/mfem/_par/complex_operator.i b/mfem/_par/complex_operator.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 /*
 
    complex_operator.i

diff --git a/mfem/_par/constraints.i b/mfem/_par/constraints.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 /*
 
    constraints.i

diff --git a/mfem/_par/cpointers.i b/mfem/_par/cpointers.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") cpointers
 
 %include "../common/cpointers.i"
diff --git a/mfem/_par/datacollection.i b/mfem/_par/datacollection.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") datacollection
 %{
 #include "mfem.hpp"

diff --git a/mfem/_par/densemat.i b/mfem/_par/densemat.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 /*
 
    densemat.i

diff --git a/mfem/_par/device.i b/mfem/_par/device.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") device
 %{
 #include  "mfem.hpp"

diff --git a/mfem/_par/dist_solver.i b/mfem/_par/dist_solver.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") dist_solver
 %{
 #include "mfem.hpp"

diff --git a/mfem/_par/doftrans.i b/mfem/_par/doftrans.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") doftrans
 %{
 #include "mfem.hpp"

diff --git a/mfem/_par/element.i b/mfem/_par/element.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") element
 
 %{

diff --git a/mfem/_par/eltrans.i b/mfem/_par/eltrans.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module (package="mfem._par") eltrans
 
 %{

diff --git a/mfem/_par/enzyme.i b/mfem/_par/enzyme.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") enzyme
 %{
 #include "mfem.hpp"

diff --git a/mfem/_par/error.i b/mfem/_par/error.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") error
 %{
 #include <exception>

diff --git a/mfem/_par/estimators.i b/mfem/_par/estimators.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") estimators
 %{
 #include "mfem.hpp"

diff --git a/mfem/_par/fe.i b/mfem/_par/fe.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module (package="mfem._par") fe
 
 %{

diff --git a/mfem/_par/fe_base.i b/mfem/_par/fe_base.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") fe_base
 %{
 #include  "mfem.hpp"

diff --git a/mfem/_par/fe_coll.i b/mfem/_par/fe_coll.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") fe_coll
 %{
 #include <iostream>

diff --git a/mfem/_par/fe_fixed_order.i b/mfem/_par/fe_fixed_order.i
@@ -1,3 +1,6 @@
+//
+// Copyright (c) 2020-2025, Princeton Plasma Physics Laboratory, All rights reserved.
+//
 %module(package="mfem._par") fe_fixed_order
 %{
 #include  "mfem.hpp"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -20,5 +20,5 @@ def debug_print(message):

		print(message)

		__version__ = '4.8.0rc10'
		__version__ = '4.8.0'