Skip to content

Get started

InertialSim is a Python library that supports development of advanced motion tracking applications by simulating inertial sensors. If you're familiar with Python, you can install InertialSim with pip, the Python package manager. See below.

Alternatively you can use a modern package manager like uv, which is used internally in InertialSim development and testing.

Licensing

InertialSim is commercial software and requires a license to access. If you are interested, get in touch at info@inertialsim.com!

Versions

InertialSim follows the semantic versioning standard: major.minor.patch. The latest version can be found here.

Install

Virtual environments

It is best practice and highly recommended to use a Python virtual environment or tool like venv, virtualenv, or pipx for testing.

Depending on your access and use case, you can install in one of the following ways:

pip install git+ssh://github.com/inertialsim/inertialsim.git 

pip install --extra-index-url=https://USER:TOKEN@URL inertialsim # (1)!
  1. Where USER, TOKEN are credentials and URL is a private package index that will be supplied.

Install options

InertialSim can be installed with any of the following extras:

pip install "inertialsim[plot]"
pip install "inertialsim[examples]"

The [plot] extra includes dependencies necessary to use the inertialsim.plot module. The [examples] extra includes dependencies to run the interactive notebooks in the companion inertialsim/examples repository.

Next steps

From here you may wish to look at the Reference pages for useful preliminaries. They detail InertialSim's fundamental software and mathematical conventions. The Examples pages provide end to end examples that can bootstrap other applications. All examples are also available as interactive notebooks in the source code. The API reference contains detailed documentation of all public interfaces provided in the source code.