Skip to content

Building the distribution

Pete R Jemian edited this page Aug 21, 2017 · 4 revisions

Building

To build the documentation, several software packages must be available on your system. The requirements are pretty much the same for Linux, Macintosh, and Windows

  • command line
  • GNU make
  • Python (>=2.7)
    • Sphinx
  • xsltproc
  • a working LaTeX installation

Requirements

The definitions repository provides:

  • NeXus NXDL specifications for:
    • base classes
    • application definitions
    • contributed definitions
  • source files for NeXus User Guide
  • build scripts for the HTML and PDF documentation

It is not necessary to build the NXDL files. The NXDL files contain specifications as well as documentation that appears in the User Guide.

Software that may use the NXDL files directly includes:

  • NeXus HDF5 data file validation software
  • NeXus HDF5 data file writing/editing software