Skip to main content

Python scripts for the alignment of scanning lidars in offshore (and onshore) environements

Project description

Lidalign Python Package

Welcome to the Lidalign Python package! This package contains some python scripts for the alignment and pointing calibration of scanning wind lidars offshore!

Installation procedure

Mainly, the package contains python code for the following lidar alignment actions:

  • North alignment using azimuth hard target mapping see Rott et al. 2022
  • External Lidar alignment (pitch/roll) determination using Sea-Surface Leveling (SSL) see Rott et al. 2022
  • Determination of a static elevation offset from Sea-Surface Calibration (SSC) --> publication currently in the making (and see Gramitzky et al. 2025)
  • Scripts for the evaluation and visualisation of conventional hard target mapping

We do not claim full completeness and hope for contributions from the community.

The work is heavily based on previous work by Rott et al.22, which can be found in this zenodo repository.

Documentation:

For the documentation of the code and some examples, see the HTML docs of lidalign. This includes:

Experimental Validation of the SSC:

Also the experimental validation of Meyer et al. 2026 is documented as HTML version of the jupyter notebooks.

How to use:

For the installation, we recommend the use of Astral uv, a fast python package manager. Alternatively, you can replace the uv pip commands with python -m pip in the following.

Installation for direct use

Installation of the package (including the codes for the evaluation for the publication) is possible through:

uv pip install "uv pip install git+https://github.com/PaMeAn/lidalign.git"

Development

If you want to develop the packages, clone the repository first:

git clone https://github.com/PaMeAn/lidalign.git

and then install editable:

cd lidalign
uv pip install -e .

or

uv pip install -e .[dev]

The "-e" indicates, the package is editable, so scripts can be changed and updated. If you do not plan to contribute, you can install without -e.

How to cite

If used, please cite with the following:

Meyer, P. J., Rott, A., Seifert, J. K., & Schneemann, J. (2026). Lidalign python package (V.2.0). Zenodo. https://doi.org/10.5281/zenodo.19056909

The general work please cite with:

Meyer, P., Rott, A., Schneemann, J., Gramitzky, K., Pauscher, L., & Kühn, M. (2026). Experimental validation of the Sea-Surface-Calibration for scanning lidar static elevation offset determination, J. Phys.: Conf. Ser. 3224 022049, https://doi.org./10.1088/1742-6596/3224/2/022049.

and

Rott, A., Schneemann, J., Theuer, F., Trujillo Quintero, J. J., & Kühn, M. (2022). Alignment of scanning lidars in offshore wind farms. Wind Energy Science, 7(1), 283–297. https://doi.org/10.5194/wes-7-283-2022

Contributing

If you made edits, please create branches and create merge requests, so the code keeps developing! If you find issues or you are missing functionalities, let us know in the issues!

We are happy about any feedback!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lidalign-2.0.1.tar.gz (43.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lidalign-2.0.1-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

Details for the file lidalign-2.0.1.tar.gz.

File metadata

  • Download URL: lidalign-2.0.1.tar.gz
  • Upload date:
  • Size: 43.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for lidalign-2.0.1.tar.gz
Algorithm Hash digest
SHA256 d84580095258da5e58b6af0b4117da6b7ff8c50e8f26fd40566b622441c00f61
MD5 3a20a118491fb28c527ada2a9355b7f2
BLAKE2b-256 93bf5172fe03933bbd92ffda519675786dada8435ebba6d3d03ccb0867c828b0

See more details on using hashes here.

File details

Details for the file lidalign-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: lidalign-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 43.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for lidalign-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eaf0ce5c57e371115c542e26aee01f91ba50fcbeb8ca30ffe15d5564e16374da
MD5 2bfd8b694859cb448d6899154aaabcce
BLAKE2b-256 016248512a4d5118ca6b505d3712a5af3dee67785d36223bf8168f6d52e96792

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page