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: Sun Aug 22 10:26:59 2021 UTC

                 OS : Linux
             CPU(s) : 2
            Machine : x86_64
       Architecture : 64bit
        Environment : IPython

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

             sphinx : 4.1.2
           numpydoc : 1.1.0
          ipykernel : 6.2.0
      sphinx_numfig : 0.1.0
      sphinx_panels : 0.6.0
  sphinx_automodapi : 0.13
pydata_sphinx_theme : 0.6.3
              numpy : 1.20.3
              scipy : 1.7.1
              numba : 0.54.0
              emg3d : 1.2.1
            empymod : 2.1.2
             xarray : 0.19.0
         discretize : 0.7.0
               h5py : 3.3.0
         matplotlib : 3.4.3
               tqdm : 4.62.1
            IPython : 7.26.0
--------------------------------------------------------------------------------