Package: ccsds_ndm
DescriptionThe Consultative Committee for Space Data Systems (CCSDS) develops communications and data systems standards
for spaceflight.CCSDS Navigation Data Messages (NDM)is the set of file standards to define common data types such as trajectory, orbit, attitude and conjunction events.
These data types are routinely generated and exchanged within and between spacecraft operators, space agencies,
researchers, amateurs and commercial companies. As such, accurate definition and common interpretation of the data
is crucial (and sometimes mission-critical).The standard description for each data type is encapsulated in an XML Schema file. This projectccsds-ndmaims to
be the reference open-source Python implementation to read and write the NDM XML and KVN files, through an object tree
API, auto-generated by these schema files. It supports the up-to-date NDM XML 2.0.0 standard.The source code ison Githuband the documentation ison Readthedocs.Current functionality:ReadWriteXMLAll NDM TypesAll NDM TypesKVNAll except NDM Combined InstantiationAll except NDM Combined InstantiationJSONNot specified in CCSDS StandardsNot specified in CCSDS StandardsUsage and ExamplesThere are two use cases:Theccsds-ndmlibrary reads the NDM file, fills an object tree and offers it to the users. The users will then
have to fill their own attitude, orbit or trajectory objects used in their libraries.The user fills an object tree from their own attitude, orbit or trajectory object. Theccsds-ndmlibrary
writes the NDM file using this object tree.For the first use case, reading an OEM file fromxml_read_pathis as simple as:>>> cdm = NdmIo().from_path(xml_read_path)Note that file format (XML or KVN) and data type (e.g. CDM or NDM) are inferred automatically.
The outputcdmis the object tree for a Conjunction Data Message (CDM). The contents can then be reached
going deeper in the object tree as specified in the corresponding NDM Standard. This example shows how to reach the
orbit normal position component of the relative state vector:>>> print(cdm.body.relative_metadata_data.relative_state_vector.relative_position_n)The data can sometimes be of type NDM Combined Instantiation. This means that there are multiple NDM data bodies
(e.g. 2 AEMs, 3 OEMs and one OMM) within a single file. The file reader supports these types as well and they are
kept within theNdmobject as individual lists for each of the file types. The following example retrieves the
secondOmmobject in the NDM file and then continues to dive deeper into the object tree to retrieve the
eccentricity value.>>> print(ndm.omm[1].body.segment.data.mean_elements.eccentricity)If the file is of the type NDM Combined Instantiation but there is only a single data (e.g. OMM) in it,
the ndm tags are stripped and only the single data is presented to the user.Filling the objects with data properly requires some care. As the standard is understandably strict, the
object tree derived from the XSD files are also rather exacting in how they accept data. The recommended
way to fill the objects is with value and unit information:>>> # This is the proper way to write data into the object
>>> cdm.body.relative_metadata_data.relative_state_vector.relative_position_t = LengthType(Decimal(800), LengthUnits.M)Finally, once filled with the relevant data, thecdmobject can be written toxml_write_pathin XML data format as:>>> NdmIo().to_file(cdm, NDMFileFormats.XML, xml_write_path)Thendmobject trees are not very user friendly and most probably will have to be filled by the users’
own equivalent objects (trajectory, orbit, attitude etc.).Installingccsds-ndmTheccsds-ndmpackage is onPyPIand you can install it simply by running:pip install ccsds_ndmYou can also install it viaconda-forge:conda install -c conda-forge ccsds_ndmDo not installccsds-ndmusingsudo.More Information Regarding the CCSDS-NDMThe top-level description of the standard is given in theNavigation Data — Definitions and Conventions Green BookandNavigation Data Messages Overview Green Book. Individual data types are
defined in their individual definitions (e.g.Conjunction Data MessageandOrbit Data Message). The centre for all the standards areCCSDS Mission Operations and Information Management Services Area.The Schema files are found in theSANA Registry.Design and LimitationsThe object tree is created byxsdatalibrary, which also handles parsing
and writing of the XML data. As such, there is no documentation generated for this object tree.File read is usually fast (on the order of seconds) for small files. That said, KVN parsing for large files can
take some time. A 12 MB OEM file lasts about a minute to parse on a good consumer grade computer.
Due to the fragility of the KVN format and the restrictions the standards put on the order of keys, no
parallelization has been attempted.RequirementsxsDatais used to read and write XML files (and also to generate the object tree)lxmlto support XML object creationCitationPlease use the DOI for citations. This is the latest version:LicenseThis project is Copyright (c) Egemen Imre and licensed under
the terms of the GNU GPL v3+ license.