Data

Tools

Indexes

Applications

Experiments

Open Source Science

wec_as_multiport

WEC as a multi-port

https://github.com/sandialabs/wec_as_multiport

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 (13.8%) to scientific vocabulary

Keywords

scr-3129 snl-applications
Last synced: 6 months ago · JSON representation ·

Repository

WEC as a multi-port

Basic Info
  • Host: GitHub
  • Owner: sandialabs
  • License: gpl-3.0
  • Language: TeX
  • Default Branch: main
  • Homepage:
  • Size: 8.23 MB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
scr-3129 snl-applications
Created 8 months ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

WEC as a multi-port

Modeling wave energy converters (WECs) using a multi-port network framework

Goals

  • Consistent and correct conventions
  • More explanation, details, and examples than previously published papers
  • Publish this repository with the paper

Structure

wec_as_multiport
├── tests: testing using pytest
├── papers: LaTeX source and plotting scripts
└── wec_as_multiport: Python package

LaTeX

This repo uses actions to compile PDFs from the LaTex source and deploy those PDFs to its build branch

  • Edit the paper: edit the LaTex source (do not commit the PDF to the git repo, it is compiled by GitHub Automation)
    • use "XX" to make a comment
    • line break after each sentence
    • use "\," for a small space between a value and unit (e.g., "5\,m")
    • to refer to a figure, use “\figurename~\ref{fig:fig_label}”
    • to refer to a table, use “Table~\ref{tab:tab_label}”
    • use the subequations environment when possible if you have multiple equations you're presenting together
    • plots should not generally have titles as this information is captured in the figure caption
    • use PDF vector figures when possible
  • Edit diagrams: edit the PDF files using IPE
  • Update plots:
    1. Edit python notebooks
    2. Output vector PDFs to gfx directory

Python

  1. Install wec_as_multiport package (assuming you have conda or mamba)
    1. Create environment: conda create -n wam pip "python=3.11"
    2. Activate environment: conda activate wam
    3. Install package in editable mode (from within the root directory of this repository): pip install -e .
  2. Run/edit
    • source: core.py
    • plotting scripts: see .ipynb files
  3. Output figures to gfx directory for inclusion in paper

Owner

  • Name: Sandia National Laboratories
  • Login: sandialabs
  • Kind: organization
  • Location: United States

Exceptional service in the national interest.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: wec_as_multiport
message: "If you use this software, please cite the paper from preferred-citation."
type: software
authors:
  - given-names: "Ryan G."
    family-names: Coe
    orcid: "https://orcid.org/0000-0003-0738-3772"
  - given-names: Giorgio
    family-names: Bacelli
    orcid: "https://orcid.org/0000-0002-1208-2352"
  - given-names: "Daniel T."
    family-names: Gaebele
    orcid: "https://orcid.org/0000-0002-1209-0715"
  - given-names: Alicia
    family-names: Keow
    orcid: "https://orcid.org/0000-0002-6656-594X"
  - given-names: Dominic
    family-names: Forbush
    orcid: "https://orcid.org/0000-0001-8994-7257"
preferred-citation:
 type: article
 title: "Co-design of a wave energy converter through bi-conjugate impedance matching"
 year: 2025
 journal: "Mechatronics"
 doi: "10.1016/j.mechatronics.2025.103395"
 url: "https://www.sciencedirect.com/science/article/pii/S0957415825001047"
 volume: 111
 pages: 103395
 authors:
  - given-names: "Ryan G."
    family-names: Coe
    orcid: "https://orcid.org/0000-0003-0738-3772"
  - given-names: Giorgio
    family-names: Bacelli
    orcid: "https://orcid.org/0000-0002-1208-2352"
  - given-names: Daniel
    family-names: Gaebele
    orcid: "https://orcid.org/0000-0002-1209-0715"
  - given-names: Alicia
    family-names: Keow
    orcid: "https://orcid.org/0000-0002-6656-594X"
  - given-names: Dominic
    family-names: Forbush
    orcid: "https://orcid.org/0000-0001-8994-7257"

GitHub Events

Total
  • Watch event: 1
  • Member event: 2
  • Push event: 2
  • Create event: 1
Last Year
  • Watch event: 1
  • Member event: 2
  • Push event: 2
  • Create event: 1

Dependencies

.github/workflows/python-app.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • peaceiris/actions-gh-pages v3 composite
  • xu-cheng/latex-action v3 composite
environment.yml pypi
  • appnope ==0.1.4
  • asttokens ==2.4.1
  • attrs ==23.2.0
  • autograd ==1.6.2
  • beautifulsoup4 ==4.12.3
  • bleach ==6.1.0
  • capytaine ==2.1
  • certifi ==2024.6.2
  • cftime ==1.6.4
  • click ==8.1.7
  • cloudpickle ==3.0.0
  • comm ==0.2.2
  • contourpy ==1.2.1
  • cycler ==0.12.1
  • dask ==2024.6.2
  • debugpy ==1.8.2
  • decorator ==5.1.1
  • defusedxml ==0.7.1
  • executing ==2.0.1
  • fastjsonschema ==2.20.0
  • fonttools ==4.53.0
  • fsspec ==2024.6.1
  • future ==1.0.0
  • gmsh ==4.13.1
  • importlib-metadata ==8.0.0
  • iniconfig ==2.0.0
  • ipykernel ==6.29.4
  • ipython ==8.25.0
  • ipywidgets ==8.1.3
  • jedi ==0.19.1
  • jinja2 ==3.1.4
  • joblib ==1.4.2
  • jsonschema ==4.22.0
  • jsonschema-specifications ==2023.12.1
  • jupyter-client ==8.6.2
  • jupyter-core ==5.7.2
  • jupyterlab-pygments ==0.3.0
  • jupyterlab-widgets ==3.0.11
  • kiwisolver ==1.4.5
  • locket ==1.0.0
  • markdown-it-py ==3.0.0
  • markupsafe ==2.1.5
  • matlabengine ==24.1.2
  • matplotlib ==3.9.0
  • matplotlib-inline ==0.1.7
  • mdurl ==0.1.2
  • meshio ==5.3.5
  • mistune ==3.0.2
  • nbclient ==0.10.0
  • nbconvert ==7.16.4
  • nbformat ==5.10.4
  • nest-asyncio ==1.6.0
  • netcdf4 ==1.7.1.post1
  • numpy ==1.26.4
  • packaging ==24.1
  • pandas ==2.2.2
  • pandocfilters ==1.5.1
  • parso ==0.8.4
  • partd ==1.4.2
  • pexpect ==4.9.0
  • pillow ==10.3.0
  • platformdirs ==4.2.2
  • pluggy ==1.5.0
  • prompt-toolkit ==3.0.47
  • psutil ==6.0.0
  • ptyprocess ==0.7.0
  • pure-eval ==0.2.2
  • pygments ==2.18.0
  • pygmsh ==7.1.17
  • pyparsing ==3.1.2
  • pytest ==8.2.2
  • python-dateutil ==2.9.0.post0
  • pytz ==2024.1
  • pyyaml ==6.0.1
  • pyzmq ==26.0.3
  • referencing ==0.35.1
  • rich ==13.7.1
  • rpds-py ==0.18.1
  • scipy ==1.14.0
  • six ==1.16.0
  • sortedcontainers ==2.4.0
  • soupsieve ==2.5
  • stack-data ==0.6.3
  • tinycss2 ==1.3.0
  • toolz ==0.12.1
  • tornado ==6.4.1
  • traitlets ==5.14.3
  • typing-extensions ==4.12.2
  • tzdata ==2024.1
  • wavespectra ==4.0.3
  • wcwidth ==0.2.13
  • webencodings ==0.5.1
  • wec-as-multiport ==0.0.1
  • wecopttool ==2.7.0
  • widgetsnbextension ==4.0.11
  • xarray ==2024.6.0
  • zipp ==3.19.2
pyproject.toml pypi
  • autograd *
  • capytaine >=2.2
  • fpdf *
  • ipykernel *
  • ipython *
  • ipywidgets *
  • joblib *
  • nbconvert *
  • netcdf4 *
  • numpy >=1.20, <2.0
  • pytest *
  • scipy *
  • wavespectra >=3.13
  • wecopttool [geometry]<=3.0
  • xarray ==2025.3.1
setup.py pypi