cellpy.parameters.prmreader

Module Contents

Functions

create_custom_init_filename([user_name])	Creates a custom prms filename
get_env_file_name()	Returns the location of the env-file
get_user_dir()	Gets the name of the user directory
get_user_dir_and_dst([init_filename])	Gets the name of the user directory and full prm filepath
get_user_name()	Get the username of the current user (cross-platform)
info()	This function will show only the 'box'-type
initialize()	Initializes cellpy by reading the config file and the environment file

Attributes

DEFAULT_FILENAME
DEFAULT_FILENAME_END
DEFAULT_FILENAME_START
ENVIRONMENT_EXAMPLE
USE_MY_DOCUMENTS
yaml

create_custom_init_filename(user_name=None)

Creates a custom prms filename

get_env_file_name()

Returns the location of the env-file

get_user_dir()

Gets the name of the user directory

get_user_dir_and_dst(init_filename=None)

Gets the name of the user directory and full prm filepath

get_user_name()

Get the username of the current user (cross-platform)

info()

This function will show only the ‘box’-type attributes and their content in the cellpy.prms module

initialize()

Initializes cellpy by reading the config file and the environment file

DEFAULT_FILENAME

DEFAULT_FILENAME_END = '.conf'

DEFAULT_FILENAME_START = '.cellpy_prms_'

ENVIRONMENT_EXAMPLE = Multiline-String

Show Value

"""
# This is an example of an environment file for cellpy.
# The environment file is used to set environment variables
# that are used by cellpy.
# The environment file should be located in the user directory
# (i.e. the directory returned by pathlib.Path.home()).
# The default environment file is named .env_cellpy, but you can
# change this in your config file.
# The environment file should contain the following variables:
# CELLPY_PASSWORD=<password>
# CELLPY_KEY_FILENAME=<key_filename>
# CELLPY_HOST=<host>
# CELLPY_USER=<user>
"""

USE_MY_DOCUMENTS = False

yaml