lines 5-47 of file: bin/environment.sh

# {xrst_begin environment}
# {xrst_spell
#     toml
#     pytest
# }
# {xrst_comment_ch #}
#
# Create and Activate cmpad Environment
# #####################################
#
# Syntax
# ******
# | |tab| ``build_type=``\ *build_type*
# | |tab| ``source bin/environment.sh``
#
# build_type
# **********
# This must be either ``debug`` or ``release`` .
#
# Create Environment
# ******************
# If the file ``build/``\ *build_type*\ ``/bin/activate`` does **not** exist,
# a python virtual environment is create in the directory
# ``build/``\ *build_type* .
# In addition, the python packages xrst, toml, pytest, and numpy
# are installed in this environment.
# In this case, environment.sh will output text saying that it is creating
# ``build/``\ *build_type*\ ``/bin/activate`` .
#
# Activate Environment
# ********************
# If the shell variable value $VIRTUAL_ENV does not end with
# ``build/``\ *build_type*\ , ``build/``\ *build_type*\ ``/bin/activate``
# is used to activate the environment.
# In this case, environment.sh will output text saying that it is sourcing
# ``build/``\ *build_type*\ ``/bin/activate`` .
#
# PYTHONPATH
# **********
# This shell variable will be set to the location of the site-packages
# in the virtual environment.
#
# {xrst_end environment}