Skip to content
Snippets Groups Projects
Unverified Commit 0a26b8fa authored by Jesse Mapel's avatar Jesse Mapel Committed by GitHub
Browse files

Updated generate_kernels_from_cube docs (#498)

* Updated generate_kernels_from_cube docs

* Missing word

* Proper func link
parent 063d6ff2
No related branches found
No related tags found
No related merge requests found
...@@ -143,7 +143,12 @@ def dict_merge(dct, merge_dct): ...@@ -143,7 +143,12 @@ def dict_merge(dct, merge_dct):
def get_isis_preferences(isis_preferences=None): def get_isis_preferences(isis_preferences=None):
""" """
Returns ISIS Preference file as a pvl object Returns ISIS Preference file as a pvl object.
This will search the following locations, in order, for an IsisPreferences file:
#. The .Isis directory in your home directory
#. The directory pointed to by the ISISROOT environment variable
""" """
argprefs = {} argprefs = {}
if isis_preferences: if isis_preferences:
...@@ -194,6 +199,7 @@ def generate_kernels_from_cube(cube, expand=False, format_as='list'): ...@@ -194,6 +199,7 @@ def generate_kernels_from_cube(cube, expand=False, format_as='list'):
Path to the cube to pull the kernels from. Path to the cube to pull the kernels from.
expand : bool, optional expand : bool, optional
Whether or not to expand variables within kernel paths based on your IsisPreferences file. Whether or not to expand variables within kernel paths based on your IsisPreferences file.
See :func:`get_isis_preferences` for how the IsisPreferences file is found.
format_as : str, optional {'list', 'dict'} format_as : str, optional {'list', 'dict'}
How to return the kernels: either as a one-dimensional ordered list, or as a dictionary How to return the kernels: either as a one-dimensional ordered list, or as a dictionary
of kernel lists. of kernel lists.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment