Commit 7298a9aa authored by Marc Costa's avatar Marc Costa
Browse files

Initial Commit

parents
Loading
Loading
Loading
Loading

.gitattributes

0 → 100644
+4 −0
Original line number Original line Diff line number Diff line
*.BSP filter=lfs diff=lfs merge=lfs -text
*.BC filter=lfs diff=lfs merge=lfs -text
*.bsp filter=lfs diff=lfs merge=lfs -text
*.bc filter=lfs diff=lfs merge=lfs -text

MANIFEST.in

0 → 100644
+6 −0
Original line number Original line Diff line number Diff line
include ExoMars2016.html
include MANIFEST.in
include README.md
recursive-include kernels *
recursive-include misc *
 No newline at end of file

README.md

0 → 100644
+148 −0
Original line number Original line Diff line number Diff line
ExoMarsRSP SPICE Kernel Dataset
===============================

SPICE is an essential tool for scientists and engineers alike in the
planetary science field for Solar System Geometry. Please visit the
[ESA SPICE Service (ESS) web site](https://spice.esac.esa.int).



The ExoMarsRSP SPICE Kernel Dataset (SKD) consists on a complete set of SPICE 
Kernels that cover the whole mission lifespan including reconstructed and long 
term predicted trajectory and orientation. The SKD has the following directory 
structure:

* root directory (named after the mission: ExoMarsRSP)
  * kernels
    * ck: Kernels that contain orientation for the rover and some of its structures, (solar arrays, for instance).
    * fk: Kernels that define reference frames needed for the Mission.
    * ik: Kernels for the instruments on board the spacecraft.
    * lsk: Leapseconds kernel.
    * mk: Meta-kernel files (a.k.a "furnsh" files) that provide lists of kernels suitable for a given mission period.
    * pck: Kernels that define planetary constants.
    * sclk: Spacecraft clock coefficients kernels.
    * spk: Orbit kernels, for the spacecraft and other solar system bodies.
  *	misc
    * release notes: Includes the Release Notes of the SKD.
    * other: different directories of interest.

The SKD also include text files that help to understand the contents of every directory. Those files are named aareadme.txt.

Please note that this Git repository provides a subset of the full SKD which is available in the [ESA SPICE FTP](ftp://spiftp.esac.esa.int/data/SPICE/ExoMarsRSP).


Installation
------------

In order to use Git to obtain the operational subset of the SKD, the user needs
to have Git installed. In addition, Git large file system (Git LFS) needs to be
installed it as well. Git LFS can be obtained [here](https://git-lfs.github.com/).

After activating Git LFS clone the repository with

    git clone

In order to run the SKD in SPICE outside of the mk directory of the Git
repository the user needs to modify the following the PATH_VALUE variable
of the meta-kernel:

    PATH_VALUES       = ( '..' )

It is recommended for users to make a local copy of this file and
modify the value of the PATH_VALUES keyword to point to the actual
location of the ExoMars2016 SPICE data set's 'data' directory on
their system. Replacing '/' with '\' and converting line
   terminators to the format native to the user's system may also be
   required if this meta-kernel is to be used on a non-UNIX workstation.

Finally please note that in order to use the SPICE kernels you need to install
your prefered SPICE Library. You can find instructions on how to install
SPICE [here](https://naif.jpl.nasa.gov/naif/toolkit.html)



Function and Purpose
--------------------

ESA has a number of science missions under development and in operation that are dedicated to the study of our Solar System (i.e. MEX, Rosetta, ExoMars, BepiColombo, Solar Orbiter and JUICE). The Science Operations Centres for these missions, located at the European Space Astronomy Centre (ESAC) in Spain, are responsible for all science operations planning, data processing and archiving tasks, being the essential interface between the science instruments and the spacecraft, and with the scientific community.

From the concept study phase to the day-to-day science operations, these missions produce and use auxiliary data (spacecraft orbital state information, attitude, event information and relevant spacecraft housekeeping data) to assist science planning, data processing, analysis and archiving.

Within the Solar System scientific community, the SPICE information system is the 'de facto' standard for auxiliary data handling and geometry computations, and has been adopted and is extensively used in ESA missions. SPICE is developed and maintained by the Navigation and Ancillary Information Facility (NAIF) of the Jet Propulsion Laboratory (JPL).

The SPICE format includes definitions for orbit, attitude and event information, and the data files describing these categories are called ‘SPICE kernels’. These kernels contain sufficient information to compute derived geometrical or positional values using the existing NAIF SPICE toolkit.

For ESA missions, there are three different sources of SPICE kernels:
* The spacecraft orbit (SPK), attitude (CK) and clock correlation (SCLK) kernels, produced regularly for each mission from Mission Analysis and Flight Dynamics products and spacecraft telemetry.
* Generic kernels, such as planetary constants (PCK), leap seconds (LSK) and ephemerides (SPK), mostly provided by NAIF
* Instrument kernels (IK) and the frames specification kernel (FK), created in collaboration with the Instruments Teams

The ExoMars2016 SKD is operational and therefore it is updated with kernels generated from the periodical trajectory and orientation updates and from the relevant information obtained from housekeeping telemetry. Some updates on Instrument and S/C models might occur responding to operational demands.


The SKD contain two different types of kernels:
* Setup kernels (STK) FK, IK, PCK, LSK: they are typically text files and they are developed by ESS and are reviewed and iterated with the SGS and with the Instrument Teams when need be during the whole duration of the mission. The STKs include the following information:
  *	Set of Reference Frames of interest for geometry computations.
  *	FoV and boresight modeling for science payload.
  *	Study trajectory default orientation for S/C.
  *	Physical models for natural bodies of the mission.
* Time-varying kernels (TVK) SPK, CK, SCLK, MK: are either text or binary files and are generated with the Auxiliary Data Conversion System (ADCSng) and the source data is provided by the Flight Dynamics in terms of OEMs, AEMs and Housekeeping TM data. The TVKs incude the following information:
  *	Predicted attitude and predicted/reconstructed trajectory.
  *	OBT to UTC/CAL time conversion.
  *	Reconstructed trajectory and measured orientation for S/C.
  *	Orientation of Solar Arrays and HGA (if applicable).
  *	Position of scans or turn-tables or articulations of payload.


Meta-kernel management
----------------------

Meta-kernel (MK) file management is a critical element of any SPICE dataset.
For ESA Planetary Missions the MKs of the operational SKDs
are also used to control the version of the SPICE dataset in the
ESA SPICE FTP server. In general missions in operations will have an
"operational" MK. This MK will contain the latest SPICE
kernels available for the mission including those kernels generated
by ADCSng in a periodical basis. Since the periodicity of this
updates ranges from hours to weeks, the MK in the Meta-Kernel
directory does not have a version number and is regularly
overwritten. Nevertheless in order to keep traceability and
backwards compatibility with former MKs, a duplicate of every
generated operational MK is stored. This duplicated MK filename is
appended with a time tag and a version that corresponds to the
extended version of the SKD.

Note that this duplicated MK is not available
in the Git repository.


Environmental Considerations
----------------------------

 At least a basic knowledge of the SPICE system is needed in order to
 use these kernels. The SPICE toolkit provides versions in Fortran
 (SPICELIB), C (CSPICE), IDL (icy), Matlab (mice) and Python (SpiceyPy),
 and the user can choose any one that suits him/her.

 The SPICELIB routine FURNSH, CSPICE function furnsh_c, icy routine
 cspice_furnsh and SpiceyPy routine furnsh load a kernel file into the
 kernel pool as shown below.

    CALL FURNSH  ( 'kernel_name' )
    furnsh_c     ( "kernel_name" );
    cspice_furnsh, 'kernel_name'
    cspice_funsh( 'kernel_name' );
    spiceypy.furnsh( 'kernel_name' )


Documentation
-------------

The HTML documentation for the ExoMars2016 SKD is available [here](misc/ExoMars2016.html).


How to Help
-----------

Please note that the ExoMars2016 SKD might contain bugs and is being constantly updated.
Feedback is always welcome. If you discover a blug please do not hesitate to contact the [ESA SPICE Service](marc.costa@esa.int).

kernels/aareadme.txt

0 → 100644
+101 −0
Original line number Original line Diff line number Diff line
+-----------------------------------------------------------------------------+
|                                                                             |
|  __   __   __      __   __     __   ___     __   ___  __          __   ___  |
| /__\ /__` '__\    /__` |__) | /  ` |__     /__` |__  |__) \  / | /  ` |__   |
| \__, .__/ \__/    .__/ |    | \__, |___    .__/ |___ |  \  \/  | \__, |___  |
|                                                                             |
|                                                                             |
+-----------------------------------------------------------------------------+     

Welcome to the operational ExoMars 2016 SPICE Kernel Dataset         
============================================================ 

     This directory contains the SPICE kernels Dataset generated for the 
     ExoMars 2016 mission.                                                       
                        
     See more details in:

       http://www.cosmos.esa.int/web/spice/spice-for-em16

     For more information on SPICE for ESA Planetary Missions, please go to

       http://www.cosmos.esa.int/web/spice                      

     For information on SPICE, please go to                                 
                                                                            
       http://naif.jpl.nasa.gov                                            
                                                                            
     For any question or suggestion on this site, please contact:        
                                                                                                   
       Marc Costa Sitja,       mcosta@sciops.esa.int
       ESA SPICE Service,      esa_spice@sciops.esa.int       
                                                             

Content of this directory                                               
--------------------------------------------------------               
                                                                                
     Each subdirectory within this directory contains all the kernels of     
     the same type that have been generated for the ExoMars2016 Mission.         
                                                                             
        ck:       Kernels that contain orientation for the spacecraft and    
                  some of its structures, (solar arrays, for instance).      
                                                                             
        fk:       Kernels that define reference frames needed for the        
                  Mission.                                                   
                                                                             
        ik:       Kernels for the instruments on board the spacecraft.       
                                                                             
        lsk:      Leapseconds kernel.   

        mk:       Meta-kernel files (a.k.a "furnsh" files) that provide 
                  lists of kernels suitable for a given mission period.   
                                                                             
        pck:      Kernels that define planetary constants.                   
                                                                             
        sclk:     Spacecraft clock coefficients kernels.                     
                                                                             
        spk:      Orbit kernels, for the spacecraft and other solar system   
                  bodies.                                                    
                                                                                                                                                                  

	   Please refer to the aareadme.txt in each of the subdirectories for 
     information on the contents for the specific type of kernels and the 
     corresponding naming conventions.       
                                                                                
                                                                                
Usage of the SPICE Kernels for ExoMars2016                               
--------------------------------------------------------              
                                                                                
     At least a basic knowledge of the SPICE system is needed in order to    
     use these kernels. The SPICE toolkit provides versions in Fortran       
     (SPICELIB), C (CSPICE), IDL (icy), Matlab (mice) and Python (SpiceyPy), 
     and the user can choose any one that suits him/her.                                      
                                                                             
     The SPICELIB routine FURNSH, CSPICE function furnsh_c, icy routine  
     cspice_furnsh and SpiceyPy routine furnsh load a kernel file into the 
     kernel pool as shown below.   
                                                                             
        CALL FURNSH  ( 'kernel_name' )                                       
        furnsh_c     ( "kernel_name" );                                      
        cspice_furnsh, 'kernel_name'                                         
        cspice_funsh( 'kernel_name' );
        spiceypy.furnsh( 'kernel_name' )                                       
                                                                             
     In the case when two or more files contain data overlapping in time     
     for a given object, for binary kernels, the file loaded last takes      
     precedence.                                                             
                                                                             
     If two (or more) text kernels assign value(s) using the '=' operator    
     to identical keywords, the data value(s) associated with the last       
     loaded occurrence of the keyword are used -all earlier values have      
     been replaced with the last loaded value(s).                            
                                                                                
                                                                                
-------------------                                                       
                                                                          
     This file was last modified on January 21, 2018 by Marc Costa Sitja.
     This file was created on January 20, 2016 by Marc Costa Sitja.


End of aareadme file.
 No newline at end of file
+163 −0
Original line number Original line Diff line number Diff line
ExoMars2016 CK files
===========================================================================

     This ``aareadme.txt'' file describes the contents of the kernels/ck
     directory of the ExoMars2016 SPICE data server.

     It was last modified on January 21, 2018 by Marc Costa Sitja, ESAC/ESA.

          
Brief Summary
--------------------------------------------------------

     This directory contains the SPICE C-Kernel files for the ExoMars2016
     TGO spacecraft, its structures, and science instruments. Particularly,
     it contains data for the following ExoMars 2016 TGO frames:
   
          Frame Name           Relative to            NAIF ID
         -------------------  -------------------    ---------
          TGO_SPACECRAFT      J2000                   -143000
        
          TGO_CASSIS_TEL      TGO_CASSIS_CRU          -143410
          TGO_NOMAD_LNO_SCAN  TGO_NOMAD_LNO_BASE      -143305 


File naming conventions
--------------------------------------------------------

   ExoMars 2016 spacecraft CK:
 
      The naming scheme for the ExoMars2016 spacecraft CKs is:
   
           em16_SC_INST_TYPE[_ID][_DESC]_YYYYMMDD_YYYYMMDD_SCLK_vNN.bc

      where
   
           SC       accronym of the spacecraft (required):
           
                       tgo: for the Trace Gas Orbiter (TGO) spacecraft;
                       edm: for the for the Schiaparelli (EDM) lander; 

           INST     instrument/structure/sensor identifier (required):
         
                       sc: for the TGO/EDM spacecraft frame;
                       cassis: for the CaSSIS Telescope frame;
                       nomad: for the NOMAD LNO Scanning mirror frame;

           TYPE      Data type, where a reference to the originator of the
                     data, the type of data and the and the reference period
                     is provided. This is a three letter acronym. The first
                     letter defines the file originator:
                    
                          s: Science Operations Center;
                          m: Mission Analysis;
                          f: Flight Dynamics;
                          i: Instrument Team;
                    
                     the second letter defines the reference period of the
                     data:
                          
                          c: Cruise phase reference;
                          p: Pre-aerobraking phase reference;
                          a: Aerobraking phase reference;
                          l: Science phase Long term reference;
                          m: Science phase Medium term reference;
                          s: Science phase Short term reference;       
                          o: Undefined reference;
             
                     the third letter indicates the type of data
                       
                          p: Predicted data;
                          m: Measured data;
                          r: Reconstructed data;
                          t: Test data;
                    
           ID        mapping to the original file product IDs as defined per
                     an ICD document (optional);
           
           DESC      description of the original reference file of any
                     particular of the original file (optional) e.g:

                          npo: Nadir Power-optimised s/c attitude;
                          noa: Nadir Orbit-aligned s/c attitude;
                          axis: Orientation of the spin axis of EDM;
                          spin: Angular velocity od the spin axis of EDM;
      
           YYYYMMDD  coverage start and stop times in TDB (required);
                 
           SCLK      reference to SCLK used to created the CK (required):
      
                         sYYYYMMDD: SCLK version YYMMDD for type ``step''
                         tYYYYMMDD: SCLK version YYMMDD for type ``stretch''
                         fYYYYMMDD: SCLK version YYMMDD for type ``fictional''
                    
           NN        CK version number -- 2 digits (required).


      See [5] for further details on the SCLK types available to ExoMars2016.

   If multiple versions of a C-Kernel file are provided, always use the latest 
   version (unless earlier version is needed for some special reasons.)


Other directory contents
--------------------------------------------------------

     aareadme.txt         This file.
   

Particulars
--------------------------------------------------------

     Nothing to report.

   
Kernel File Details
--------------------------------------------------------
   
     The most detailed description of the data in a binary CK file is
     provided in metadata included inside the comment area of the file.
     This information can be viewed using the utility programs COMMNT and
     SPACIT included in the NAIF Toolkit.


Contact Information
--------------------------------------------------------

     If you have any questions regarding this directory or its
     contents, please contact SPICE support at ESAC:

             Marc Costa Sitja
             (+34) 91-8131-457
             mcosta@sciops.esa.int, esa_spice@sciops.esa.int

     or SPICE support at IKI:

             Alexander Abbakumov
             +7 (495) 333-40-13
             aabbakumov@romance.iki.rssi.ru

     or NAIF at JPL:

             Boris Semenov
             (818) 354-8136
             Boris.Semenov@jpl.nasa.gov


References and required readings
--------------------------------------------------------

     1. ``Frames Required Reading'', NAIF Document

     2. ``C-Kernel Required Reading'', NAIF Document

     3. ``SCLK Required Reading'', NAIF Document

     4. ``TIME Required Reading'', NAIF Document

     5. ``ExoMars2016 SCLK file naming conventions,'' aareadme.txt file in
        kernels/sclk directory.


End of aareadme file.
 No newline at end of file