indiflight-log-tools 0.3.0__tar.gz

indiflight_log_tools-0.3.0/MANIFEST.in

@@ -0,0 +1,2 @@
+graft indiflight_log_tools/blackbox-tools/src
+include LICENSE README.md

indiflight_log_tools-0.3.0/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: indiflight_log_tools
+Version: 0.3.0
+Summary: Import Indiflight BFL logs fast and in correct units.
+Author-email: Till Blaha <t.m.blaha@tudelft.nl>
+Project-URL: Repository, https://github.com/tudelft/indiflight
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: C
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Requires-Dist: pandas>=2.0
+Requires-Dist: scipy>=1.10
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: platformdirs>=3.0
+Provides-Extra: rerun
+Requires-Dist: rerun-sdk; extra == "rerun"
+Dynamic: license-file
+
+
+
+## Installation
+
+Once published on PyPI (prebuilt wheels for Linux x86_64/aarch64 and macOS,
+any Python >= 3.10, no compiler needed):
+```
+pip install indiflight_log_tools            # add [rerun] for bfl2rerun
+```
+
+From the git repo (compiles the C decoder, so needs `gcc`/`clang`):
+```
+pip install "git+https://github.com/tudelft/indiflight#subdirectory=support/LogAnalysis/indiflight_log_tools"
+```
+
+From a local checkout (`-e` for development):
+```
+pip install -e support/LogAnalysis/indiflight_log_tools
+```
+
+Test it
+```
+cd ~/    # or anywhere else, but not the source folder
+python -c "from indiflight_log_tools import IndiflightLog; print(IndiflightLog.LIBRARY_SO)"
+```
+
+### Releasing
+
+Bump `version` in `pyproject.toml`, then push a tag `log-tools-v<version>`.
+`.github/workflows/log-tools-wheels.yml` builds the wheels and uploads them to PyPI.
+
+## Usage
+
+```
+from indiflight_log_tools import IndiflightLog
+
+log = IndiflightLog("/path/to/log.bfl", logId=3)                                  # if multiple logs in the same logfile, use this to select the one you want. default 1
+log = IndiflightLog("/path/to/log.bfl", resetTime=False)                          # resetTime maintains the flight controller time as the time basis in the dataframe (default True)
+log = IndiflightLog("/path/to/log.bfl", resetTime=False, timeRange=(1000, 3000))  # crop the data to timeRange (given in ms)
+
+log.raw                                                                           # pandas dataframe in raw units
+log.data                                                                          # pandas dataframe in SI units
+log.modeToText(log.data["flightModeFlags"])                                       # convert flight mode flag(s) into human-readable format
+log.flags                                                                         # flight mode changes with timestamp
+[(t, log.modeToText(x), log.modeToText(y)) for t, x, y in zip(log.flags["timeUs"], log.flags["enable"], log.flags["disable"])] # flight mode changes in human readable format
+
+log.outputCsv("raw")                                                              # output raw data as csv, comparable to outputting from BB log explorer
+log.outputCsv("si")                                                               # output SI data as csv
+log.outputCsv("si", path="my/path/for/logOutput/")                                # output SI data into a specific path
+
+log.addToRerun(name="BFL", clockOffsetSeconds=0.)                                 # send data Rerun (does not do init, connect, etc. just adding data)
+```
+
+There are also command line tools you can use after installing the wheel:
+```
+$ bfl2csv --help     # shorthand for the log.outputCsv() above
+$ bfl2rerun --help   # shorthand for the log.addToRerun() above
+```

indiflight_log_tools-0.3.0/README.md

@@ -0,0 +1,58 @@
+
+
+## Installation
+
+Once published on PyPI (prebuilt wheels for Linux x86_64/aarch64 and macOS,
+any Python >= 3.10, no compiler needed):
+```
+pip install indiflight_log_tools            # add [rerun] for bfl2rerun
+```
+
+From the git repo (compiles the C decoder, so needs `gcc`/`clang`):
+```
+pip install "git+https://github.com/tudelft/indiflight#subdirectory=support/LogAnalysis/indiflight_log_tools"
+```
+
+From a local checkout (`-e` for development):
+```
+pip install -e support/LogAnalysis/indiflight_log_tools
+```
+
+Test it
+```
+cd ~/    # or anywhere else, but not the source folder
+python -c "from indiflight_log_tools import IndiflightLog; print(IndiflightLog.LIBRARY_SO)"
+```
+
+### Releasing
+
+Bump `version` in `pyproject.toml`, then push a tag `log-tools-v<version>`.
+`.github/workflows/log-tools-wheels.yml` builds the wheels and uploads them to PyPI.
+
+## Usage
+
+```
+from indiflight_log_tools import IndiflightLog
+
+log = IndiflightLog("/path/to/log.bfl", logId=3)                                  # if multiple logs in the same logfile, use this to select the one you want. default 1
+log = IndiflightLog("/path/to/log.bfl", resetTime=False)                          # resetTime maintains the flight controller time as the time basis in the dataframe (default True)
+log = IndiflightLog("/path/to/log.bfl", resetTime=False, timeRange=(1000, 3000))  # crop the data to timeRange (given in ms)
+
+log.raw                                                                           # pandas dataframe in raw units
+log.data                                                                          # pandas dataframe in SI units
+log.modeToText(log.data["flightModeFlags"])                                       # convert flight mode flag(s) into human-readable format
+log.flags                                                                         # flight mode changes with timestamp
+[(t, log.modeToText(x), log.modeToText(y)) for t, x, y in zip(log.flags["timeUs"], log.flags["enable"], log.flags["disable"])] # flight mode changes in human readable format
+
+log.outputCsv("raw")                                                              # output raw data as csv, comparable to outputting from BB log explorer
+log.outputCsv("si")                                                               # output SI data as csv
+log.outputCsv("si", path="my/path/for/logOutput/")                                # output SI data into a specific path
+
+log.addToRerun(name="BFL", clockOffsetSeconds=0.)                                 # send data Rerun (does not do init, connect, etc. just adding data)
+```
+
+There are also command line tools you can use after installing the wheel:
+```
+$ bfl2csv --help     # shorthand for the log.outputCsv() above
+$ bfl2rerun --help   # shorthand for the log.addToRerun() above
+```

indiflight_log_tools-0.3.0/indiflight_log_tools/__init__.py

@@ -0,0 +1,17 @@
+# Copyright 2024 Till Blaha (Delft University of Technology)
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option)
+# any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program. If not, see <https://www.gnu.org/licenses/>.
+
+
+from .indiflight_log_importer import IndiflightLog