Skip to content

Commit 0331e53

Browse files
committed
some tweaks to online docs
1 parent 643311b commit 0331e53

File tree

1 file changed

+19
-66
lines changed

1 file changed

+19
-66
lines changed

loos.dox

Lines changed: 19 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -3097,72 +3097,25 @@ namespace loos {
30973097
\subsection faq_loos_building Building LOOS (and building with LOOS)
30983098
<DL>
30993099

3100-
3101-
<DT> SCons is not finding the right compiler/swig/doxygen
3102-
<DD> For LOOS, SCons will use your shell's $PATH veriable to look
3103-
for tools. You will need to make sure the missing tool is in your
3104-
path. Some care may be necessary in the order directories appear
3105-
in your path to make sure you are finding the intended version of
3106-
the tool. You can explicitly specify a C++ compiler to use
3107-
with the CXX variable (either in your environment or from a
3108-
custom.py file). This will take precedence over your path.
3109-
3110-
<DT> SCons is not finding my installation of Boost.
3111-
<DD> If you need to point SCons to a non-standard location of Boost,
3112-
use the BOOST variable on the command-line or within your custom.py
3113-
file. If you need to override either the include directory or the
3114-
library directory, use the BOOST_INCLUDE and BOOST_LIBPATH variables
3115-
respectively.
3116-
3117-
<DT> SCons cannot find a Boost library.
3118-
<DD> SCons will try to determine the correct naming variant for your
3119-
Boost install. It will start by looking for "libboost_foo-mt.suff",
3120-
followed by "libboost_foo.suff" where suff is either "dylib"
3121-
(MacOS/Darwin), "so" (Linux), and "dll.a" (Cygwin). Failing that, it
3122-
will look for any file matching "libboost_foo-*-mt.suff" followed by
3123-
the non-threaded version. Of the list of filenames found, SCons will
3124-
take the shortest one.<p>
3125-
If necessary, override the libraries linked to for Boost by setting
3126-
the BOOST_LIBS variable to a space-separated list of libraries. Note
3127-
that you will need to include all of the ones required by LOOS, at a
3128-
minimum,
3129-
\verbatim
3130-
BOOST_LIBS="boost_regex boost_program_options boost_system boost_thread"
3131-
\endverbatim
3132-
Note that the libraries will be linked in with the same order they
3133-
appear in the BOOST_LIBS variable.
3134-
3135-
<DT> I'm getting undefined reference or other link errors that appear
3136-
to be related to Boost
3137-
<DD> This can happen if you have multiple versions of Boost
3138-
installed. SCons may use include files from one version, but link
3139-
with the libraries from another. Check the path to BOOST and the
3140-
name of the libraries linked against.
3141-
3142-
<DT> I get a build error that says expected threaded libraries or
3143-
non-threaded libraries, but some library is the opposite?
3144-
<DD> This is probably a failure of SCons to figure out the appropriate
3145-
library name. Use the BOOST_LIBS variable (described above) to
3146-
manually set the libraries used.
3147-
3148-
<DT> I get an error that says I must have some kind of blas installed
3149-
<DD> This means that SCons could find neither the versions of blas
3150-
included with Atlas nor the typical system blas. You will need to
3151-
make sure one or the other is installed. Double check your
3152-
ATLAS_LIBPATH. In a worst case, you may need to explicitly list the
3153-
libraries to use by setting the ATLAS_LIBS variable.
3154-
3155-
<DT> I get an error that says SCons could not figure out how to build
3156-
<DD> As part of the build, SCons will try to compile and link a test
3157-
program to see whether ATLAS/LAPACK works and if there are any
3158-
additional libraries needed. For some reason, this step failed.
3159-
Double-check your Atlas/lapack installation. You may want to try
3160-
building a small test program with Atlas, and use that to set
3161-
ATLAS_LIBS or CCFLAGS appropriately.
3162-
3163-
<DT> How do I compile my own, separate tool with debugging?
3164-
<DD> If you copied the example SConstruct/SConscript, then change the
3165-
LOOS_CCFLAGS environment variable before building your tool(s).
3100+
<DT> What's the easiest way to build LOOS from source?
3101+
<DD> By far, the easiest way to build LOOS is to use the script included
3102+
in the top level of the git repository, conda_build.sh. The default way to
3103+
run it is
3104+
3105+
```
3106+
./conda_build.sh -e loos -j 8 -i
3107+
```
3108+
This will create a conda environment named "loos" with LOOS, install all of
3109+
the packages necessary to build and install loos, then compile it and install.
3110+
The -j option specifies the number of parallel jobs to use when compiling. See INSTALL.md
3111+
for more details and options.
3112+
3113+
<DT> How do I build LOOS?
3114+
<DD> Modern (supported) versions of LOOS use CMake to build. See
3115+
INSTALL.md in the top level of the git repo for detailed instructions. We recommend
3116+
building inside a conda environment, but in principle you could install the various required
3117+
dependencies manually. A good starting point would be the list of conda packages in INSTALL.md.
3118+
31663119

31673120
</DL>
31683121

0 commit comments

Comments
 (0)