update July  19, 2020
NAME

BIRCHUserSettings.py - Set environment variables for BIRCH

SYNOPSIS

BIRCHUserSettings.py --setvar variable_name=value


OPTIONS
--setvar variable_name=value - set a new value for a BIRCH environment variable. 

DESCRIPTION
BIRCH uses environment variables to govern various aspects of how it works, or to specify the location of important directories. The following environment variables can be set:

variable_name
purpose
value/example
BIRCH_PROMPT
causes command line prompt to display hostname and current working directory in terminal windows.
Y - display prompt
N - use system prompt
BL_EMAIL
Email address to be used by BioLegato for notification when long-running jobs complete.
picard@enterprise.org
NCBI_ENTREZ_KEY
This is an NCBI Entrez API Key, as described in https://ncbiinsights.ncbi.nlm.nih.gov/2017/11/02/new-api-keys-for-the-e-utilities/. If it is set, BLAST searches and Entrez keyword queries will be run using this key. The key is not required to use these resources, but NCBI may give higher priority to users with an API key, if they make a lot of database requests.


FILES
Environment variables are set in $HOME/.config/BIRCH/BIRCH.settings.source. This file is a bash script that sets the above environment variables, after those variables are set by $BIRCH/admin/profile.source. Thus, the values set in this file override system default settings. This file is overwritten each time a variable is set, so it should not be edited using a text editor. If this file doesn't exist, BIRCHUserSettings.py will create it.

AUTHOR
Dr. Brian Fristensky
Department of Plant Science
University of Manitoba
Winnipeg, MB  Canada R3T 2N2
frist@cc.umanitoba.ca
http://home.cc.umanitoba.ca/~frist5