Developer documentation

See solid_angle_correction.py for propely documented code

Package Build and Installation Instructions

Python wheel

$ python -m build --wheel --no-isolation
$ check-wheel-contents dist/drtsans-*.whl

Conda package

# create a conda package
$ cd conda.recipe
$ echo "versioningit $(versioningit ../)"
$ CHANNELS="--channel mantid/label/main --channel conda-forge"
$ VERSION=$(versioningit ../) conda mambabuild $CHANNELS --output-folder . .
$ conda verify noarch/drtsans-*.tar.bz2
# install a local conda package
$ conda install noarch/<drtsans .tar.bz2 file>

  • Note: For developers with a mamba installation (instead of conda), please replace conda mambabuild with mamba build

Creating Candidate and Production Releases

  • Follow the Software Maturity Model for continous versioning as well as creating release candidates and stable releases.

  • Update file release_notes.rst with major fixes, updates and additions since last stable release.

Standard variable names and what they denote

  • wavelength (was wl) - wavelength

  • sample_det_cent (was s2p) - sample to detector center distance

  • l1 - source to sample distance

  • need definitions of l2, r1, r2, dwl, … These should likely get different names with unambigious meanings

  • see e.g. solid_angle_correction.py for properly documented/named code

Random points about coding conventions

  • All code will follow the pep8 standard

  • Docstrings will use numpy formatting

  • Code that uses Mantid algorithms will have an addional “Mantid algorithms used” section with links using inter-sphinx

  • All internal functions should have an underbar, as is python standard

  • Need more comments in meat of code explaining intent. For example, more clearly named variables (or leave the variables the same but give them better documentation)

  • The development team still hasn’t decided a standard for how errors/exceptions are handled