curryer.kernels.create
======================

.. py:module:: curryer.kernels.create

.. autoapi-nested-parse::

   SPICE kernel creation wrapper.

   @author: Brandon Stone



Attributes
----------

.. autoapisummary::

   curryer.kernels.create.logger


Classes
-------

.. autoapisummary::

   curryer.kernels.create.KernelCreator


Functions
---------

.. autoapisummary::

   curryer.kernels.create.batch_kernels


Module Contents
---------------

.. py:data:: logger

.. py:class:: KernelCreator(overwrite=False, append=False, bin_dir: pathlib.Path = None, parent_dir: pathlib.Path = None)

   Class used to create kernels.


   .. py:attribute:: _overwrite
      :value: False



   .. py:attribute:: _append
      :value: False



   .. py:attribute:: _bin_dir
      :value: None



   .. py:attribute:: _parent_dir
      :value: None



   .. py:method:: find_bin_dir(exe: str = 'mkspk')


   .. py:method:: find_class(class_path)
      :staticmethod:


      Convert a class path string to an imported object.



   .. py:method:: load_input_data(input_obj, parent_dir: pathlib.Path = None, input_columns: dict = None)


   .. py:method:: load_writer(properties: curryer.kernels.classes.AbstractKernelProperties, parent_dir: pathlib.Path = None)


   .. py:method:: write(properties: curryer.kernels.classes.AbstractKernelProperties, output_kernel: pathlib.Path, input_data, input_columns=None)


   .. py:method:: write_from_json(properties_file: pathlib.Path, output_kernel: pathlib.Path = None, input_data=None, input_columns=None, overrides=None)


.. py:function:: batch_kernels(kernel_configs, output_kernels=None, time_range=None, time_format='utc', buffer_hours=0, lag_days=None, overwrite=False, append=False)

   Create SPICE kernels.

   The mission, data source (accessor) and kernel properties are defined in a
   JSON file.

   :param kernel_configs: One or more kernel creation properties (JSON file).
   :type kernel_configs: list[str or Path]
   :param output_kernels: File to save the kernel as. Default is to use the `kernel_config`, but
                          with the appropriate file extension. Must be None if more than one
                          kernel config is given.
   :type output_kernels: list[str or Path], optional
   :param time_range: Time range of data to write to the kernel (exclusive end). Default is
                      to write all available data.
   :type time_range: iter of (str or int), optional
   :param time_format: Time format code (ttype) of `time_range`. Default="utc".
   :type time_format: str, optional
   :param buffer_hours: Option to buffer `time_range`, in hours. Default=0.
   :type buffer_hours: float or list[float], optional
   :param lag_days: Define the `time_range` to be a 24-hour window starting `lag_days` days
                    prior to the start of the current day (UTC).
   :type lag_days: int, optional
   :param overwrite: Overwrite an existing file.
   :type overwrite: bool, optional
   :param append: Append to an existing file.
   :type append: bool, optional

   :returns: The output kernel files, same as `output_kernels` if it was given.
   :rtype: list[str or Path]