moeyensj / thor / 189

pending completion

Build # 189

Build Type

Pull #48

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/moeyensj/thor/commit/<a class=hub.com/moeyensj/thor/commit/<a class="double-link" href="https://git"><a class=hub.com/moeyensj/thor/commit/<a class="double-link" href="https://git"><a class=hub.com/moeyensj/thor/commit/ce0f7a8edba28a22a45a8d7aa9bf1903befa0578">ce0f7a8ed<a href="https://github.com/moeyensj/thor/commit/ce0f7a8edba28a22a45a8d7aa9bf1903befa0578">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/moeyensj/thor/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/moeyensj/thor/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/moeyensj/thor/commit/ce0f7a8edba28a22a45a8d7aa9bf1903befa0578&quot;&gt;ce0f7a8ed&lt;/a&gt;&lt;a href=&quot;https://github.com/moeyensj/thor/commit/ce0f7a8edba28a22a45a8d7aa9bf1903befa0578&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/moeyensj/thor/commit/ce0f7a8edba28a22a45a8d7aa9bf1903&lt;/a&gt;befa0578">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/moeyensj/thor/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/moeyensj/thor/commit/<a class="double-link" href="https://github.com/moeyensj/thor/commit/b979a8013cd79cfadb60c6b31e08ed7d833b9cc8">b979a8013</a><a href="https://github.com/moeyensj/thor/commit/ce0f7a8edba28a22a45a8d7aa9bf1903befa0578">&amp;quot;&amp;gt;b979a8013&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;b979a8013&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/moeyensj/thor/commit/ce0f7a8edba28a22a45a8d7aa9bf1903befa0&lt;/a&gt;578&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/moeyensj/thor/commit/<a class="double-link" href="https://github.com/moeyensj/thor/commit/5d4894708">5d4894708">5d4894708</a>

Pull Request Pull Request #48: Conda packaging and publishing, DOI, and DE440 support

Run Details

303 of 303 new or added lines in 31 files covered. (100.0%)

2575 of 5395 relevant lines covered (47.73%)

0.48 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.0

/thor/utils/spice.py

import os
import logging
import spiceypy as sp

from .io import _downloadFile
from .io import _readFileLog

logger = logging.getLogger(__name__)

__all__ = [
    "KERNEL_URLS",
    "KERNELS_DE430",
    "KERNELS_DE440",
    "getSPICEKernels",
    "setupSPICE",
    "useDE430",
    "useDE440",
    "useDefaultDEXXX"
]

KERNEL_URLS = {
    # Internal Name :  URL
    "latest_leapseconds.tls" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/lsk/latest_leapseconds.tls",
    "pck00010.tpc" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/pck00010.tpc",
    "earth_latest_high_prec.bpc" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/earth_latest_high_prec.bpc",
    "earth_720101_070426.bpc" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/earth_720101_070426.bpc",
    "earth_200101_990628_predict.bpc" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/earth_200101_990628_predict.bpc",
    "earth_assoc_itrf93.tf" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/fk/planets/earth_assoc_itrf93.tf",
    "de430.bsp" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/spk/planets/de430.bsp",
    "de440.bsp" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/spk/planets/de440.bsp",
}

BASEKERNELS = [
    "latest_leapseconds.tls",  
    "pck00010.tpc", 
    "earth_200101_990628_predict.bpc",
    "earth_720101_070426.bpc", 
    "earth_latest_high_prec.bpc", 
]
KERNELS_DE430 = BASEKERNELS + ["de430.bsp"]
KERNELS_DE440 = BASEKERNELS + ["de440.bsp"]

def getSPICEKernels(
        kernels=KERNELS_DE430
    ):
    """
    Download SPICE kernels. If any already exist, check if they have been updated. If so, replace the 
    outdated file with the latest version. 
    
    SPICE kernels used by THOR: 
    "latest_leapseconds.tls": latest_leapseconds.tls downloaded from https://naif.jpl.nasa.gov/pub/naif/generic_kernels/lsk,
    "earth_latest_high_prec.bpc": earth_latest_high_prec.bpc downloaded from https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck,
    "earth_720101_070426.bpc": earth_720101_070426.bpc downloaded from https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck,
    "earth_200101_990628_predict.bpc": earth_070425_370426_predict.bpc downloaded from https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/
    "de430.bsp": de430.bsp downloaded from https://naif.jpl.nasa.gov/pub/naif/generic_kernels/spk/planets/
    
    Only the leapsecond and Earth planetary constants kernels are checked for updates since these files are rather small (< 10 MB). The 
    planetary ephemerides file is over 1.5 GB and is not checked for an update (these files are not updated regularly and are often released as 
    different version with different physical assumptions)
    
    Parameters
    ----------
    kernels : list, optional
        Names of the kernels to download. By default, all kernels required by THOR are downloaded. 
        Possible options are:
            "latest_leapseconds.tls"
            "earth_latest_high_prec.bpc"
            "earth_720101_070426.bpc"
            "earth_200101_990628_predict.bpc"
            "de430.bsp" or "de440.bsp"
    
    Returns
    -------
    None
    """
    for kernel in kernels:
        logger.info("Checking for {} kernel...".format(kernel))
        url = KERNEL_URLS[kernel]
        _downloadFile(os.path.join(os.path.dirname(__file__), "..", "data"), url)
    return

def setupSPICE(
        kernels=KERNELS_DE430,
        force=False
    ):
    """
    Loads the leapsecond, the Earth planetary constants and the planetary ephemerides kernels into SPICE. 
    
    Parameters
    ----------
    kernels : list, optional
        Names of the kernels to load. By default, all kernels required by THOR are loaded. 
        Possible options are:
            "latest_leapseconds.tls"
            "earth_latest_high_prec.bpc"
            "earth_720101_070426.bpc"
            "earth_200101_990628_predict.bpc"
            "de430.bsp" or "de440.bsp"
    force : bool, optional
        Force spiceypy to set up kernels regardless of if SPICE is already set up.
            
    Returns
    -------
    None
    """
    pid = os.getpid()
    var_name = f"THOR_SPICE_pid{pid}"

    is_setup = var_name in os.environ.keys()
    is_ephemeris_correct = False
    if is_setup:
        is_ephemeris_correct = os.environ[var_name] in kernels 

    if (is_setup or is_ephemeris_correct) and not force:
        logger.info("SPICE is already enabled.")
    else:
        logger.info("Enabling SPICE...")
        log = _readFileLog(os.path.join(os.path.dirname(__file__), "..", "data/log.yaml"))
        
        ephemeris_file = ""
        for kernel in kernels:
            file_name = os.path.basename(KERNEL_URLS[kernel])
            
            # Check if the current file is an ephemeris file
            if os.path.splitext(file_name)[1] == ".bsp":
                ephemeris_file = file_name

            if file_name not in log.keys():
                err = ("{} not found. Please run thor.utils.getSPICEKernels to download SPICE kernels.")
                raise FileNotFoundError(err.format(file_name))
            sp.furnsh(log[file_name]["location"])

        if ephemeris_file == "":
            err = (
                "SPICE has not recieved a planetary ephemeris file.\n" \
                "Please provide either de430.bsp, de440.bsp, or similar."
            )
            raise ValueError(err)

        os.environ[var_name] = ephemeris_file
        logger.info("SPICE enabled.")
    return

def useDE430(func):
    """
    Decorator: Configures SPICE (via spiceypy) to
    use the DE430 planetary ephemerides.
    """
    getSPICEKernels(KERNELS_DE430)
    setupSPICE(KERNELS_DE430, force=True)

    def wrap(*args, **kwargs):
        return func(*args, **kwargs)

    return wrap

def useDE440(func):
    """
    Decorator: Configures SPICE (via spiceypy) to
    use the DE440 planetary ephemerides.
    """
    getSPICEKernels(KERNELS_DE440)
    setupSPICE(KERNELS_DE440, force=True)

    def wrap(*args, **kwargs):
        return func(*args, **kwargs)

    return wrap

# Set default to DE430
useDefaultDEXXX = useDE430

1	import os	1✔
2	import logging	1✔
3	import spiceypy as sp	1✔
4
5	from .io import _downloadFile	1✔
6	from .io import _readFileLog	1✔
7
8	logger = logging.getLogger(__name__)	1✔
9
10	__all__ = [	1✔
11	"KERNEL_URLS",
12	"KERNELS_DE430",
13	"KERNELS_DE440",
14	"getSPICEKernels",
15	"setupSPICE",
16	"useDE430",
17	"useDE440",
18	"useDefaultDEXXX"
19	]
20
21	KERNEL_URLS = {	1✔
22	# Internal Name : URL
23	"latest_leapseconds.tls" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/lsk/latest_leapseconds.tls",
24	"pck00010.tpc" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/pck00010.tpc",
25	"earth_latest_high_prec.bpc" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/earth_latest_high_prec.bpc",
26	"earth_720101_070426.bpc" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/earth_720101_070426.bpc",
27	"earth_200101_990628_predict.bpc" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/earth_200101_990628_predict.bpc",
28	"earth_assoc_itrf93.tf" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/fk/planets/earth_assoc_itrf93.tf",
29	"de430.bsp" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/spk/planets/de430.bsp",
30	"de440.bsp" : "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/spk/planets/de440.bsp",
31	}
32
33	BASEKERNELS = [	1✔
34	"latest_leapseconds.tls",
35	"pck00010.tpc",
36	"earth_200101_990628_predict.bpc",
37	"earth_720101_070426.bpc",
38	"earth_latest_high_prec.bpc",
39	]
40	KERNELS_DE430 = BASEKERNELS + ["de430.bsp"]	1✔
41	KERNELS_DE440 = BASEKERNELS + ["de440.bsp"]	1✔
42
43	def getSPICEKernels(	1✔
44	kernels=KERNELS_DE430
45	):
46	"""
47	Download SPICE kernels. If any already exist, check if they have been updated. If so, replace the
48	outdated file with the latest version.
49
50	SPICE kernels used by THOR:
51	"latest_leapseconds.tls": latest_leapseconds.tls downloaded from https://naif.jpl.nasa.gov/pub/naif/generic_kernels/lsk,
52	"earth_latest_high_prec.bpc": earth_latest_high_prec.bpc downloaded from https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck,
53	"earth_720101_070426.bpc": earth_720101_070426.bpc downloaded from https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck,
54	"earth_200101_990628_predict.bpc": earth_070425_370426_predict.bpc downloaded from https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/
55	"de430.bsp": de430.bsp downloaded from https://naif.jpl.nasa.gov/pub/naif/generic_kernels/spk/planets/
56
57	Only the leapsecond and Earth planetary constants kernels are checked for updates since these files are rather small (< 10 MB). The
58	planetary ephemerides file is over 1.5 GB and is not checked for an update (these files are not updated regularly and are often released as
59	different version with different physical assumptions)
60
61	Parameters
62	----------
63	kernels : list, optional
64	Names of the kernels to download. By default, all kernels required by THOR are downloaded.
65	Possible options are:
66	"latest_leapseconds.tls"
67	"earth_latest_high_prec.bpc"
68	"earth_720101_070426.bpc"
69	"earth_200101_990628_predict.bpc"
70	"de430.bsp" or "de440.bsp"
71
72	Returns
73	-------
74	None
75	"""
76	for kernel in kernels:	1✔
77	logger.info("Checking for {} kernel...".format(kernel))	1✔
78	url = KERNEL_URLS[kernel]	1✔
79	_downloadFile(os.path.join(os.path.dirname(__file__), "..", "data"), url)	1✔
80	return	1✔
81
82	def setupSPICE(	1✔
83	kernels=KERNELS_DE430,
84	force=False
85	):
86	"""
87	Loads the leapsecond, the Earth planetary constants and the planetary ephemerides kernels into SPICE.
88
89	Parameters
90	----------
91	kernels : list, optional
92	Names of the kernels to load. By default, all kernels required by THOR are loaded.
93	Possible options are:
94	"latest_leapseconds.tls"
95	"earth_latest_high_prec.bpc"
96	"earth_720101_070426.bpc"
97	"earth_200101_990628_predict.bpc"
98	"de430.bsp" or "de440.bsp"
99	force : bool, optional
100	Force spiceypy to set up kernels regardless of if SPICE is already set up.
101
102	Returns
103	-------
104	None
105	"""
106	pid = os.getpid()	1✔
107	var_name = f"THOR_SPICE_pid{pid}"	1✔
108
109	is_setup = var_name in os.environ.keys()	1✔
110	is_ephemeris_correct = False	1✔
111	if is_setup:	1✔
112	is_ephemeris_correct = os.environ[var_name] in kernels	1✔
113
114	if (is_setup or is_ephemeris_correct) and not force:	1✔
115	logger.info("SPICE is already enabled.")	1✔
116	else:
117	logger.info("Enabling SPICE...")	1✔
118	log = _readFileLog(os.path.join(os.path.dirname(__file__), "..", "data/log.yaml"))	1✔
119
120	ephemeris_file = ""	1✔
121	for kernel in kernels:	1✔
122	file_name = os.path.basename(KERNEL_URLS[kernel])	1✔
123
124	# Check if the current file is an ephemeris file
125	if os.path.splitext(file_name)[1] == ".bsp":	1✔
126	ephemeris_file = file_name	1✔
127
128	if file_name not in log.keys():	1✔
129	err = ("{} not found. Please run thor.utils.getSPICEKernels to download SPICE kernels.")	×
130	raise FileNotFoundError(err.format(file_name))	×
131	sp.furnsh(log[file_name]["location"])	1✔
132
133	if ephemeris_file == "":	1✔
134	err = (	×
135	"SPICE has not recieved a planetary ephemeris file.\n" \
136	"Please provide either de430.bsp, de440.bsp, or similar."
137	)
138	raise ValueError(err)	×
139
140	os.environ[var_name] = ephemeris_file	1✔
141	logger.info("SPICE enabled.")	1✔
142	return	1✔
143
144	def useDE430(func):	1✔
145	"""
146	Decorator: Configures SPICE (via spiceypy) to
147	use the DE430 planetary ephemerides.
148	"""
149	getSPICEKernels(KERNELS_DE430)	×
150	setupSPICE(KERNELS_DE430, force=True)	×
151
152	def wrap(args, *kwargs):	×
153	return func(args, *kwargs)	×
154
155	return wrap	×
156
157	def useDE440(func):	1✔
158	"""
159	Decorator: Configures SPICE (via spiceypy) to
160	use the DE440 planetary ephemerides.
161	"""
162	getSPICEKernels(KERNELS_DE440)	×
163	setupSPICE(KERNELS_DE440, force=True)	×
164
165	def wrap(args, *kwargs):	×
166	return func(args, *kwargs)	×
167
168	return wrap	×
169
170	# Set default to DE430
171	useDefaultDEXXX = useDE430	1✔

moeyensj / thor / 189

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous