Data

Tools

Indexes

Applications

Experiments

Open Source Science

flightmodels

Glider flight models to operation on OG1 format glider data.

https://github.com/eleanorfrajka/flightmodels

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Glider flight models to operation on OG1 format glider data.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created 11 months ago · Last pushed 10 months ago
Metadata Files
Readme Contributing License Citation

README.md

flightmodels

This is a starting point for thinking about running glider flight models on data in OG1 format.

📘 Documentation is available at: 👉 https://eleanorfrajka.github.io/flightmodels/

Originating from conversations associated with the "vertical velocities" group at OceanGlidersCommunity. If/when this package is in good shape, it could be transferred to http://github.com/OceanGlidersCommunity or some other relevant organisation.

🚀 What's Included

  • ✅ Python package layout: flightmodels/*.py
  • 📓 Jupyter notebook demo: notebooks/demo.ipynb
  • 📄 Markdown and Sphinx-based documentation in docs/
  • 🔍 Tests with pytest in tests/, CI with GitHub Actions
  • 🎨 Code style via black, ruff, pre-commit
  • 📦 Package config via pyproject.toml + optional PyPI release workflow
  • 🧾 Machine-readable citation: CITATION.cff

🔧 Quickstart

Install in development mode:

bash git clone https://github.com/eleanorfrajka/flightmodels.git cd flightmodels python -m venv venv # if you manage environments with venv source venv/bin/activate # if you manage environments with venv pip install -r requirements-dev.txt pip install -e .

To run tests:

bash pytest

To build the documentation locally:

bash cd docs make html

🤝 Contributing

Contributions are welcome! Please also consider adding an issue when something isn't clear.

Future plans

Incorporate flight models based on FW2011 (to be added, matlab based) and the Seaglider basestation designed to run on Seaglider data, and from Lucas Merckelbach's gliderflight designed to run on Slocum data.

Owner

  • Name: Eleanor Frajka-Williams
  • Login: eleanorfrajka
  • Kind: user
  • Location: Hamburg
  • Company: Universität Hamburg

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "This is just a demo of CITATION.cff.  You do not need to cite this software."
authors:
- family-names: Frajka-Williams
  given-names: Eleanor
  orcid: https://orcid.org/0000-0001-8773-7838
  affiliation: University of Hamburg, Bundesstraße 53, 20146 Hamburg, Germany
title: flightmodels
version: 0.0.0
date-released: 2025-04-20
url: https://github.com/eleanorfrajka/flightmodels

GitHub Events

Total
  • Issue comment event: 2
  • Push event: 8
  • Pull request event: 4
  • Create event: 4
Last Year
  • Issue comment event: 2
  • Push event: 8
  • Pull request event: 4
  • Create event: 4

Dependencies

.github/workflows/docs.yml actions
  • actions/checkout v4 composite
  • mamba-org/setup-micromamba v2.0.1 composite
.github/workflows/docs_deploy.yml actions
  • actions/checkout v4 composite
  • mamba-org/setup-micromamba v2.0.1 composite
  • peaceiris/actions-gh-pages v4 composite
.github/workflows/pypi.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/tests.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v2 composite
pyproject.toml pypi
requirements-dev.txt pypi
  • black >=24.0 development
  • codespell * development
  • gsw >=3.6.16 development
  • jupyterlab >=4.0 development
  • matplotlib >=3.7 development
  • myst-nb >=1.0 development
  • nbconvert >=7.8 development
  • nbsphinx >=0.9 development
  • netcdf4 >=1.6 development
  • numpy >=1.23 development
  • pandas >=2.0 development
  • pre-commit >=3.5 development
  • pypandoc >=1.11 development
  • pytest >=8.0 development
  • pytest-cov >=4.1 development
  • ruff >=0.3 development
  • scipy >=1.10 development
  • sphinx >=7.2 development
  • sphinx-rtd-theme >=2.0 development
  • xarray >=2023.12.0 development
requirements.txt pypi
  • gsw >=3.6.16
  • matplotlib >=3.7
  • netcdf4 >=1.6
  • numpy >=1.23
  • pandas >=2.0
  • scipy >=1.10
  • xarray >=2023.12.0