Trusted, Bureaucrats
4,223
edits
Changes
Added an intro sentence, and increased the depth of the sectioning.
The following is information about the relax manual. == Find the manual = See =
The homepage manual
* html http://www.nmr-relax.com/manual/index.html
* pdf http://download.gna.org/relax/manual/relax.pdf
* Latest builded built manual http://download.gna.org/relax/manual == Get help ==The help section in relax is the best you can get ! Just start relax in terminal:<source lang="python">> relax # Then write, to see options which is related to relax_disp.relax> help(relax_disp) For example:help(relax_disp.select_model)# You can find more info at the wiki: http://wiki.nmr-relax.com/Category:Relaxation_dispersion# Here you can find link to the online HTML manual, and the API documentation. # You may want to read:relax> help(relax_disp.exp_type)relax> help(spectrum)relax> help(spectrum.replicated)relax> help(spectrum.baseplane_rmsd)relax> help(spectrometer) # This a very very fast an useful method to quickly understand the functions. # If you are unsure how to find where each method function is put, start the GUI.# In the top menu, go through the settings.# They are ordered the same way. ! :-) # For example.relax> help(grid_search)</source> == Write to the mail lists to get personal help ==See the wiki page [[Mailing_archives | Mailing archives]], to read how to sign up and write to the mail archives.
== Build the manual ===== Latex requirements ===The '''html.sty''' is needed from the latex package [http://www.ctan.org/pkg/latex2html latex2html] . A [http://miktex.org/ windows MiKTeX installation] should fetch it automatically. When compiling the pdf latex package manual, only '''html.sty''' is necessaryneeded. The easiest is just to placeYou can check if is already availablethat in your LaTeX installation. [http://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages See this guide].<source lang="bash">cd $HOME/Downloads ;wget http://mirrors.ctan.org/support/latex2html/latex2html-2012.tgz ;tar -xzf latex2html-2012.tgz ; kpsewhich rm latex2html-2012.tgz ;cd `where latex | xargs dirname`
cp -r /$HOME/Downloads/latex2html-2012/texinputs latex2html# Then update latex indextexhash</source>For a complete build of latex2html in linux, you could do something like this installation. But this is only for the building of '''user_manual_html'''. It is now advised to do this normally.
<source lang="bash">
sudo yum install latex2html
OR
cd $HOME/Downloads ;
wget http://www.latex2html.org/~latex2ht/current/latex2html-20082012.tar.gz ;tar -xzf latex2html-20082012.tar.gz ;rm latex2html-20082012.tar.gz ;cd latex2html-2008 2012 ;
mkdir build ;
./configure --help
./configure
#Or make a custom build
./configure --prefix=$PWD/build
make
</source>
=== Build pdf manual ===
The manual ends up in '''docs/relax.pdf'''
scons user_manual_pdf_nofetch
=== Build html manual ===
This needs quite some time to figure out to install and run latex2html.
scons user_manual_html_nofetch
== Build API (Application programming interface) documentation ==
The html documentation ends up in '''docs/api/'''
=== Epydoc python package installation ======= Windows epydoc ====
First: Download this packages, do not unpack them yet.
* epydoc http://www.lfd.uci.edu/~gohlke/pythonlibs/#epydoc
Open WinPython Control Panel, and drag the .exe into the window.
Install graphviz Windows binaries from http://www.graphviz.org.<br>Remember to add the binaries to your path.<source lang="powershell">set PATH=%PATH%;C:\Program Files (x86)\Graphviz2.32\bin</source>
==== Linux ====
sudo yum install epydoc
sudo yum install graphviz-python
=== Build API ===The API ends up in docs/api/index.html
You need to run 'scons clean' first to remove the *.pyc files and any other temporary files.
scons clean
scons api_manual_html
=== Regarding error messages ===
The "No documentation available!" errors are normal as these are for non-python files which are not part of relax. It's safe to ignore these.
Windows binaries are available though (http://www.graphviz.org).
== See also ==
[[Category:FAQ]]