Data

Tools

Indexes

Applications

Experiments

Open Source Science

template-python

Generic Python template for AWE Group

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

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 (13.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Generic Python template for AWE Group

Basic Info
  • Host: GitHub
  • Owner: awegroup
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 1.62 MB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created about 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

Description

Generic Python template for AWE Group

:gear: Installation

Dependencies

Installation Instructions

  1. Navigate to the repository folder, using the terminal with commands change-directory cd and path using the tab key will give suggestion for folders bash cd < enter path >

  2. Clone the repository, use the git clone, and copy from HTTPS. For the template, this would be: bash git clone https://github.com/awegroup/template-python.git

  3. Create a virtual environment:

Linux or Mac: bash python3 -m venv venv 

Windows:
```bash
python -m venv venv
```
  1. Activate the virtual environment:

Linux or Mac: bash source venv/bin/activate 

Windows
```bash
.\venv\Scripts\activate
```
  1. Install the required dependencies:

For users: (using package manager pip)

```bash
pip install .
```

For developers: bash pip install -e .[dev]

  1. To deactivate the virtual environment: bash deactivate

:eyes: Usage

```python import foobar

returns 'words'

foobar.pluralize('word')

returns 'geese'

foobar.pluralize('goose')

returns 'phenomenon'

foobar.singularize('phenomena') ```

: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].

: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

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
  • Push event: 2
Last Year
  • Push event: 2

Dependencies

.github/workflows/docs.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • peaceiris/actions-gh-pages v4 composite
.github/workflows/tests.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • orgoro/coverage v3.1 composite
pyproject.toml pypi
  • matplotlib >=3.7.1
  • numpy *
  • pandas >=1.5.3
requirements.txt pypi
  • linkify-it-py *
  • myst-parser *
  • pydata-sphinx-theme *
  • sphinx *
  • sphinx-book-theme *
  • sphinx-copybutton *
  • sphinx-rtd-theme *
  • sphinx-tabs *