sdss_install Reference

Install

Install SDSS-IV and SDSS-V software.

class sdss_install.install.Install.Install(options=None)

Bases: object

Main class which calls Install4 and Install5 for SVN and GitHub installations, respectively

build()

Build the installed product.

build_documentation()

Build the documentaion of the installed product.

build_package()

Build the C/C++ product.

checkout()

Call Install5.checkout

clean()

Remove the work directory tree.

clean_directory_install(install_dir=None)

Remove existing install directory if exists and if option –force.

execute_command(command=None, argument=None)

Execute the passed terminal command.

export_data()

Sync class Import data to class Import4 or class Import5.

fetch()

Call set_fetch() of class Install4 or class Install5

finalize()

Log installation final result message.

import_data()

Sync data from class Import4 or class Import5 to class Import.

initialize_data()

Initialize class Install data.

install_external_dependencies()

Install external dependencies.

install_external_github_product(github_product=None)

Install external dependency from GitHub

install_external_product(install_product=None)

Install external products

install_external_svn_product(svn_product=None)

Install external dependency from SVN

logger_build_message()

Log the build message.

make_directory_install()

Make install directory.

reset_options_from_config()

Set absent command-line options from etc/config.ini file, if it exists.

set_build_type()

Analyze the code to determine the build type

set_directory()

Initialize dict self.directory and set value for key ‘original’ to current working directory.

set_directory_install()

Set dict self.directory values for keys ‘root’ and ‘install’.

set_directory_work()

Set dict self.directory value for key ‘work’, used to install product and/or module file. Remove existing work directory.

set_environ()

Set environment variables WORKING_DIR and INSTALL_DIR.

set_exists()

Call set_exists() of class Install4 or class Install5

set_external_path(path=None, path_type=None)

Prepend the given path to the given path_type.

set_external_paths(paths=None)

Set external paths, like PATH, IDL_PATH, and PYTHONPATH

set_external_product_install_dir()

Set the directory for external dependencies.

set_install4()

Set a class Install4 instance.

set_install5()

Set a class Install5 instance.

set_logger(options=None)

Set the logger used by all classes in the package.

set_modules()

Set a class Modules instance.

set_options(options=None)

Set self.options wrapper

set_product()

Call set_product() of class Install4 or class Install5.

set_ready()

Call set_ready() of class Install4 or class Install5.

set_sdss_github_remote_url(use_public=None)

Set the set_sdss_github_remote_url() of class Install5

set_svncommand()

Wrapper for method Install4.set_svncommand()

Install SDSS-IV software.

class sdss_install.install4.Install4.Install4(logger=None, options=None)

Bases: object

Class for sdss_install’ation of SVN repositories.

execute_command(command=None)

Execute the passed terminal command.

fetch()

SVN checkout or export the product version.

set_exists()

Check for existence of the product URL.

set_logger(logger=None)

Set the class logger

set_options(options=None)

Set command line argument options

set_product()

Set self.product dict containing product and version names etc.

set_ready()

Set self.ready after sanity check self.options.

set_svncommand()

Set the SVN command for public, otherwise add username to SVN command.

Install SDSS-V software.

class sdss_install.install5.Install5.Install5(logger=None, options=None)

Bases: object

Class for sdss_installation of GitHub repositories.

checkout()

Checkout branch or tag and, if tag, remove git remote origin.

clone()

Clone the GitHub repository for the product.

execute_command(command=None)

Execute the passed terminal command.

export()

Remove git remote origin.

fetch()

Clone master branch of product version from GitHub then checkout other branch or tag if necessary.

get_bootstrap_version()

Return latest sdss_install tag, if present, otherwise ‘master’.

get_valid_product(github_url=None, product=None, version=None)

Validate the product

get_valid_version(github_url=None, product=None, version=None)

Validate the product version

is_type(type=None, github_url=None, product=None, version=None)

Check if the product_version is a valid Github branch.

set_attributes()

Set class attributes.

set_logger(logger=None)

Set the class logger

set_options(options=None)

Set command line argument options

set_product()

Set self.product dict containing product and version names etc.

set_ready()

Set self.ready after sanity check self.options and product/version validation

set_sdss_github_remote_url(use_public=None)

Set the SDSS GitHub HTTPS remote URL

validate_product_and_version(github_url=None, product=None, version=None)

Validate the product and product version.

Modules

class sdss_install.install.modules.Modules(options=None, logger=None, product=None, directory=None, build_type=None)

Bases: object

Class for handling and preparing the installation of module files

build()

Install the product modulefile (and versionfile if –default is specified).

check_options()

Check for / create a modulefile directory (if there is an etc/product.module file or for the tree product)

load(product=None, version=None)

Hook to module load function.

load_dependencies()

Load dependencies.

set_dependencies()

Set the dependencies by looking for modules loaded in the modules file

set_directory()

Make module file installation directory.

set_file(ext='.module')

Set product module file path.

set_keywords(build_type=None)

Set keywords to configure module.

set_ready()

Set up Modules.

Module

class sdss_install.utils.module.Module(logger=None, options=None)

Bases: object

Class for system module’s shell in python. Replaces system module’s python shell, which has poor pipe handling.

list_modules()

List the currently loaded modules

set_logger(logger=None)

Set the class logger

set_modules_home()

Set modules_home.

set_options(options=None)

Set command line argument options

set_ready()

Set self.ready after setting modules information.

set_tclsh()

Set tclsh exec directory.

set_version()

Set the Modules Release Tcl version string returned by modules –version.

set_version_major_minor_patch()

From the the Modules Release Tcl version string, set version major, minor, and patch.