navsim
A Python satellite navigation simulator.
📝 Table of Contents
🚀 Our Mission
navsim was created to provide versatile simulation tools that can be used to facilitate positioning, navigation, and timing (PNT) research in Python.
We are still very much in development as features are being added on an as-needed basis. Feel free to request new features as an issue or see Contributing for instructions on adding your own tools.
🏁 Getting Started
navsim is fairly easy to get installed (if not submit an issue!). Currently, the package only exists in this repo as we are "pre-release". However, there are plans to distribute wheels on PyPI in the future. For now, read through the following instructions for getting started.
Prerequisites
Python 3.10-3.12 is required. We are currently working to make the package usable with Python 3.10 or greater.
Installation
- Clone navsim.
git clone https://github.com/tannerkoza/navsim.git- Install in a virtual environment or base Python (not recommended) using
pip.pip install navsim/
It's that simple! If you find yourself having trouble, please submit an issue.
🎈 Usage
So, how do we get started?
As we are "pre-release", there is currently no hosted documentation. However, much of the functionality can be seen in the examples folder. Also, most functions and classes should have docstrings explaining parameters and general functionality.
If you have any questions, feel free to submit an issue as we work on documentation.
✍️ Contributing
Feel free to fork and submit [pull requests]() for review! If you're interested in becoming a regular contributor, email me at kozatanner@gmail.com.
