JHUAPL/OpenXNAV
1
0
Fork 0
mirror of https://github.com/JHUAPL/OpenXNAV.git synced 2026-01-07 22:34:04 -05:00
Code Issues Packages Projects Releases Wiki Activity

updating docs

Browse Source
This commit is contained in:
Katie Zaback
2023-10-19 17:27:34 -04:00
parent e04ff96c1f
commit 67b88214c1
4 changed files with 178 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
docs/index.md
View File

@@ -11,20 +11,80 @@ hide:
*Open-source modular toolkit for simulating high-fidelity pulsar X-ray events.*
## **Introduction to OpenXNAV**
### **Introduction**
OpenXNAV is designed to aid development and testing of Pulsar-based Autonomous Navigation (XNAV) Positioning, Navigation, and Timing (PNT) solutions.
This tool is a flexible, cost-effective testbed to enable the next generation of XNAV solutions. OpenXNAV includes three modular components that allow engineers simulate high-fidelity pulsar X-ray events along a flight trajectory over a user-defined mission timeline. Hardware-in-the-loop functionality can be configured using software-defined radios (SDRs), and users can query for pulsar candidates using the query tool (powered by the [ATNF Pulsar Catalogue](https://www.atnf.csiro.au/research/pulsar/psrcat/)).
This is a flexible, cost-effective testbed to enable the next generation of XNAV solutions. OpenXNAV includes three modular components that allow engineers simulate high-fidelity pulsar X-ray events along a flight trajectory over a user-defined mission timeline.
<br />
For more information, you can read our [IEEE paper](https://ieeexplore.ieee.org/document/10139942).<br />
_Note: OpenXNAV was previously named Pulsar-Leveraged Autonomous Navigation Testbed System (PLANTS)_
## **Components**
### **Components**
* [Pulsar Querying](components/1__pulsar_querying/pq_overview.md)
* [Mission Planning](components/2__mission_planning/mp_overview.md)
* [Timing & Event Generation](components/3__custom_event_generation/ceg_overview.md)
* [Hardware In The Loop](components/3__custom_event_generation/ceg_overview.md#hardware-in-the-loop-sdrs)
<br />
Users can query for pulsar candidates using the query tool component (powered by the [ATNF Pulsar Catalogue](https://www.atnf.csiro.au/research/pulsar/psrcat/)). Mission planning for a desired trajectory can be done with our open-source mission planning tool, or via the commercial Ansys System Tool Kit (STK) if desired. X-Ray events can then be generated using our Timing & Event Generation component, and these pulses can (optionally) be simulated in hardware using software-defined radios (SDRs).
<br />
<br />
**For more information, you can read our [IEEE paper](https://ieeexplore.ieee.org/document/10139942).** <br />
<font color="#8a8a8a">_NOTE_: OpenXNAV was previously named Pulsar-Leveraged Autonomous Navigation Testbed System (PLANTS).</font>
<br />
<br />
---
### **Support**
If you have questions, suggestions, or require assistance with OpenXNAV, please email: **OpenXNAV@jhuapl.edu**
### **Authors**
This work was created by the following contributors, with funding from Johns Hopkins Applied Physics Lab:
| Contributor | Organization | Department/Sector |
| ----------- | ------------ | ----------------- |
| Sarah Hasnain | JHU-APL | Space Exploration Sector (SES) |
| Michael Berkson | JHU-APL | Research & Exploratory Development (REDD) |
| Sharon Maguire | JHU-APL | Air & Missile Defense Sector (AMDS) |
| Evan Sun | JHU-APL | Force Projection Sector (FPS) |
| Katie Zaback | JHU-APL | Air & Missile Defense Sector (AMDS) |
### **Cite This Work**
If you use any component of the OpenXNAV library, please include the following attribution statement: <br />
_`
This software derives from OpenXNAV (https://github.com/JHUAPL/OpenXNAV) software developed by The Johns Hopkins University Applied Physics Laboratory.
`_
<br />
<br />
You can also cite our IEEE paper: <br />
``` BibTeX title="Citation (BibTeX)"
@INPROCEEDINGS{10139942,
author={Hasnain, Sarah and Berkson, Michael and Maguire, Sharon and Sun, Evan and Zaback, Katie},
booktitle={2023 IEEE/ION Position, Location and Navigation Symposium (PLANS)},
title={Pulsar-Leveraged Autonomous Navigation Testbed System (PLANTS): A Low-Cost Software-Hardware Hybrid Testbed for Pulsar-based Autonomous Navigation (XNAV) Positioning, Navigation, and Timing (PNT) Solutions},
year={2023},
volume={},
number={},
pages={1286-1292},
doi={10.1109/PLANS53410.2023.10139942}}
```
<br />
### **<font color="#8a8a8a">License</font>**
<font color="#b3b3b3">
_© 2023 The Johns Hopkins University Applied Physics Laboratory LLC_
_Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)._
_Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License._
</font>

117
site/index.html
View File

@@ -377,8 +377,8 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#introduction-to-openxnav" class="md-nav__link">
Introduction to OpenXNAV
<a href="#introduction" class="md-nav__link">
Introduction
</a>
</li>
@@ -388,6 +388,34 @@
Components
</a>
</li>
<li class="md-nav__item">
<a href="#support" class="md-nav__link">
Support
</a>
</li>
<li class="md-nav__item">
<a href="#authors" class="md-nav__link">
Authors
</a>
</li>
<li class="md-nav__item">
<a href="#cite-this-work" class="md-nav__link">
Cite This Work
</a>
</li>
<li class="md-nav__item">
<a href="#license" class="md-nav__link">
License
</a>
</li>
</ul>
@@ -544,18 +572,91 @@
<p><img alt="OpenXNAV Logo" src="assets/images/logo/png/23-03611_OpenXNav_Color-full.png#only-light" width="50%" />
<img alt="OpenXNAV Logo" src="assets/images/logo/png/23-03611_OpenXNav_White-lightblue-full.png#only-dark" width="50%" /></p>
<p><em>Open-source modular toolkit for simulating high-fidelity pulsar X-ray events.</em> </p>
<h2 id="introduction-to-openxnav"><strong>Introduction to OpenXNAV</strong></h2>
<h3 id="introduction"><strong>Introduction</strong></h3>
<p>OpenXNAV is designed to aid development and testing of Pulsar-based Autonomous Navigation (XNAV) Positioning, Navigation, and Timing (PNT) solutions.</p>
<p>This tool is a flexible, cost-effective testbed to enable the next generation of XNAV solutions. OpenXNAV includes three modular components that allow engineers simulate high-fidelity pulsar X-ray events along a flight trajectory over a user-defined mission timeline. Hardware-in-the-loop functionality can be configured using software-defined radios (SDRs), and users can query for pulsar candidates using the query tool (powered by the <a href="https://www.atnf.csiro.au/research/pulsar/psrcat/">ATNF Pulsar Catalogue</a>). </p>
<p>For more information, you can read our <a href="https://ieeexplore.ieee.org/document/10139942">IEEE paper</a>.<br />
<em>Note: OpenXNAV was previously named Pulsar-Leveraged Autonomous Navigation Testbed System (PLANTS)</em></p>
<h2 id="components"><strong>Components</strong></h2>
<p>This is a flexible, cost-effective testbed to enable the next generation of XNAV solutions. OpenXNAV includes three modular components that allow engineers simulate high-fidelity pulsar X-ray events along a flight trajectory over a user-defined mission timeline.
<br /></p>
<h3 id="components"><strong>Components</strong></h3>
<ul>
<li><a href="components/1__pulsar_querying/pq_overview/">Pulsar Querying</a></li>
<li><a href="components/2__mission_planning/mp_overview/">Mission Planning</a></li>
<li><a href="components/3__custom_event_generation/ceg_overview/">Timing &amp; Event Generation</a></li>
<li><a href="components/3__custom_event_generation/ceg_overview/#hardware-in-the-loop-sdrs">Hardware In The Loop</a></li>
<li><a href="components/3__custom_event_generation/ceg_overview/#hardware-in-the-loop-sdrs">Hardware In The Loop</a>
<br /></li>
</ul>
<p>Users can query for pulsar candidates using the query tool component (powered by the <a href="https://www.atnf.csiro.au/research/pulsar/psrcat/">ATNF Pulsar Catalogue</a>). Mission planning for a desired trajectory can be done with our open-source mission planning tool, or via the commercial Ansys System Tool Kit (STK) if desired. X-Ray events can then be generated using our Timing &amp; Event Generation component, and these pulses can (optionally) be simulated in hardware using software-defined radios (SDRs).
<br />
<br /></p>
<p><strong>For more information, you can read our <a href="https://ieeexplore.ieee.org/document/10139942">IEEE paper</a>.</strong> <br />
<font color="#8a8a8a"><em>NOTE</em>: OpenXNAV was previously named Pulsar-Leveraged Autonomous Navigation Testbed System (PLANTS).</font></p>
<p><br />
<br /> </p>
<hr />
<h3 id="support"><strong>Support</strong></h3>
<p>If you have questions, suggestions, or require assistance with OpenXNAV, please email: <strong>OpenXNAV@jhuapl.edu</strong></p>
<h3 id="authors"><strong>Authors</strong></h3>
<p>This work was created by the following contributors, with funding from Johns Hopkins Applied Physics Lab:</p>
<table>
<thead>
<tr>
<th>Contributor</th>
<th>Organization</th>
<th>Department/Sector</th>
</tr>
</thead>
<tbody>
<tr>
<td>Sarah Hasnain</td>
<td>JHU-APL</td>
<td>Space Exploration Sector (SES)</td>
</tr>
<tr>
<td>Michael Berkson</td>
<td>JHU-APL</td>
<td>Research &amp; Exploratory Development (REDD)</td>
</tr>
<tr>
<td>Sharon Maguire</td>
<td>JHU-APL</td>
<td>Air &amp; Missile Defense Sector (AMDS)</td>
</tr>
<tr>
<td>Evan Sun</td>
<td>JHU-APL</td>
<td>Force Projection Sector (FPS)</td>
</tr>
<tr>
<td>Katie Zaback</td>
<td>JHU-APL</td>
<td>Air &amp; Missile Defense Sector (AMDS)</td>
</tr>
</tbody>
</table>
<h3 id="cite-this-work"><strong>Cite This Work</strong></h3>
<p>If you use any component of the OpenXNAV library, please include the following attribution statement: <br />
<em><code>This software derives from OpenXNAV (https://github.com/JHUAPL/OpenXNAV) software developed by The Johns Hopkins University Applied Physics Laboratory.</code></em>
<br />
<br />
You can also cite our IEEE paper: <br />
<div class="language-BibTeX highlight"><span class="filename">Citation (BibTeX)</span><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nc">@INPROCEEDINGS</span><span class="p">{</span><span class="nl">10139942</span><span class="p">,</span><span class="w"> </span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="na">author</span><span class="p">=</span><span class="s">{Hasnain, Sarah and Berkson, Michael and Maguire, Sharon and Sun, Evan and Zaback, Katie}</span><span class="p">,</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="na">booktitle</span><span class="p">=</span><span class="s">{2023 IEEE/ION Position, Location and Navigation Symposium (PLANS)}</span><span class="p">,</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="na">title</span><span class="p">=</span><span class="s">{Pulsar-Leveraged Autonomous Navigation Testbed System (PLANTS): A Low-Cost Software-Hardware Hybrid Testbed for Pulsar-based Autonomous Navigation (XNAV) Positioning, Navigation, and Timing (PNT) Solutions}</span><span class="p">,</span><span class="w"> </span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="na">year</span><span class="p">=</span><span class="s">{2023}</span><span class="p">,</span><span class="w"> </span>
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="na">volume</span><span class="p">=</span><span class="s">{}</span><span class="p">,</span><span class="w"> </span>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="na">number</span><span class="p">=</span><span class="s">{}</span><span class="p">,</span><span class="w"> </span>
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="na">pages</span><span class="p">=</span><span class="s">{1286-1292}</span><span class="p">,</span><span class="w"> </span>
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="na">doi</span><span class="p">=</span><span class="s">{10.1109/PLANS53410.2023.10139942}</span><span class="p">}</span>
</span></code></pre></div></p>
<p><br /> </p>
<h3 id="license"><strong><font color="#8a8a8a">License</font></strong></h3>
<p><font color="#b3b3b3">
<em>© 2023 The Johns Hopkins University Applied Physics Laboratory LLC</em></p>
<p><em>Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. You may obtain a copy of the License at <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>.</em></p>
<p><em>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.</em>
</font></p>

2
site/search/search_index.json
View File

File diff suppressed because one or more lines are too long

BIN
site/sitemap.xml.gz
View File

Binary file not shown.