casaconfig 0.0.70__tar.gz → 0.0.71__tar.gz

{casaconfig-0.0.70/casaconfig.egg-info → casaconfig-0.0.71}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: casaconfig
-Version: 0.0.70
+Version: 0.0.71
 Summary: CASA Operational Configuration Package
 Home-page: https://github.com/casangi/casaconfig
 Author: National Radio Astronomy Observatory

{casaconfig-0.0.70 → casaconfig-0.0.71}/casaconfig/__main__.py

@@ -18,9 +18,9 @@ parser.add_argument( "--data-update", dest='dataupdate', action='store_const', c
 parser.add_argument( "--measures-update", dest='measuresupdate', action='store_const', const=True, default=False,
                      help="invoke measures_update() to update measurespath to the latest measures data")
 parser.add_argument( "--update-all", dest='updateall', action='store_const', const=True, default=False,
-                     help="invokes data_update then measures_update to update measurespath to the latest casarundata and measures data")
+                     help="invoke update_all() to populate (update) measurespath with the latest casarundata and measures data")
 parser.add_argument( "--reference-testing", action='store_const', const=True, dest='referencetesting', default=False,
-                     help="set measurespath to the casarundata when this version of casa was produced, used for testing purposes")
+                     help="set measurespath to the casarundata when this version was produced, used for testing purposes")
 parser.add_argument( "--current-data", dest='currentdata', action='store_const', const=True, default=False,
                      help="print out a summary of the current casarundata and measures data installed in measurespath and then exit")
 

{casaconfig-0.0.70 → casaconfig-0.0.71}/casaconfig/config.py

@@ -104,9 +104,9 @@ for __v in __defaults:
     if (__v in __path_names) :
         # expand ~ or ~user constructs and make sure they are absolute paths
         if (type(globals()[__v]) is list) :
-            vlist = list(map(__os.path.expanduser, globals()[__v]))
-            vlist = list(map(__os.path.abspath,vlist))
-            globals()[__v] = vlist
+            __vlist = list(map(__os.path.expanduser, globals()[__v]))
+            __vlist = list(map(__os.path.abspath,__vlist))
+            globals()[__v] = __vlist
         else:
             globals()[__v] = __os.path.abspath(__os.path.expanduser(globals()[__v]))
                                              

{casaconfig-0.0.70 → casaconfig-0.0.71}/casaconfig/private/config_defaults_static.py

@@ -1,7 +1,7 @@
-# search path for measurement sets and images to load, when empty then [measurespath] is used
+# lsit of paths where CASA should search for data subdirectories. Default [measurespath].
 datapath = [ ]
 
-# location of geodetic and ephemera data, default path for casaconfig data functions
+# location of required measures data, takes precedence over any measures data also present in datapath.
 measurespath = "~/.casa/data"
 
 # automatically update measures data if not current (measurespath must be owned by the user)
@@ -26,7 +26,7 @@ nologfile = False
 # print log output to terminal when True (in addition to any logfile and CASA logger)
 log2term = False
 
-# do not start the CASA logger when True
+# do not start the CASA logger GUI when True
 nologger = False
 
 # avoid starting GUI tools when True. If True then the CASA logger is not started even if nologger is False

{casaconfig-0.0.70 → casaconfig-0.0.71}/casaconfig/private/data_update.py

@@ -15,7 +15,7 @@
 this module will be included in the api
 """
 
-def data_update(path=None, auto_update_rules=False, version=None, force=False, logger=None):
+def data_update(path=None, version=None, force=False, logger=None, auto_update_rules):
     """
     Check for updates to the installed casarundata and install the update or change to 
     the requested version when appropriate.
@@ -25,25 +25,26 @@ def data_update(path=None, auto_update_rules=False, version=None, force=False, l
     must already exist in path in order to use this function. Use pull_data to install
     casarundata into a new location.
 
-    If path is None then config.measurespath will be used.
+    If path is None then config.measurespath is used.
 
     If the version is None (the default) then the most recent version returned by 
     data_available is used.
 
-    If the version requested matches the one in that text file then this function does
+    If the version requested matches the one in the readme.txt file at path then this function does
     nothing unless force is True.
 
-    If a specific version is not requested (the default) and the date in that text file
-    is today, then this function does nothing unless force is True even if there is a more
+    If a specific version is not requested (the default) and the date in the readme.txt file
+    at path is today, then this function does nothing unless force is True even if there is a more
     recent version available from the CASA server.
 
     When auto_update_rules is True then path must be owned by the user, force must be
-    False and the version must be None. This is used by casatools initialization when
-    data_auto_update is True.
+    False and the version must be None. This is used during casatools initialization when
+    data_auto_update is True. Automatic updating happens during casatools initialization
+    so that the updated casarundata and measures are in place before any tool needs to use them.
 
     If an update is to be installed the previously installed files, as listed in the 
-    readme.txt file, will first be removed and then all of the contents of the version 
-    being installed by the update are installed. This includes the set of measures tables
+    readme.txt file at path, are removed before the contents of the version 
+    being installed are unpacked. This includes the set of measures tables
     that are part of that casarundata version. A data update is typically followed by a
     measures_update to ensure that the most recent measures data are installed.
 
@@ -72,14 +73,14 @@ def data_update(path=None, auto_update_rules=False, version=None, force=False, l
     write permissions there). The version must then also be None and the force option must be False.
 
     **Note:** the most recent casarundata may not include the most recent measures data. A data_update
-    is typically followed by a measures update.
+    is typically followed by a measures_update.
 
     Parameters
        - path (str) - Folder path to update. Must contain a valid readme.txt. If not set then config.measurespath is used.
-       - auto_update_rules (bool=False) - If True then the user must be the owner of path, version must be None, and force must be False.
        - version (str=None) - Version of casarundata to retrieve (usually in the form of casarundata-x.y.z.tar.gz, see data_available()). Default None retrieves the latest.
        - force (bool=False) - If True, always re-download the casarundata. Default False will not download casarundata if already updated today unless the version parameter is specified and different from what was last downloaded.
        - logger (casatools.logsink=None) - Instance of the casalogger to use for writing messages. Default None writes messages to the terminal.
+       - auto_update_rules (bool=False) - If True then the user must be the owner of path, version must be None, and force must be False.
         
     Returns
        None

casaconfig-0.0.71/casaconfig/private/get_config.py

@@ -0,0 +1,20 @@
+def get_config( default=False ):
+    """
+    Get configuration values as a list of strings which can be logged, stored, or evaluated.
+
+    The default values (returned when default is True) are the configuration values after all config files have been evaluated but before the path values have been expanded using os.path.expanduser and os.path.abspath. Modules that use the command line to change config values may also not update the default values. User actions in a CASA session will also typically not change the default values.
+
+    Parameters
+       default (bool=False) - If True, return the default values.
+
+    Returns
+       list[str] - list of configuration strings
+    """
+
+    from .. import config as _config
+    if not default :
+        valsObj = _config
+    else:
+        valsObj = _config._config_defaults
+
+    return list( map( lambda name: f'{name} = {repr(getattr(valsObj,name))}', _config.__defaults ) )

{casaconfig-0.0.70 → casaconfig-0.0.71}/casaconfig/private/get_data_info.py

@@ -33,8 +33,8 @@ def get_data_info(path=None, logger=None):
     into place when a modular CASA is built. It is the release.txt for the
     data appropriate for that module CASA release and it used by the "--reference-testing"
     command line option for casaconfig. That allows casaconfig to install that
-    casarundata version for testing purposes. The release information comes from the
-    casaconfig module and does not depend on the path argument.
+    casarundata version for testing purposes. The release information does not depend 
+    on the path argument.
 
     If path is empty or does not exist then the return value for the 'casarundata' and
     'measures' types is None.
@@ -49,9 +49,9 @@ def get_data_info(path=None, logger=None):
     and ephemeris directories are present in path then the version returned for 'measures' is
     'unknown' and the date is an empty string. The path location may contain measures data from
     a legacy installation of CASA data. CASA may be able to use any measures tables at this
-    location by they may not be maintained by casaconfig.
+    location by they can not be maintained by casaconfig.
 
-    If 'release_data_readme.txt' file is not found with the casaconfig module the returned
+    If no casadata release information is found the returned
     value for 'release' is None and the "--reference-testing" option will not do anything
     for this installation of casaconfig. This will be the case for a modular installation.
 
@@ -63,7 +63,7 @@ def get_data_info(path=None, logger=None):
        - logger (casatools.logsink=None) - Instance of the casalogger to use for writing messages. Default None writes messages to the the terminal.
     
     Returns
-       dict - a dictionary by type, 'casarundata', 'measures', 'release' where each type is a dictionary 'version', 'date'. A return value of None indicates path is unset. A value of None for that type means no information could be found about that type.
+       dict - a dictionary by type, 'casarundata', 'measures', 'release' where each type is a dictionary containing 'version' and 'date'. A return value of None indicates path is unset. A value of None for that type means no information could be found about that type.
     """
 
     # when None is returned, path wasn't set

{casaconfig-0.0.70 → casaconfig-0.0.71}/casaconfig/private/measures_update.py

@@ -15,7 +15,7 @@
 this module will be included in the api
 """
 
-def measures_update(path=None, auto_update_rules=False, version=None, force=False, logger=None):
+def measures_update(path=None, version=None, force=False, logger=None, auto_update_rules=False):
     """
     Retrieve IERS data used for measures calculations from ASTRON server
     
@@ -27,7 +27,7 @@ def measures_update(path=None, auto_update_rules=False, version=None, force=Fals
     A text file (readme.txt in the geodetic directory in path) records the version string
     and the date when that version was installed in path.
 
-    If path is None then config.measurespath will be used.
+    If path is None then config.measurespath is used.
 
     If the version requested matches the one in that text file then this function does
     nothing unless force is True.
@@ -36,18 +36,26 @@ def measures_update(path=None, auto_update_rules=False, version=None, force=Fals
     is today, then this function does nothing unless force is True even if there is a more
     recent version available from the ASTRON server.
 
-    Automatic updating (when the measures_auto_update config value is True) uses this
-    function as the casatools module is starting so that the updated measures are in
-    place before any tool needs to use them. 
+    When auto_update_rules is True then path must be owned by the user, force must be False,
+    and the version must be None. This is used during casatools initialization when 
+    measures_auto_update is True. Automatic updating happens during casatools initialization
+    so that the updated measures are in place before any tool needs to use them.
 
     Using measures_update after casatools has started should always be followed by exiting 
     and restarting casa (or the casatools module if modular casa components are being used).
 
-    A file lock is used to prevent more that one measures_update and data_update from updating
-    the measures files in path at the same time. When locked, the lock file (data_update.lock 
-    in path) will contain information about the process that has the lock. When a measures_update
-    gets the lock it will check the readme.txt file in the geodetic directory in path
-    to make sure that an update is still necessary (if force is True an update always happens).
+    A file lock is used to prevent more that one data update (pull_data, measures_update,
+    or data_update) from updating any files in path at the same time. When locked, the 
+    lock file (data_update.lock in path) contains information about the process that
+    has the lock. When measures_update gets the lock it checks the readme.txt file in path
+    to make sure that an update is still necessary (if force is True then an update 
+    always happens). If the lock file is not empty then a previous update of path (pull_data,
+    data_update, or measures_update) did not exit as expected and the contents of path are
+    suspect. In that case, an error will be reported and nothing will be updated. The lock
+    file can be checked to see the details of when that file was locked. The lock file can be
+    removed and measures_update can be tried again. It may be safest in that case to remove path
+    completely or use a different path and use pull_data to install a fresh copy of the
+    desired version.
 
     Care should be used when using measures_update outside of the normal automatic
     update that other casa sessions are not using the same measures at the same time,
@@ -72,10 +80,10 @@ def measures_update(path=None, auto_update_rules=False, version=None, force=Fals
 
     Parameters
        - path (str) - Folder path to place updated measures data. Must contain a valid geodetic/readme.txt. If not set then config.measurespath is used.
-       - auto_update_rules (bool=False) - If True then the user must be the owner of path, version must be None, and force must be False.
        - version (str=None) - Version of measures data to retrieve (usually in the form of yyyymmdd-160001.ztar, see measures_available()). Default None retrieves the latest.
        - force (bool=False) - If True, always re-download the measures data. Default False will not download measures data if already updated today unless the version parameter is specified and different from what was last downloaded.
        - logger (casatools.logsink=None) - Instance of the casalogger to use for writing messages. Default None writes messages to the terminal
+       - auto_update_rules (bool=False) - If True then the user must be the owner of path, version must be None, and force must be False.
         
     Returns
        None

{casaconfig-0.0.70 → casaconfig-0.0.71}/casaconfig/private/pull_data.py

@@ -17,9 +17,9 @@ this module will be included in the api
 
 def pull_data(path=None, version=None, force=False, logger=None):
     """
-    Pull the package data contents from the CASA host and install it in path.
+    Pull the casarundata contents from the CASA host and install it in path.
 
-    The path must either contain a previously installed version of the package data 
+    The path must either contain a previously installed version of casarundata 
     or it must not exist or be empty.
 
     If path is None then config.measurespath will be used.
@@ -36,7 +36,7 @@ def pull_data(path=None, version=None, force=False, logger=None):
     version already matches what was previously installed (no installation is then
     necessary unless force is True).
 
-    The measures tables included in the package data will typically 
+    The measures tables included in casarundata will typically 
     not be the most recent version. To get the most recent measures data, measures_update
     should be used after pull_data.
 
@@ -53,12 +53,12 @@ def pull_data(path=None, version=None, force=False, logger=None):
     did not exit as expected and the contents of path are suspect. In that case, pull_data
     will report that as an error and nothing will be updated. The lock file can be checked
     to see the details of when that file was locked. The lock file can be removed and
-    pull_data can be then be used to install the desired version. It may be safest in that case
+    pull_data can then be used to install the desired version. It may be safest in that case
     to remove path completely or use a different path and run pull_data to install 
     a fresh copy of the desired version.
 
     Some of the tables installed by pull_data are only read when casatools starts. Use of 
-    pull_data after CASA has started should typically be followed by a restart so that 
+    pull_data should typically be followed of CASA by a restart so that 
     any changes are seen by the tools and tasks that use this data.
 
     Parameters

{casaconfig-0.0.70 → casaconfig-0.0.71/casaconfig.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: casaconfig
-Version: 0.0.70
+Version: 0.0.71
 Summary: CASA Operational Configuration Package
 Home-page: https://github.com/casangi/casaconfig
 Author: National Radio Astronomy Observatory

{casaconfig-0.0.70 → casaconfig-0.0.71}/setup.py

@@ -6,7 +6,7 @@ with open('README.md', "r") as fid:   #encoding='utf-8'
 
 setup(
     name='casaconfig',
-    version='0.0.70',
+    version='0.0.71',
     description='CASA Operational Configuration Package',
     long_description=long_description,
     long_description_content_type="text/markdown",

casaconfig-0.0.70/casaconfig/private/get_config.py

@@ -1,20 +0,0 @@
-def get_config( default=False ):
-    """
-    Get configuration values as strings which can be logged, stored or evaluated.
-
-    The default values (returned with default is True) are the config values after all config files have been evaluated but before the path values have been expanded using os.path.expanduser and os.path.abspath. Modules that use the command line to change config values may also not update the default values. User actions in a CASA session will also typically not change the default values.
-
-    Parameters
-       default (bool=False) - If True, return the default values.
-
-    Returns
-       list[str] - list of configuration strings
-    """
-
-    from .. import config as _config
-    if not default :
-        valsObj = _config
-    else:
-        valsObj = _config._config_defaults
-
-    return list( map( lambda name: f'{name} = {repr(getattr(valsObj,name))}', _config.__defaults ) )