Getting Started
===============


Prerequisites
-------------

- Python 3
- NumPy
- Matplotlib
- SciPy
- YAML
- `MoorPy <https://github.com/NREL/MoorPy>`_
- `PyHAMS <https://github.com/WISDEM/pyHAMS>`_
- `CCBlade <https://github.com/WISDEM/WISDEM>`_ 

Note: RAFT uses CCBlade and currently is set up for the version of CCBlade that is
part of the larger WISDEM code. We recommend installing WISDEM for the time being.


Installation
------------

Download/clone and install the `RAFT repository <https://github.com/WISDEM/RAFT>`_ as well as 
those of MoorPy, pyHAMS, and WISDEM. 

To install RAFT for development use:

run ```python setup.py develop``` or ```pip install -e .``` from the command line in the main RAFT directory.

To install RAFT for non-development use:

run ```python setup.py``` or ```pip install .``` from the command line in the main RAFT directory.


Example
-------

An example script for running RAFT and an example YAML input file describing 
the VolturnUS-S 15 MW floating wind turbine design is included in the examples
folder of the RAFT repository. The script is shown below, illustrating the main
function calls involved in running a RAFT analysis.

.. code-block:: python

	import raft
	import yaml

	# open the design YAML file and parse it into a dictionary for passing to raft
	with open('VolturnUS-S_example.yaml') as file:
		design = yaml.load(file, Loader=yaml.FullLoader)

	# Create the RAFT model (will set up all model objects based on the design dict)
	model = raft.Model(design)  

	# Evaluate the system properties and equilibrium position before loads are applied
	model.analyzeUnloaded()

	# Compute natural frequencies
	model.solveEigen()

	# Simule the different load cases
	model.analyzeCases(display=1)

	# Plot the power spectral densities from the load cases
	model.plotResponses()

	# Visualize the system in its most recently evaluated mean offset position
	model.plot(hideGrid=True)