Skip to content

Commit c390619

Browse files
Added citation info to docs (#453)
* added citation info to docs * Fix docs build * added citation.cff --------- Co-authored-by: Marco Mangano <36549388+marcomangano@users.noreply.github.com>
1 parent c8ee686 commit c390619

3 files changed

Lines changed: 94 additions & 0 deletions

File tree

.readthedocs.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
version: 2
44

5+
sphinx:
6+
# Path to your Sphinx configuration file.
7+
configuration: openaerostruct/docs/conf.py
8+
59
build:
610
os: ubuntu-22.04
711
tools:

CITATION.cff

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
cff-version: "1.2.0"
2+
authors:
3+
- family-names: Jasa
4+
given-names: John P.
5+
orcid: "https://orcid.org/0000-0001-5442-2792"
6+
- family-names: Hwang
7+
given-names: John T.
8+
orcid: "https://orcid.org/0009-0002-5789-6357"
9+
- family-names: Martins
10+
given-names: Joaquim R. R. A.
11+
orcid: "https://orcid.org/0000-0003-2143-1478"
12+
doi: 10.1007/s00158-018-1912-8
13+
message: If you use this software, please cite the following paper.
14+
preferred-citation:
15+
authors:
16+
- family-names: Jasa
17+
given-names: John P.
18+
orcid: "https://orcid.org/0000-0001-5442-2792"
19+
- family-names: Hwang
20+
given-names: John T.
21+
orcid: "https://orcid.org/0009-0002-5789-6357"
22+
- family-names: Martins
23+
given-names: Joaquim R. R. A.
24+
orcid: "https://orcid.org/0000-0003-2143-1478"
25+
title: "Open-source coupled aerostructural optimization using Python"
26+
journal: "Structural and Multidisciplinary Optimization"
27+
volume: "57"
28+
number: "4"
29+
pages: "1815--1827"
30+
date: "2018-04"
31+
doi: "10.1007/s00158-018-1912-8"

openaerostruct/docs/index.rst

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,65 @@ Source Docs
7272

7373
_srcdocs/index.rst
7474

75+
---------------
76+
Please Cite Us!
77+
---------------
78+
79+
If you use OpenAeroStruct, please cite the `following paper <https://www.researchgate.net/publication/322991521_Open-source_coupled_aerostructural_optimization_using_Python>__`:
80+
81+
John P. Jasa, John T. Hwang, and Joaquim R. R. A. Martins. "Open-source coupled aerostructural optimization using Python." Structural and Multidisciplinary Optimization 57.4 (2018): 1815-1827. DOI: 10.1007/s00158-018-1912-8
82+
83+
.. code-block:: bibtex
84+
85+
@article{Jasa2018a,
86+
Author = {John P. Jasa and John T. Hwang and Joaquim R. R. A. Martins},
87+
Doi = {10.1007/s00158-018-1912-8},
88+
Journal = {Structural and Multidisciplinary Optimization},
89+
Month = {April},
90+
Number = {4},
91+
Pages = {1815--1827},
92+
Publisher = {Springer},
93+
Title = {Open-source coupled aerostructural optimization using {Python}},
94+
Volume = {57},
95+
Year = {2018}
96+
}
97+
98+
99+
If you use the wingbox structural model, fuel-weight inertial loads, or structural-weight inertial loads, please also cite the `following paper <https://www.researchgate.net/publication/327654423_Low-Fidelity_Aerostructural_Optimization_of_Aircraft_Wings_with_a_Simplified_Wingbox_Model_Using_OpenAeroStruct>__`:
100+
101+
Shamsheer S. Chauhan and Joaquim R. R. A. Martins, “Low-Fidelity Aerostructural Optimization of Aircraft Wings with a Simplified Wingbox Model Using OpenAeroStruct,” Proceedings of the 6th International Conference on Engineering Optimization, EngOpt 2018, Springer, Lisbon, Portugal, September 2018, pp. 418–431. doi:10.1007/978-3-319-97773-7 38
102+
103+
.. code-block:: bibtex
104+
105+
@inproceedings{Chauhan2018b,
106+
Author = {Shamsheer S. Chauhan and Joaquim R. R. A. Martins},
107+
Address = {Lisbon, Portugal},
108+
Booktitle = {Proceedings of the 6th International Conference on Engineering Optimization, EngOpt 2018},
109+
Doi = {10.1007/978-3-319-97773-7_38},
110+
Pages = {418-431},
111+
Publisher = {Springer},
112+
Title = {Low-Fidelity Aerostructural Optimization of Aircraft Wings with a Simplified Wingbox Model Using {OpenAeroStruct}},
113+
Year = {2018}
114+
}
115+
116+
117+
If using point-mass loads or thrust loads, please cite the following `paper (https://www.researchgate.net/publication/333806174_How_Certain_Physical_Considerations_Impact_Aerostructural_Wing_Optimization)__`.
118+
119+
John P. Jasa, Shamsheer S. Chauhan, Justin S. Gray, and Joaquim R. R. A. Martins, “How Certain Physical Considerations Impact Aerostructural Wing Optimization,” AIAA/ISSMO Multidisciplinary Analysis and Optimization Conference, Dallas, TX, 2019. doi:10.2514/6.2019-3242
120+
121+
.. code-block:: bibtex
122+
123+
@inproceedings{Jasa2019c,
124+
Author = {John P. Jasa and Shamsheer S. Chauhan and Justin S. Gray and Joaquim R. R. A. Martins},
125+
Address = {Dallas, TX},
126+
Booktitle = {AIAA/ISSMO Multidisciplinary Analysis and Optimization Conference},
127+
Doi = {10.2514/6.2019-3242},
128+
Title = {How Certain Physical Considerations Impact Aerostructural Wing Optimization},
129+
Month = {June},
130+
Year = {2019}}
131+
}
132+
133+
75134
Notes
76135
=====
77136

0 commit comments

Comments
 (0)