Maintenance#

Status reports and other tools to have the checks all in one place, for quick QC.

Quick overview / QC#

All possible badges of the CI chain. Definitely check this before making a release.

  • GitHub Actions linux GitHub Actions macos & windows GitHub Actions linkcheck Documentation Status

    Ensure CI and docs are passing.

  • PyPI conda-forge

    Ensure latest version is deployed on PyPI and conda.

  • Coveralls Codacy

    Check CI coverage and code quality is good.

  • Airspeed Velocity

    Check Benchmarks are run up to the latest version.

  • Zenodo DOI

    Check Zenodo is linking to the latest release.

Info from ReadTheDocs#

To check the environment in which the documentation was built.

In [1]: import emg3d
   ...: emg3d.Report(
   ...:     ['sphinx', 'numpydoc', 'ipykernel', 'sphinx_numfig',
   ...:      'sphinx_panels', 'sphinx_automodapi', 'pydata_sphinx_theme']
   ...: )
   ...: 
Out[1]: 

--------------------------------------------------------------------------------
  Date: Wed Aug 31 15:35:42 2022 UTC

                 OS : Linux
             CPU(s) : 2
            Machine : x86_64
       Architecture : 64bit
                RAM : 7.6 GiB
        Environment : IPython
        File system : ext4

  Python 3.8.6 (default, Oct 19 2020, 15:10:29)  [GCC 7.5.0]

             sphinx : 4.5.0
           numpydoc : 1.4.0
          ipykernel : 6.15.2
      sphinx_numfig : 0.1.0
      sphinx_panels : 0.6.0
  sphinx_automodapi : 0.14.dev0
pydata_sphinx_theme : 0.10.1
              numpy : 1.22.4
              scipy : 1.9.1
              numba : 0.56.0
              emg3d : 1.8.0
            empymod : 2.2.0
             xarray : 2022.6.0
         discretize : 0.8.2
               h5py : 3.7.0
         matplotlib : 3.5.3
               tqdm : 4.64.0
            IPython : 8.4.0
--------------------------------------------------------------------------------