Trusted, Bureaucrats
4,228
edits
Changes
Jump to navigation
Jump to search
→Package: lib: Added text to the relax library section.
== Package: lib ==
The plotting API is located in the [http://www.nmr-relax.com/api/3.3/lib.plotting-module.html lib.plotting relax library package]. The API is defined within the [http://www.nmr-relax.com/api/3.3/lib.plotting.api-module.html lib.plotting.api module]. This consists of a collection of plotting functions, each of which accepts the 'format' argument. The format argument is then used to determine which function in which module in lib.plotting will be called. For example see the [http://www.nmr-relax.com/api/3.3/lib.plotting.api-pysrc.html#correlation_matrix correlation_matrix() function].
To implement a new plotting feature for a certain software package, for example for Gnuplot, an equivalent function should be provided in the [http://www.nmr-relax.com/api/3.3/lib.plotting.gnuplot-module.html lib.plotting.gnuplot module]. This should have the same name as the API function and accept exactly the same arguments, excluding the format argument.
