Skip to content

update publications, references, etc. #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Nov 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ jobs:
include:
- stage: pages
install:
- pip install click colorama colorclass future "sphinx==1.8.5" sphinxcontrib-bibtex sphinx_rtd_theme
- pip install click colorama colorclass future "sphinx==1.8.5" "sphinxcontrib-bibtex==0.4.2"
sphinx_rtd_theme sphinxcontrib-matlabdomain
- pip install git+git://github.com/SuperKogito/sphinxcontrib-pdfembed
- pip install https://github.com/H0R5E/sphinxcontrib-versioning/archive/v1.8.5_support.zip
- pip install git+https://github.com/H0R5E/matlabdomain.git/@function_arguments#egg=matlabdomain
script:
- eval "$(ssh-agent -s)"; touch .travis/key; chmod 0600 .travis/key
- openssl aes-256-cbc -d -K $encrypted_c97e05834f48_key -iv $encrypted_c97e05834f48_iv < .travis/key.enc > .travis/key
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,9 @@ replace slashes (`/`) in paths with backslashes (`\ `).
```
> conda create -c conda-forge -n _sphinx click colorama colorclass future pip "sphinx=1.8.5" sphinxcontrib-bibtex sphinx_rtd_theme
> activate _sphinx
(_sphinx) > pip install sphinxcontrib-matlabdomain
(_sphinx) > pip install git+git://github.com/SuperKogito/sphinxcontrib-pdfembed
(_sphinx) > pip install https://github.com/H0R5E/sphinxcontrib-versioning/archive/v1.8.5_support.zip
(_sphinx) > pip install git+https://github.com/H0R5E/matlabdomain.git/@function_arguments#egg=matlabdomain
(_sphinx) > conda deactivate
>
```
Expand Down
Binary file added docs/_static/WecOptTool_webinar_2020_09_29.pdf
Binary file not shown.
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ def setup(app):
'sphinx.ext.mathjax',
'sphinxcontrib.matlab',
'sphinx.ext.napoleon',
'sphinxcontrib.bibtex'
'sphinxcontrib.bibtex',
'sphinxcontrib.pdfembed'
]

# Figure numbering
Expand Down
14 changes: 8 additions & 6 deletions docs/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@
:numbered:
:caption: User Guide

user/setup
user/optimization
user/model
user/api
user/license
user/references
user/1setup
user/2optimization
user/3model
user/4cite
user/5resources
user/6api
user/7license
user/8references

.. toctree::
:hidden:
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/user/model.rst → docs/user/3model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ It is envisioned that the structure of WecOptTool may some day be consolidated b
Introduction
============

The WaveBot example :cite:`Coe2020` will be used to illustrate these concepts in more detail.
The WaveBot example :cite:`Coe2020initial` will be used to illustrate these concepts in more detail.
The process for performing a study in WecOptTool can be broken into three distinct steps, which correlate to three files in the WaveBot example:

* **Designing the device** - |designDevice.m|_ creates the device based on a set of design variables
Expand Down
22 changes: 22 additions & 0 deletions docs/user/4cite.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
*****************
Citing WecOptTool
*****************

If WecOptTool has been significant in your research, and you would like to acknowledge the project in your academic publication, we suggest citing the following paper:

* Coe, R.G., Bacelli, G., Olson, S., Neary, V.S., Topper, M.B.R. (2020). Initial conceptual demonstration of control co-design for WEC optimization.
*Journal of Ocean Engineering and Marine Energy (in press).* DOI: |nbsp| `10.36227/techrxiv.12928898 <https://doi.org/10.36227/techrxiv.12928898>`__.

*In BibTeX format*::

@article{ Coe2020initial,
author = {Ryan G. Coe and Giorgio Bacelli and Sterling Olson and Vincent S. Neary
and Mathew B. R. Topper},
doi = {10.36227/techrxiv.12928898},
journal = {Journal of Ocean Engineering and Marine Energy (in press)},
title = {Initial conceptual demonstration of control co-design for {WEC} optimization},
year = {2020}
}

.. |nbsp| unicode:: 0xA0
:trim:
21 changes: 21 additions & 0 deletions docs/user/5resources.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
*********
Resources
*********

This page provides additional resources for users of WecOptTool.

Webinar
=======

A one hour webinar :cite:`coe2020webinar` was presented on September 29th 2020. This webinar provides interested users with a tutorial and background.

:pdfembed:`src:../_static/WecOptTool_webinar_2020_09_29.pdf#view=fitH&zoom=scale&toolbar=1, height:450, width:700, align:middle`

Additional Reading
==================

The following references specifically focusing on WecOptTool are available:

* **Optimal control of wave energy converters** :cite:`Bacelli2014` - While written years before the development of WecOptTool, Giorgio Bacelli's doctoral thesis provides much of the framework upon which WecOptTool is based.
* **Initial conceptual demonstration of control co-design for WEC optimization** :cite:`Coe2020initial` - This paper presents the basic framework of WecOptTool along with a series of examples using the Sandia WaveBot.

File renamed without changes.
File renamed without changes.
8 changes: 8 additions & 0 deletions docs/user/8references.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
**********
References
**********

This page list supporting references for WecOptTool.

.. bibliography:: WecOptTool_refs.bib
:style: unsrt
75 changes: 49 additions & 26 deletions docs/user/WecOptTool_refs.bib
Original file line number Diff line number Diff line change
@@ -1,30 +1,53 @@


@Article{Coe2020,
author = {Ryan G. Coe and Giorgio Bacelli and Sterling Olson and Vincent S. Neary and Mathew B. R. Topper},
title = {{Initial conceptual demonstration of control co-design for WEC optimization}},
year = {2020},
journal= {Journal of Ocean Engineering and Marine Energy (under review)},
doi = {10.36227/techrxiv.12928898.v1}
}
@phdthesis{Bacelli2014,
Address = {Maynooth, Ireland},
Author = {Bacelli, Giorgio},
Date-Added = {2020-10-21 19:27:54 -0600},
Date-Modified = {2020-10-21 19:27:54 -0600},
File = {Bacelli2014.pdf:pdfs\\Bacelli2014.pdf:PDF},
School = {National University of Ireland, Maynooth},
Title = {Optimal control of wave energy converters},
Type = {{PhD}},
Url = {http://mural.maynoothuniversity.ie/6753/},
Year = {2014},
Bdsk-Url-1 = {http://mural.maynoothuniversity.ie/6753/}}

@Book{Falnes2002,
title = {Ocean Waves and Oscillating Systems},
author = {Johannes Falnes},
publisher = {Cambridge University Press},
year = {2002},
address = {Cambridge; New York},
doi = {10.1017/CBO9780511754630}
}
@misc{coe2020webinar,
Author = {Ryan G. Coe and Giorgio Bacelli and Sterling Olson and Vincent S. Neary and Mathew B. R. Topper},
Date-Added = {2020-10-21 19:23:10 -0600},
Date-Modified = {2020-10-21 19:24:32 -0600},
Doi = {10.13140/RG.2.2.16353.94564},
Howpublished = {Online},
Month = {September},
Title = {WecOptTool Sept. 2020 Webinar},
Year = {2020}}

@Article{Bacelli2014a,
author = {Bacelli, Giorgio and Ringwood, John V},
journal = {IEEE Transactions on Sustainable Energy},
title = {Numerical optimal control of wave energy converters},
year = {2014},
number = {2},
pages = {294--302},
volume = {6},
publisher = {IEEE},
doi = {10.1109/TSTE.2014.2371536}
}
@article{Coe2020initial,
Author = {Ryan G. Coe and Giorgio Bacelli and Sterling Olson and Vincent S. Neary and Mathew B. R. Topper},
Doi = {10.36227/techrxiv.12928898},
Journal = {Journal of Ocean Engineering and Marine Energy (in press)},
Title = {{Initial conceptual demonstration of control co-design for WEC optimization}},
Year = {2020},
Bdsk-Url-1 = {https://doi.org/10.36227/techrxiv.12928898}}

@book{Falnes2002,
Address = {Cambridge; New York},
Author = {Johannes Falnes},
Doi = {10.1017/CBO9780511754630},
Publisher = {Cambridge University Press},
Title = {Ocean Waves and Oscillating Systems},
Year = {2002},
Bdsk-Url-1 = {https://doi.org/10.1017/CBO9780511754630}}

@article{Bacelli2014a,
Author = {Bacelli, Giorgio and Ringwood, John V},
Doi = {10.1109/TSTE.2014.2371536},
Journal = {IEEE Transactions on Sustainable Energy},
Number = {2},
Pages = {294--302},
Publisher = {IEEE},
Title = {Numerical optimal control of wave energy converters},
Volume = {6},
Year = {2014},
Bdsk-Url-1 = {https://doi.org/10.1109/TSTE.2014.2371536}}
4 changes: 0 additions & 4 deletions docs/user/references.rst

This file was deleted.

9 changes: 4 additions & 5 deletions examples/WaveBot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ A preprint is avaialable at <https://doi.org/10.36227/techrxiv.12928898>.
```
@Article{WecDesignOptimizationTool,
author = "Ryan G. Coe and Giorgio Bacelli and Sterling Olson and Vincent S. Neary and Mathew B. R. Topper",
title = "{Initial conceptual demonstration of control co-design for WEC optimization}",
year = "2020",
month = "9",
url = "https://www.techrxiv.org/articles/preprint/Initial_conceptual_demonstration_of_control_co-design_for_WEC_optimization/12928898",
doi = "10.36227/techrxiv.12928898.v1"
title = {{Initial conceptual demonstration of control co-design for WEC optimization}},
year = {2020},
journal= {Journal of Ocean Engineering and Marine Energy (in press)},
doi = {10.36227/techrxiv.12928898}
}
```