In-source builds are blocked so compilation needs to be done in a separate build directory. I prefer entirely separate from the source so that is what these commands do. Assuming we are currently in the root of the project, the following will build the executable.
cd ../ && mkdir build && cd build
cmake ../inch
makeOr, to be build tool agnostic, again from the source root
cmake -H. -B../build
cmake --build ../buildThis will create a bin/ directory (inside the build directory) and place the executable inside.
The option CMAKE_INSTALL_PREFIX can be passed to cmake to specify the install location if required.
As part of the build, the binary is coded to read files located in /your/build/path/inch/data_files/. Thus the executable can be copied into one of your $PATH directories and it will still be able to find the necessary files.
There are a scripts provided with the project that are designed to aid with conversion from the currently output file format to one which may be easier to use in presentations or documents, and enable some basic end-to-end testing of functionality.
All but one of the scripts are written in both BASH and Python. Functionality should be identical between the two so use which ever you prefer.
The scripts convert_chart.sh and convertChart.py convert the output file from one format to another. The implemented conversions are listed in the table below, running with no arguments will print usage instructions to remind you of the allowed conversions
| From | To | Package utilised |
|---|---|---|
| eps | png, jpg, pdf | ghostscript |
| svg | librsvg2 |
The scripts random_chart.sh and randomChart.py will run the code using a random Z range, choice of experimental or theoretical isotopes and property to colour by. Currently the full neutron range is always used.
The script assumes you are in the same location from which you built the executable so will look for the binary in paths relative to that.
If this is not the case, you can pass the correct path with the -e flag.
By default, a single chart is created, but if required, the number of charts to create, each with their own options, can be set with the -n flag.
The scripts validate_epsfile.sh and validateEPSfile.py silently passes the provided file through ghostscript to check for postscript syntax errors. The error message is not currently displayed, or saved, but rather a simple PASS/FAIL string is printed along with the filename being read at the time. Files will need to be processed individually to run further debugging.
One or more argument is required so wildcards can be used to pass multiple files.