python-control · roryyorke · Feb 21, 2021 · Feb 7, 2021 · Feb 7, 2021 · Feb 7, 2021
diff --git a/.github/workflows/slycot-build-and-test.yml b/.github/workflows/slycot-build-and-test.yml
@@ -14,22 +14,31 @@ jobs:
 
   build-setup:
     # Super fast sniff build. If this fails, don't start the other jobs
-    name: Build setup.py on Ubuntu
+    name: Build sdist on Ubuntu
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Slycot
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
+          submodules: 'recursive'
       - name: Set up Python
         uses: actions/setup-python@v2
       - name: Setup Ubuntu
         run: |
           sudo apt-get -y install gfortran cmake --fix-missing
           sudo apt-get -y install libblas-dev liblapack-dev
           pip install scikit-build numpy scipy pytest
-      - name: Install Slycot
-        run: python setup.py install
+      - name: Create Slycot sdist
+        run: python setup.py sdist
+
+      - name: Install Slycot sdist
+        run: |
+          mkdir cleancwd
+          cd cleancwd
+          tar xfz ../dist/slycot-*.tar.gz
+          cd slycot-*
+          python setup.py install
       - name: Run tests
         run: pytest
 
@@ -71,6 +80,7 @@ jobs:
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
+          submodules: 'recursive'
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
@@ -139,6 +149,7 @@ jobs:
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
+          submodules: 'recursive'
       - name: Setup Conda
         uses: conda-incubator/setup-miniconda@v2
         with:

diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "slycot/src/SLICOT-Reference"]
+	path = slycot/src/SLICOT-Reference
+	url = https://github.com/python-control/SLICOT-Reference
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -12,4 +12,4 @@ include slycot/*.py
 include slycot/version.py.in
 include slycot/src/*.f
 include slycot/tests/*.py
-
+graft slycot/src/SLICOT-Reference
diff --git a/README.rst b/README.rst
@@ -65,6 +65,7 @@ from the conda-forge channel with the following command::
 
     conda install -c conda-forge slycot
 
+
 Compiling from source
 ---------------------
 
@@ -77,12 +78,53 @@ the correct header files are installed, and specify the environment variable
 
 .. _BLA_VENDOR: https://cmake.org/cmake/help/latest/module/FindBLAS.html#input-variables
 
+Getting the full source code
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-From source without conda (Linux, macOS, Windows)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Get it from PyPI
+^^^^^^^^^^^^^^^^
+
+Get the source code of the latest release is available from `PyPI`_. It
+contains both the Python to Fortran wrappers as well as the SLICOT-Reference
+Fortran sources.
+
+.. _PyPI: https://pypi.org/project/slycot
+
+Get it from GitHub archives
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you decide to download a source code archive from GitHub (tagged release or
+a specific branch), you also have to get the correct version of our
+SLICOT-Reference fork and place it into ``slycot/src/SLICOT-Reference``:
+
+1. Download and unpack https://github.com/python-control/Slycot/archive/master.zip
+2. Go to https://github.com/python-control/Slycot/master/slycot/src
+3. Follow the link of ``SLICOT-Reference @ <commit-id>``
+4. Download the archive of SLICOT-Reference from the Code download button
+   (``https://github.com/python-control/SLICOT-Reference/archive/<commit-id>.zip``)
+5. Unpack the contents of the SLICOT-Reference archive into
+   ``slycot/src/SLICOT-Reference``
+
+Replace ``master`` with the release tag or branch name, which you want to build.
+
+Clone the git repository
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Directly checkout the submodule, when cloning the git repository::
 
-Unpack the source code (or clone the git repository) to a directory of your choice,
-e.g. ``/path/to/slycot_src/``
+    git clone --recurse-submodules https://github.com/python-control/Slycot.git
+
+or if you forked the repository::
+
+    git clone --recurse-submodules https://github.com/<your-username>/Slycot.git
+
+If you already have a local checkout, but still need to init the submodule::
+
+    git submodule init
+    git submodule update
+
+Compiling with setuptools (Linux, macOS, Windows)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you need to specify a specific compiler, set the environment variable FC
 before running the install::
@@ -98,8 +140,8 @@ To build and install, execute::
     cd /path/to/slycot_src/
     python setup.py install
 
-From source using the conda recipe
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Using the conda recipe
+~~~~~~~~~~~~~~~~~~~~~~
 
 You can use conda to compile and install Slycot from source. The recipe is
 located in the folder ``conda-recipe`` and is intended to work for all
@@ -127,8 +169,8 @@ To build and install::
     conda build -c conda-forge conda-recipe
     conda install -c conda-forge --use-local slycot
 
-From source in a conda environment (Windows)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+With setuptools in a conda environment (Windows)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 A similar method can be used for Linux and macOS, but is detailed here
 for Windows.  This method uses conda and conda-forge to get most build
@@ -164,8 +206,6 @@ will download the latest release of the source code from `PyPI`_, compile, and
 install Slycot into the currently configured location (virtual environment or
 user site-packages).
 
-.. _PyPI: https://pypi.org/project/slycot
-
 Additional hints
 ~~~~~~~~~~~~~~~~
 
@@ -194,3 +234,12 @@ Importing ``slycot`` or running ``pytest`` without ``--pyargs slycot`` from
 inside the source directory will fail, unless the compiled wrapper library has
 been installed into that directory. Note that the ``[tool:pytest]`` section
 in ``setup.cfg`` enforces the ``--pyargs slycot`` argument by default.
+
+License
+-------
+Up until version 0.4, Slycot used a version of SLICOT that was released under
+the GPLv2 license. This requires Slycot to be released under the same license. In
+December 2020, SLICOT 5.7 was released under BSD-3-Clause. However, as the
+existing Slycot wrappers have been submitted by many contributors, we cannot
+move away from GPLv2 unless we get the permission to do so by all authors.
+Thus, Slycot remains licensed under GPLv2 until further notice.
diff --git a/setup.py b/setup.py
@@ -187,7 +187,33 @@ def get_version_info(srcdir=None):
 
     return FULLVERSION, GIT_REVISION
 
-
+def check_submodules():
+    """ verify that the submodules are checked out and clean
+        use `git submodule update --init`; on failure
+    """
+    if not os.path.exists('.git'):
+        return
+    with open('.gitmodules') as f:
+        for l in f:
+            if 'path' in l:
+                p = l.split('=')[-1].strip()
+                if not os.path.exists(p):
+                    raise ValueError('Submodule %s missing' % p)
+
+    proc = subprocess.Popen(['git', 'submodule', 'status'],
+                            stdout=subprocess.PIPE)
+    status, _ = proc.communicate()
+    status = status.decode("ascii", "replace")
+    for line in status.splitlines():
+        if line.startswith('-') or line.startswith('+'):
+            raise ValueError('Submodule not clean: %s' % line)
+
+
+class sdist_checked(sdist):
+    """ check submodules on sdist to prevent incomplete tarballs """
+    def run(self):
+        check_submodules()
+        sdist.run(self)
 
 def setup_package():
     src_path = os.path.dirname(os.path.abspath(__file__))
@@ -210,6 +236,7 @@ def setup_package():
         license='GPL-2.0',
         classifiers=[_f for _f in CLASSIFIERS.split('\n') if _f],
         platforms=["Windows", "Linux", "Solaris", "Mac OS-X", "Unix"],
+        cmdclass={"sdist": sdist_checked},
         cmake_args=['-DSLYCOT_VERSION:STRING=' + VERSION,
                     '-DGIT_REVISION:STRING=' + gitrevision,
                     '-DISRELEASE:STRING=' + str(ISRELEASED),