diff --git a/doc/Makefile b/doc/Makefile index 4cff63ace2eaee70fe3161fc265fa3aae65e6398..baf08404bd8a61de9bae48a40e716d49deb05093 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -11,7 +11,7 @@ gstlal-calibration-modules : # sphinx-apidoc -o source/gstlal-burst/python-modules ../gstlal-burst/python gstlal-ugly-modules : - sphinx-apidoc -o source/gstlal-ugly/python-modules ../gstlal-ugly/python ../gstlal-ugly/python/gviz_api.py ../gstlal-ugly/python/coherent_inspiral_metric.py ../gstlal-ugly/python/coherent_inspiral_metric_plots.py ../gstlal-ugly/python/coherent_inspiral_metric_detector_details.py ../gstlal-ugly/python/sngltriggertable.py + sphinx-apidoc -o source/gstlal-ugly/python-modules ../gstlal-ugly/python ../gstlal-ugly/python/gviz_api.py ../gstlal-ugly/python/coherent_inspiral_metric.py ../gstlal-ugly/python/coherent_inspiral_metric_plots.py ../gstlal-ugly/python/coherent_inspiral_metric_detector_details.py ../gstlal-ugly/python/sngltriggertable.py ../gstlal-ugly/python/aggregator.py gstlal-bin : ./sphinx-bindoc source/gstlal/bin ../gstlal/bin gstlal_ligo_data_find_check diff --git a/doc/source/getting-started.rst b/doc/source/getting-started.rst index 106ef8e9bce663d23cc86fe62aaaab608d8aa751..b5607d8a74e821e3e949e1f0d2f3fab1c1c47ee9 100644 --- a/doc/source/getting-started.rst +++ b/doc/source/getting-started.rst @@ -1,4 +1,33 @@ Getting started =============== -FIXME +You can get a development copy of the gstlal software suite from git. Doing this at minimum will require a development copy of lalsuite. + * https://git.ligo.org/lscsoft/gstlal + * https://git.ligo.org/lscsoft/lalsuite + +Source tarballs are available here: http://software.ligo.org/lscsoft/source/ + +Limited inary packages are available here: + +Building and installing from source follows the normal GNU build procedures +involving: + + 1. ./00init.sh + 2. ./configure + 3. make + 4. make install. + +You should build the packages in order of gstlal, gstlal-ugly, +gstlal-calibration, gstlal-inspiral. If you are building to a non FHS place +(e.g., your home directory) you will need to ensure some environment variables +are set so that your installation will function. The following five variables +must be set. As **just an example**:: + + GI_TYPELIB_PATH="/path/to/your/installation/lib/girepository-1.0:${GI_TYPELIB_PATH}" + GST_PLUGIN_PATH="/path/to/your/installation/lib/gstreamer-0.10:${GST_PLUGIN_PATH}" + PATH="/path/to/your/installation/bin:${PATH}" + # Debian systems need lib, RH systems need lib64, including both doesn't hurt + PKG_CONFIG_PATH="/path/to/your/installation/lib/pkgconfig:/path/to/your/installation/lib64/pkgconfig:${PKG_CONFIG_PATH}" + # Debian systems need lib, RH systems need lib and lib64 + PYTHONPATH="/path/to/your/installation/lib64/python2.7/site-packages:/path/to/your/installation/lib/python2.7/site-packages:$PYTHONPATH" + diff --git a/doc/source/index.rst b/doc/source/index.rst index 47d58c6fd0bbd78ffac9d3aaa000799100ed4f1b..2a34be89fbde47d59a47de72c321bebb852a45b5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,8 +13,4 @@ The GstLAL project documentation overview getting-started projects - - -+-----------------+-----------------+---------------+ -| :ref:`genindex` | :ref:`modindex` | :ref:`search` | -+-----------------+-----------------+---------------+ + publications