From 8789323c0cbc97230a07a88dcd32a7aad91f2e3e Mon Sep 17 00:00:00 2001 From: eytanadler Date: Mon, 24 Jan 2022 11:02:44 -0500 Subject: [PATCH] Moved citation from source code to readme (and updated readme) --- examples/B738_VLM_drag.py | 16 ------- examples/B738_aerostructural.py | 16 ------- .../analysis/openaerostruct/aerostructural.py | 16 ------- .../analysis/openaerostruct/drag_polar.py | 16 ------- readme.md | 45 ++++++++++++------- 5 files changed, 28 insertions(+), 81 deletions(-) diff --git a/examples/B738_VLM_drag.py b/examples/B738_VLM_drag.py index 6edaa539..31a17a80 100644 --- a/examples/B738_VLM_drag.py +++ b/examples/B738_VLM_drag.py @@ -1,19 +1,3 @@ -""" -This work was the basis of the following paper. -Please cite it if you use this for your own publication! - -@InProceedings{Adler2022a, - author = {Eytan J. Adler and Joaquim R. R. A. Martins}, - title = {Aerostructural wing design optimization considering full mission analysis}, - booktitle = {AIAA SciTech Forum}, - doi = {10.2514/6.2022-0382}, - month = {January}, - year = {2022} -} - -Eytan Adler (Jan 2022) -""" - from __future__ import division import sys import os diff --git a/examples/B738_aerostructural.py b/examples/B738_aerostructural.py index 1c1e3de2..d341d028 100644 --- a/examples/B738_aerostructural.py +++ b/examples/B738_aerostructural.py @@ -1,19 +1,3 @@ -""" -This work was the basis of the following paper. -Please cite it if you use this for your own publication! - -@InProceedings{Adler2022a, - author = {Eytan J. Adler and Joaquim R. R. A. Martins}, - title = {Aerostructural wing design optimization considering full mission analysis}, - booktitle = {AIAA SciTech Forum}, - doi = {10.2514/6.2022-0382}, - month = {January}, - year = {2022} -} - -Eytan Adler (Jan 2022) -""" - from __future__ import division import sys import os diff --git a/openconcept/analysis/openaerostruct/aerostructural.py b/openconcept/analysis/openaerostruct/aerostructural.py index 637fcd2e..fd793b85 100644 --- a/openconcept/analysis/openaerostruct/aerostructural.py +++ b/openconcept/analysis/openaerostruct/aerostructural.py @@ -1,19 +1,3 @@ -""" -This work was the basis of the following paper. -Please cite it if you use this for your own publication! - -@InProceedings{Adler2022a, - author = {Eytan J. Adler and Joaquim R. R. A. Martins}, - title = {Aerostructural wing design optimization considering full mission analysis}, - booktitle = {AIAA SciTech Forum}, - doi = {10.2514/6.2022-0382}, - month = {January}, - year = {2022} -} - -Eytan Adler (Jan 2022) -""" - from __future__ import division import numpy as np diff --git a/openconcept/analysis/openaerostruct/drag_polar.py b/openconcept/analysis/openaerostruct/drag_polar.py index 8926d437..7b7265d9 100644 --- a/openconcept/analysis/openaerostruct/drag_polar.py +++ b/openconcept/analysis/openaerostruct/drag_polar.py @@ -1,19 +1,3 @@ -""" -This work was the basis of the following paper. -Please cite it if you use this for your own publication! - -@InProceedings{Adler2022a, - author = {Eytan J. Adler and Joaquim R. R. A. Martins}, - title = {Aerostructural wing design optimization considering full mission analysis}, - booktitle = {AIAA SciTech Forum}, - doi = {10.2514/6.2022-0382}, - month = {January}, - year = {2022} -} - -Eytan Adler (Jan 2022) -""" - from __future__ import division import numpy as np diff --git a/readme.md b/readme.md index ebbf82f8..b13aecd5 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@ -# OpenConcept - A Conceptual Design toolkit with efficient gradients implemented in the OpenMDAO framework +# OpenConcept - A conceptual design toolkit with efficient gradients implemented in the OpenMDAO framework -### Author: Benjamin J. Brelje +### Author: Benjamin J. Brelje and Eytan J. Adler [![Build Status](https://github.com/mdolab/openconcept/workflows/Build/badge.svg?branch=master)](https://github.com/mdolab/openconcept/actions?query=branch%3Amaster) [![Coverage Status](https://coveralls.io/repos/github/mdolab/openconcept/badge.svg)](https://coveralls.io/github/mdolab/openconcept) @@ -21,8 +21,8 @@ Automatically-generated documentation is available at (https://openconcept.readt ## Getting Started 1. Clone the repo to disk -2. Navigate to the root openconcept folder -3. Run `python setup.py install` to install the package +2. Navigate to the root `openconcept` folder +3. Run `pip install -e .` to install the package (the `-e` can be omitted if not editing the source) 4. Navigate to the `examples` folder 5. Run `python TBM850.py` to test OpenConcept on a single-engine turboprop aircraft (the TBM 850) 6. Look at the `examples/aircraft data/TBM850.py` folder to play with the assumptions / config / geometry and see the effects on the output result @@ -31,27 +31,38 @@ Automatically-generated documentation is available at (https://openconcept.readt ### Requirements -This toolkit requires the use of OpenMDAO 3.0.0 or later (2.8+ will work with minor arg changes) and will evolve rapidly as general utilities are moved from OpenConcept into the main OpenMDAO repository. OpenMDAO requires a late numpy and scipy. +This toolkit requires the use of [OpenMDAO](https://openmdao.org/) 3.10.0 or later. OpenMDAO requires a late NumPy and SciPy. ## Citation -Please cite this software by reference to the conference paper: +Please cite this software by reference to the [conference paper](https://www.researchgate.net/publication/326263660_Development_of_a_Conceptual_Design_Model_for_Aircraft_Electric_Propulsion_with_Efficient_Gradients): -### Plaintext +Benjamin J. Brelje and Joaquim R.R.A. Martins, "Development of a Conceptual Design Model for Aircraft Electric Propulsion with Efficient Gradients", 2018 AIAA/IEEE Electric Aircraft Technologies Symposium, AIAA Propulsion and Energy Forum, (AIAA 2018-4979) DOI: 10.2514/6.2018-4979 -Benjamin J. Brelje and Joaquim R.R.A. Martins. "Development of a Conceptual Design Model for Aircraft Electric Propulsion with Efficient Gradients", 2018 AIAA/IEEE Electric Aircraft Technologies Symposium, AIAA Propulsion and Energy Forum, (AIAA 2018-4979) DOI: TBD +``` +@inproceedings{Brelje2018a, + address = {{C}incinnati,~{OH}}, + author = {Benjamin J. Brelje and Joaquim R. R. A. Martins}, + booktitle = {Proceedings of the AIAA/IEEE Electric Aircraft Technologies Symposium}, + doi = {10.2514/6.2018-4979}, + month = {July}, + title = {Development of a Conceptual Design Model for Aircraft Electric Propulsion with Efficient Gradients}, + year = {2018} + } +``` + +If using the integrated OpenAeroStruct VLM or aerostructural aerodynamic models, please cite the following [conference paper](https://www.researchgate.net/publication/357559489_Aerostructural_wing_design_optimization_considering_full_mission_analysis): -### Bibtex +Eytan J. Adler and Joaquim R.R.A. Martins, "Aerostructural wing design optimization considering full mission analysis", 2022 AIAA SciTech Forum, San Diego, CA, January 2022. DOI: 10.2514/6.2022-0382 ``` -@inproceedings{Brelje2018, - Address = {{C}incinnati,~{OH}}, - Author = {Benjamin J. Brelje and Joaquim R. R. A. Martins}, - Booktitle = {2018 AIAA/IEEE Electric Aircraft Technologies Symposium}, - Month = jul, - Title = {Development of a Conceptual Design Model for Aircraft Electric Propulsion with Efficient Gradients}, - Year = 2018, - Number = {AIAA-2018-4979}, +@inproceedings{Adler2022a, + author = {Eytan J. Adler and Joaquim R. R. A. Martins}, + title = {Aerostructural wing design optimization considering full mission analysis}, + booktitle = {AIAA SciTech Forum}, + doi = {10.2514/6.2022-0382}, + month = {January}, + year = {2022} } ```