# RAFT - Response Amplitudes of Floating Turbines
RAFT is a Python code for frequency-domain analysis of floating wind turbines. It constitutes the "Level 1" of modeling fidelity in the [WEIS](https://weis.readthedocs.io/en/latest/index.html) toolset for floating wind turbine controls co-design. RAFT provides frequency-domain modeling of full floating wind turbine systems including turbine aerodynamics, controls, rigid-body platform hydrodynamics, and mooring response. The rotor aerodynamics are provided by [CCBlade](https://github.com/WISDEM/CCBlade) and the mooring system is represented by NREL's new quasi-static mooring system model, [MoorPy](https://github.com/NREL/MoorPy). Potential-flow hydrodynamics can optionally be used via [pyHAMS](https://github.com/WISDEM/pyHAMS), a Python wrapper of the HAMS (Hydrodynamic Analysis of Marine Structures) tool for boundary-element-method solution of the potential flow problem developed by [Yingyi Liu](https://github.com/YingyiLiu/HAMS).
RAFT v1.0.0 includes the capabilities described above, and further development is planned to expand these capabilities. Documentation and verification efforts are ongoing. Please see [RAFT's documentation](https://openraft.readthedocs.io/en/latest/) for more information.
## Getting Started
New users of RAFT as a standalone model are recommended to begin by looking at the input file and script provided in the examples folder, and seeking further information from the [RAFT documentation](https://openraft.readthedocs.io/en/latest/). For use as part of the WEIS toolset, information will be provided once this capability is completed in the [WEIS documentation](https://weis.readthedocs.io/en/latest/). For now, the following will help get started with running RAFT as a standalone model.
RAFT uses a number of prerequisites, or other python package dependencies, to run its calculations. The most notable ones are listed below:
- Python 3
- NumPy
- Matplotlib
- SciPy
- YAML
- MoorPy (available at https://github.com/NREL/MoorPy)
- pyHams (available at https://github.com/WISDEM/pyHAMS)
- CCBlade or WISDEM* (https://github.com/WISDEM/CCBlade or https://github.com/WISDEM/WISDEM)
\* CCBlade is a module of WISDEM, but can be used separately. RAFT only requires CCBlade (and some additional related functions) out of the larger WISDEM code. New users can install either CCBlade or WISDEM, but for highest efficiency, we recommend installing CCBlade, without the entire WISDEM installation.
To install all required python packages to run RAFT, follow the steps below.
1. Install most of the required python packages to run RAFT from the "requirements" yaml.
(base) PS ANY_PATH> conda env create -f raft-env.yaml
This will create a new python virtual environment on a new user's local machine called "raft-env"
2. Activate the new virtual environment
(base) PS ANY_PATH> conda activate raft-env
This will activate the newly created virtual environment, where we will install the remaining dependencies
3. Install the RAFT package
- Navigate to a directory of your choosing on your local machine and clone this RAFT repository to that new directory
(raft-env) PS YOUR_PATH> git clone https://github.com/WISDEM/RAFT.git
- Staying in the same directory, install the RAFT package in it's "editable" mode
(raft-env) PS YOUR_PATH/RAFT> pip install -e .
4. Repeat Step 3 two more times, one for CCBlade, and one for MoorPy
(raft-env) PS YOUR_PATH> git clone https://github.com/WISDEM/CCBlade.git
(raft-env) PS YOUR_PATH/CCBlade> pip install -e .
(raft-env) PS YOUR_PATH/CCBlade> cd ..
(raft-env) PS YOUR_PATH> git clone https://github.com/NREL/MoorPy.git
(raft-env) PS YOUR_PATH/MoorPy> pip install -e .
** If you are running into errors with installing CCBlade, make sure there is not a file called "_bem.cp39-win_amd64.pyd" inside of CCBlade/ccblade. Deleting this file will allow the above commands to run.
This new raft-env should now be compatible to run RAFT standalone. Dependencies like CCBlade and MoorPy are still under development, which is why for now, it will be easier to install them in their editable forms.
The other main dependency, PyHAMS, is included within the raft-env.yaml file and is installed in Step 1.
Another point to note is that ```python setup.py develop``` has become outdated, and ```pip install -e .``` is preferred.
If you need to remove any virtual environment for any reason, you can run
conda env remove -n "name-of-the-virtual-environment"
## Documentation and Issues
Please see <https://weis.readthedocs.io/en/latest/> for documentation.
Questions and issues can be posted at <https://github.com/WISDEM/RAFT/issues>.
## License
RAFT is licensed under the Apache License, Version 2.0
Raw data
{
"_id": null,
"home_page": "",
"name": "OpenRAFT",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Matthew Hall <matthew.hall@nrel.gov>, Stein Housner <stein.housner@nrel.gov>, Daniel Zalkind <daniel.zalkind@nrel.gov>",
"keywords": "wind,floating,frequency,design,optimization",
"author": "",
"author_email": "National Renewable Energy Laboratory <matthew.hall@nrel.gov>",
"download_url": "https://files.pythonhosted.org/packages/71/01/91060fc5f6d54142bcaac8d3650c1481a497bf5be357cb33ce28c80df449/OpenRAFT-1.2.0.tar.gz",
"platform": null,
"description": "# RAFT - Response Amplitudes of Floating Turbines\n\nRAFT is a Python code for frequency-domain analysis of floating wind turbines. It constitutes the \"Level 1\" of modeling fidelity in the [WEIS](https://weis.readthedocs.io/en/latest/index.html) toolset for floating wind turbine controls co-design. RAFT provides frequency-domain modeling of full floating wind turbine systems including turbine aerodynamics, controls, rigid-body platform hydrodynamics, and mooring response. The rotor aerodynamics are provided by [CCBlade](https://github.com/WISDEM/CCBlade) and the mooring system is represented by NREL's new quasi-static mooring system model, [MoorPy](https://github.com/NREL/MoorPy). Potential-flow hydrodynamics can optionally be used via [pyHAMS](https://github.com/WISDEM/pyHAMS), a Python wrapper of the HAMS (Hydrodynamic Analysis of Marine Structures) tool for boundary-element-method solution of the potential flow problem developed by [Yingyi Liu](https://github.com/YingyiLiu/HAMS).\n\nRAFT v1.0.0 includes the capabilities described above, and further development is planned to expand these capabilities. Documentation and verification efforts are ongoing. Please see [RAFT's documentation](https://openraft.readthedocs.io/en/latest/) for more information.\n\n\n## Getting Started\n\nNew users of RAFT as a standalone model are recommended to begin by looking at the input file and script provided in the examples folder, and seeking further information from the [RAFT documentation](https://openraft.readthedocs.io/en/latest/). For use as part of the WEIS toolset, information will be provided once this capability is completed in the [WEIS documentation](https://weis.readthedocs.io/en/latest/). For now, the following will help get started with running RAFT as a standalone model.\n\nRAFT uses a number of prerequisites, or other python package dependencies, to run its calculations. The most notable ones are listed below:\n\n- Python 3\n- NumPy\n- Matplotlib\n- SciPy\n- YAML\n- MoorPy (available at https://github.com/NREL/MoorPy)\n- pyHams (available at https://github.com/WISDEM/pyHAMS)\n- CCBlade or WISDEM* (https://github.com/WISDEM/CCBlade or https://github.com/WISDEM/WISDEM)\n\n\\* CCBlade is a module of WISDEM, but can be used separately. RAFT only requires CCBlade (and some additional related functions) out of the larger WISDEM code. New users can install either CCBlade or WISDEM, but for highest efficiency, we recommend installing CCBlade, without the entire WISDEM installation.\n\nTo install all required python packages to run RAFT, follow the steps below.\n\n1. Install most of the required python packages to run RAFT from the \"requirements\" yaml.\n\n (base) PS ANY_PATH> conda env create -f raft-env.yaml\n\n This will create a new python virtual environment on a new user's local machine called \"raft-env\"\n\n2. Activate the new virtual environment\n\n (base) PS ANY_PATH> conda activate raft-env\n\n This will activate the newly created virtual environment, where we will install the remaining dependencies\n\n3. Install the RAFT package\n - Navigate to a directory of your choosing on your local machine and clone this RAFT repository to that new directory\n\n (raft-env) PS YOUR_PATH> git clone https://github.com/WISDEM/RAFT.git\n \n - Staying in the same directory, install the RAFT package in it's \"editable\" mode\n\n (raft-env) PS YOUR_PATH/RAFT> pip install -e .\n\n4. Repeat Step 3 two more times, one for CCBlade, and one for MoorPy\n\n (raft-env) PS YOUR_PATH> git clone https://github.com/WISDEM/CCBlade.git\n (raft-env) PS YOUR_PATH/CCBlade> pip install -e .\n (raft-env) PS YOUR_PATH/CCBlade> cd ..\n (raft-env) PS YOUR_PATH> git clone https://github.com/NREL/MoorPy.git\n (raft-env) PS YOUR_PATH/MoorPy> pip install -e .\n\n ** If you are running into errors with installing CCBlade, make sure there is not a file called \"_bem.cp39-win_amd64.pyd\" inside of CCBlade/ccblade. Deleting this file will allow the above commands to run.\n\n\nThis new raft-env should now be compatible to run RAFT standalone. Dependencies like CCBlade and MoorPy are still under development, which is why for now, it will be easier to install them in their editable forms.\n\nThe other main dependency, PyHAMS, is included within the raft-env.yaml file and is installed in Step 1.\n\nAnother point to note is that ```python setup.py develop``` has become outdated, and ```pip install -e .``` is preferred.\n\nIf you need to remove any virtual environment for any reason, you can run \n\n conda env remove -n \"name-of-the-virtual-environment\"\n\n\n\n## Documentation and Issues\n\nPlease see <https://weis.readthedocs.io/en/latest/> for documentation.\n\nQuestions and issues can be posted at <https://github.com/WISDEM/RAFT/issues>.\n\n## License\nRAFT is licensed under the Apache License, Version 2.0\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "RAFT: Response Amplitudes of Floating Turbines",
"version": "1.2.0",
"project_urls": {
"Documentation": "https://openraft.readthedocs.io",
"Homepage": "https://github.com/WISDEM/RAFT"
},
"split_keywords": [
"wind",
"floating",
"frequency",
"design",
"optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "38bcc6138631d44796d8cd35dd6bdbdf9bad307d707f85674f6b5a18035e62f1",
"md5": "d6c46f4a4de6c1f127366afcf22a61a6",
"sha256": "27616530a53bdbaad30f0ae350f47d9e221b69309149bceddbaa58e166950c09"
},
"downloads": -1,
"filename": "OpenRAFT-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6c46f4a4de6c1f127366afcf22a61a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 155552,
"upload_time": "2024-01-03T11:07:15",
"upload_time_iso_8601": "2024-01-03T11:07:15.546351Z",
"url": "https://files.pythonhosted.org/packages/38/bc/c6138631d44796d8cd35dd6bdbdf9bad307d707f85674f6b5a18035e62f1/OpenRAFT-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "710191060fc5f6d54142bcaac8d3650c1481a497bf5be357cb33ce28c80df449",
"md5": "204c86747091c6379c77f1e3862a4ea0",
"sha256": "3938270dee95c4d950f9ab8c26fba9c46c455b33c5cb84495a917cb62a280e47"
},
"downloads": -1,
"filename": "OpenRAFT-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "204c86747091c6379c77f1e3862a4ea0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 191001,
"upload_time": "2024-01-03T11:07:17",
"upload_time_iso_8601": "2024-01-03T11:07:17.580563Z",
"url": "https://files.pythonhosted.org/packages/71/01/91060fc5f6d54142bcaac8d3650c1481a497bf5be357cb33ce28c80df449/OpenRAFT-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-03 11:07:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WISDEM",
"github_project": "RAFT",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openraft"
}
JSON
