Skip to content

Commit

Permalink
Merge pull request #2145 from andrew-platt/docs/update_for_3.5.3_release
Browse files Browse the repository at this point in the history
Docs/update for 3.5.3 release
  • Loading branch information
andrew-platt authored Apr 11, 2024
2 parents d4214da + 8242f76 commit d5ce801
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 7 deletions.
4 changes: 4 additions & 0 deletions docs/changelogs/v3.5.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ Other notable improvements include corrections to turbine indexing when coupled
### Docker builds

#2124 Update dockerfile and facilitate nrel/openfast Docker Hub registry, with documentation (@cortadocodes, first time contributor)
#2139 Add final dockerfile updates (@cortadocodes)
#2141 GH actions to push docker image to Github container registry (@mayankchetan, first time contributor)


### GH actions
Expand All @@ -69,6 +71,8 @@ Other notable improvements include corrections to turbine indexing when coupled
### Documentation

#2130 Fix cache failure in Github Actions caused by setup-python (@andrew-platt)
#2144 Edit to readthedocs.io -- Adding Internal Reference Hyperlink for appendixD.rst (@reilandsberger, first time contributor)
#2145 Docs/update for 3.5.3 release (@andrew-platt)


## Solvers
Expand Down
44 changes: 37 additions & 7 deletions docs/source/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,27 +157,57 @@ containing the executables, and running a simple test command:
.. _use_docker:

Use a docker image
~~~~~~~~~~~~~~~~~~
Multiple versions of OpenFAST are available as docker images from our `docker registry <https://hub.docker.com/r/nrel/openfast>`_.
Running OpenFAST with docker
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
OpenFAST is avilable to be run on docker starting with version 3.5.3. Three approaches are shared below.

Using a docker image from Docker hub
------------------------------------
Multiple versions of OpenFAST are also available as docker images from our `docker registry <https://hub.docker.com/r/nrel/openfast>`_.
To pull and run one with files from your local machine available, run:

.. code-block:: shell
docker run --rm -it --volume=/path/to/files:/files nrel/openfast:3.5.2 openfast /files/main.fst
docker run --rm -it --volume=/path/to/files:/files nrel/openfast:latest openfast /files/main.fst
This command deletes the container (but not the image) when the analysis is finished and leaves the outputs in the same
local directory as the input files. You can also run commands inside the container with:
local directory as the input files.

You can also run commands interactively inside the container with:

.. code-block:: shell
docker run --rm -it --volume=/path/to/files:/files nrel/openfast:3.5.2 /bin/bash
docker run --rm -it --volume=/path/to/files:/files nrel/openfast:latest /bin/bash
To pull a specific release, substitute the version number in place of `latest` in the above commands (i.e. `nrel/openfast:3.5.3`).


Using a docker image from GitHub container registry
---------------------------------------------------
In addition to images hosted on Docker hub, we also host docker images on our
`GitHub container registry <https://github.com/orgs/OpenFAST/packages?repo_name=openfast>`_.
The commands for pulling an image from the GitHub container repository are
similar to those for pulling and running from Docker hub.

To pull and run with local files:

.. code-block:: shell
docker run --rm -it --volume=/path/to/files:/files ghcr.io/OpenFAST/openfast:latest openfast /files/main.fst
For running the container interactively:

.. code-block:: shell
docker run --rm -it --volume=/path/to/files:/files ghcr.io/OpenFAST/openfast:latest /bin/bash
Build your own images
~~~~~~~~~~~~~~~~~~~~~
---------------------
You can also build your own custom images using our `Dockerfile` or base your images on ours. See
`here <https://github.com/OpenFAST/openfast/blob/main/share/docker/README.md>`_ for more information on this.


.. _compile_from_source:

Compile from source
Expand Down

0 comments on commit d5ce801

Please sign in to comment.