Data

Tools

Indexes

Applications

Experiments

Open Source Science

skadipy

https://github.com/incebellipipo/skadipy

Science Score: 57.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
    Found 4 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: incebellipipo
  • License: gpl-3.0
  • Language: Jupyter Notebook
  • Default Branch: master
  • Size: 37.5 MB
Statistics
  • Stars: 2
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 1
Created over 2 years ago · Last pushed 12 months ago
Metadata Files
Readme License Citation

README.md

Python package

SkadiPy

A python library for solving the control allocation problem for marine craft with different types of actuators and control allocation methods.

Installation

Pip

  1. Install the package using git from the master branch using

    bash pip install git+https://github.com/incebellipipo/skadipy.git@master

  2. Test the installation bash python -c "import skadipy; print(skadipy.__version__)"

Virtual Environment

  1. Clone the package and create a virtual environment. bash python -m venv venv

  2. Activate that virtual environment. It would change depending on the OS. On Linux or Mac bash source venv/bin/activate or on Windows powershell venv\Scripts\activate

  3. Install package dependencies bash pip install -r requirements.txt

    Install packages if you wish to run notebooks bash pip install -r requirements.examples.txt From now on you should be able to run the notebooks and see the results.

  4. Install the package bash pip install -e .

  5. Test the installation bash python -c "import skadipy; print(skadipy.__version__)"

    If it doesn't throw any error, the installation was successful.

Directory Structure

  • src: Source code for the library
  • tests: Unit tests for the library
  • examples: Examples of how to use the library
  • notebooks: Jupyter notebooks for the library showing examples and documentation.
  • docs: Documentation for the library
  • bin: Scripts for running the library

Citation

If you use this work, pleae cite the following

bibtex @article{GEZER2024374, title = {Maneuvering-based Dynamic Thrust Allocation for Fully-Actuated Vessels}, journal = {IFAC-PapersOnLine}, volume = {58}, number = {20}, pages = {374-379}, year = {2024}, note = {15th IFAC Conference on Control Applications in Marine Systems, Robotics and Vehicles CAMS 2024}, issn = {2405-8963}, doi = {https://doi.org/10.1016/j.ifacol.2024.10.082}, url = {https://doi.org/10.1016/j.ifacol.2024.10.082}, author = {Emir Cem Gezer and Roger Skjetne}, keywords = {Thrust allocation, Control Allocation, Maneuvering theory, Dynamic Positioning, Nonlinear Control, Control Barrier Functions, Ocean Engineering} }

Acknowledgements

Work funded by the Research Council of Norway (RCN) through NTNU AMOS (RCN project 223254), SFI AutoShip (RCN project 309230), and the Polish National Centre for Research and Development through the ENDURE project (NOR/POLNOR/ENDURE/0019/2019-00).

Owner

  • Name: Emir Cem Gezer
  • Login: incebellipipo
  • Kind: user
  • Location: Trondheim, Norway
  • Company: NTNU: Norwegian University of Science and Technology

I build robots. I program linux. I play instruments. I do stuff, I guess...

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this work, please cite it as below."
preferred-citation:
  type: conference-paper
  title: "Maneuvering-based Dynamic Thrust Allocation for Fully-Actuated Vessels"
  authors:
    - family-names: "Gezer"
      given-names: "Emir Cem"
    - family-names: "Skjetne"
      given-names: "Roger"
  year: 2024
  conference: "15th IFAC Conference on Control Applications in Marine Systems, Robotics and Vehicles (CAMS 2024)"
  publisher: "IFAC-PapersOnLine"
  volume: 58
  issue: 20
  pages: "374-379"
  doi: "https://doi.org/10.1016/j.ifacol.2024.10.082"
  url: "https://www.sciencedirect.com/science/article/pii/S2405896324018378"
  keywords:
    - "Thrust allocation"
    - "Control Allocation"
    - "Maneuvering theory"
    - "Dynamic Positioning"
    - "Nonlinear Control"
    - "Control Barrier Functions"
    - "Ocean Engineering"

GitHub Events

Total
  • Watch event: 2
  • Push event: 8
  • Fork event: 1
Last Year
  • Watch event: 2
  • Push event: 8
  • Fork event: 1

Dependencies

.github/workflows/run_test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
requirements.examples.txt pypi
  • ipywidgets *
  • matplotlib *
  • pandas *
requirements.txt pypi
  • numpy *
  • pyquaternion *
  • qpsolvers *
  • scipy *
  • shapely *