template-matlab

https://github.com/awegroup/template-matlab

Science Score: 52.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
Organization awegroup has institutional domain (kitepower.tudelft.nl)
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (10.1%) to scientific vocabulary

Last synced: 10 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: awegroup
License: mit
Language: MATLAB
Default Branch: main
Size: 1.59 MB

Statistics

Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Releases: 0

Created almost 2 years ago · Last pushed almost 2 years ago

Metadata Files

Readme License Citation

README.md

[PROJECT NAME]

Generic MATLAB template for the AWE Group.

:gear: Installation

User Installation

Please check the file MATLAB_ADDONS.txt for the required dependencies.

Developer Installation

Sphinx Dependencies, see requirements

:eyes: Usage example

```matlab clear all

data = loaddata('data/userinput.yml')

result = process_data(data)

save_result(result, 'results/result.png')

```

:wave: Contributing (optional)

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

:warning: License and Waiver

Specify the license under which your software is distributed, and include the copyright notice:

Technische Universiteit Delft hereby disclaims all copyright interest in the program “NAME PROGRAM” (one line description of the content or function) written by the Author(s).

Prof.dr. H.G.C. (Henri) Werij, Dean of Aerospace Engineering

Copyright (c) [YEAR] [NAME SURNAME].

By default, the MIT license is included.

:gem: Help and Documentation

AWE Group | Developer Guide

Owner

Name: Airborne Wind Energy Research Group
Login: awegroup
Kind: organization
Email: r.schmehl@tudelft.nl
Location: Delft

Website: kitepower.tudelft.nl
Twitter: kite_power
Repositories: 4
Profile: https://github.com/awegroup

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you are using this software, please cite it as shown below."
authors:
  -
    family-names: "Doe"
    given-names: "Jane"
    orcid: "https://orcid.org/9999-9999-9999-9999"
title: "Name of your software"
keywords:
  - Wind Energy
version: 0.1.0
doi: "11.1111/11111"
date-released: YYYY-MM-DD
license: MIT
url: "https://github.com/your_repo"
preferred-citation:
    type: article
    authors:
    - family-names: "Doe"
      given-names: "Jane"
      orcid: "https://orcid.org/9999-9999-9999-9999"
    doi: "11.1111/11111"
    journal: "The title of the journal"
    month: 12
    start: 19 # the first page number
    end: 29 #the last page number
    title: "Name of your submitted paper"
    issue: 9
    volume: 2
    year: 2024

GitHub Events

Total

Last Year

Dependencies

.github/workflows/docs.yml actions

actions/checkout v4 composite
actions/setup-python v5 composite
peaceiris/actions-gh-pages v4 composite

.github/workflows/testing.yml actions

actions/checkout v4 composite
matlab-actions/run-tests v2 composite
matlab-actions/setup-matlab v2 composite

docs/requirements.txt pypi

linkify-it-py *
myst-parser *
pydata-sphinx-theme *
sphinx *
sphinx-book-theme *
sphinx-copybutton *
sphinx-rtd-theme *
sphinx-tabs *
sphinxcontrib-matlabdomain *

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science