Skip to content

Commit

Permalink
merge with master
Browse files Browse the repository at this point in the history
  • Loading branch information
kieran-mackle committed Jun 19, 2024
2 parents a1604a5 + 153d241 commit cb8a278
Show file tree
Hide file tree
Showing 76 changed files with 2,557 additions and 505 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help improve the project
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Version being used**
eg. Using version `0.1.0`

**Additional context**
Add any other context about the problem here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Custom issue template
about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ''

---


20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
3 changes: 3 additions & 0 deletions .github/scripts/publish
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Publish to PyPi
python3 -m build
python3 -m twine upload dist/* -u $PYPI_USERNAME -p $PYPI_PASSWORD
26 changes: 26 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Upload Python Package

on:
push:
tags:
- "*" # Will trigger for every tag, alternative: 'v*'

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install dependencies
run: |
python3 -m pip install --pre -U twine
python3 -m pip install --pre -U build
- name: Build and publish
env:
PYPI_USERNAME: __token__
PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
run: |
.github/scripts/publish
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ build/
*.stl
*.csv
*.vtk
build/
29 changes: 29 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/source/conf.py

# Optionally build your docs in additional formats such as PDF and ePub
formats:
- pdf

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/source/requirements.txt
- method: pip
path: .
35 changes: 35 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
## v0.5.0 (2024-01-02)

### Feat

- **Component**: added add_clustering_options method
- **utilities**: improve verbosity of senstivity study
- **SensitivityStudy**: optionally provide generator overrides
- **SensitivityStudy**: improved verbosity
- **merge_stls**: return merged stl filename
- **merge_stls**: added verbosity control
- **SensitivityStudy**: writing results to csv also writes combined csv
- **utilities**: added print_banner utility function
- **hangar**: add waverider to hangar
- **Component**: ghost components
- **Vehicle**: include option to merge all stls when writing to_stl
- **utilities**: added stl mesh merge function
- **SensitivityStudy**: calculates and saves component volume and mass sensitivities
- **Vehicle**: component volume and mass included in vehicle assessment
- **Component**: clean mesh on writing to stl
- **Vehicle**: allow specifying component modifier function to manipulate surfaces
- **parametricSurfce2stl**: allow passing custom clustering function
- **Vehicle**: ability to define and differentiate vehicle properties

### Fix

- **CompositeComponent**: added sphere and cube to allowable components
- **hangar**: include waverider in hangar namespace loading
- **Vehicle.to_stl**: exclude ghost components in stl merge

### Refactor

- **Component**: only clean mesh on writing to STL
- **Component**: clean STL mesh when generating mesh object instead of on saving to file
- **SensitivityStudy**: component volmass sens replaces just vehicle sens

## v0.4.0 (2023-03-10)

### Feat
Expand Down
Loading

0 comments on commit cb8a278

Please sign in to comment.