cellpy.parameters.prmreader
#
Module Contents#
Functions#
|
Creates a custom prms filename |
Returns the location of the env-file |
|
Gets the name of the user directory |
|
|
Gets the name of the user directory and full prm filepath |
Get the username of the current user (cross-platform) |
|
|
This function will show only the 'box'-type |
Initializes cellpy by reading the config file and the environment file |
Attributes#
- get_user_dir_and_dst(init_filename=None)[source]#
Gets the name of the user directory and full prm filepath
- info()[source]#
This function will show only the ‘box’-type attributes and their content in the cellpy.prms module
- ENVIRONMENT_EXAMPLE = Multiline-String[source]#
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> """