Skip to content

Latest commit

 

History

History
93 lines (58 loc) · 4.36 KB

README.md

File metadata and controls

93 lines (58 loc) · 4.36 KB
Raw

Cinch-Utils Project

The cinch-utils project provides a set of utilities that support library and application development using cinch. The primary utility is the Cinch command-line interface, which is documented here.

Requirements

For full functionality, Cinch-Utils requires at least the tools and versions listed here:

  • CMake (Version 2.8)
  • Python (Version 2.7)
  • Pandoc (Version 1.12)
  • TeX Live (No particular version)
  • Doxygen (Version 1.8)
  • C++ Compiler (gcc 4.8, Intel 14)

Getting the Code

Cinch-utils uses git submodules, so it must be checked out recursively:

% git clone --recursive git@server:repo/cinch-utils.git

If you are using the main github site, use this:

% git clone --recursive git@github.com:losalamos/cinch-utils.git

If you are using the gitlab mirror at LANL, use this:

% git clone --recursive git@gitlab.lanl.gov:csse/cinch-utils.git

Installation

To begin, configure Cinch-Utils with the path to the desired installation directory:

% mkdir build
% cd build
% cmake -DCMAKE_INSTALL_PREFIX=/path/to/install ..
% make install

You can also use the curses version of CMake:

% mkdir build
% cd build
% ccmake ..
% make install

This will install the command-line tool and some helper scripts to setup your environment. After you have performed the above steps, you should source the appropriate environment script, e.g.:

% source /path/to/install/bin/cinchenv.sh (bash)

or

% source /path/to/install/bin/cinchenv.csh (csh/tcsh)

The installation also includes an environment module that may be used to configure your environment. This may be installed in an appropriate system location, or locally by adding the installation bin directory to your MODULEPATH.

If you prefer, you may also set the required environment variables manually:

PATH add the bin directory of the install path to your PATH

PYTHONPATH add the lib/pythonX.X/site-packages path to your PYTHONPATH

Release

This software has been approved for open source release and has been assigned LA-CC-15-070.

Copyright

Copyright (c) 2016, Los Alamos National Security, LLC All rights reserved.

Copyright 2016. Los Alamos National Security, LLC. This software was produced under U.S. Government contract DE-AC52-06NA25396 for Los Alamos National Laboratory (LANL), which is operated by Los Alamos National Security, LLC for the U.S. Department of Energy. The U.S. Government has rights to use, reproduce, and distribute this software. NEITHER THE GOVERNMENT NOR LOS ALAMOS NATIONAL SECURITY, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified to produce derivative works, such modified software should be clearly marked, so as not to confuse it with the version available from LANL.

Additionally, redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Neither the name of Los Alamos National Security, LLC, Los Alamos National Laboratory, LANL, the U.S. Government, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY LOS ALAMOS NATIONAL SECURITY, LLC AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL LOS ALAMOS NATIONAL SECURITY, LLC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.