You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Merge branch 'dev' into anchor_clean - geography.py still needs cleanup!!!!
-- WIP merge
-- !!!! geography.py still has unresolved conflicts because this needs to be discussed with team (Felipe and Stein) to ensure this is done properly !!!!
-- added small change to anchor.py to make anchor names not case-sensitive and print out anchor type name in error message if not part of anchor
-- small change to examples/OntologySample200m.yaml to make anchor type names match new system (suction_pile -> suction)
-- pushing this now so we can track progress towards final merge.
which provides a standardized description format for floating wind farms.
22
-
23
-
An example of use of these tools to model three mooring lines over the bathymetry
24
-
of the Humboldt lease area is shown below.
25
-
26
-
27
-
28
-
See example use cases in our [examples](https://github.com/FloatingArrayDesign/FAModel/tree/main/examples/README.md) folder.
19
+
Layered on top of the floating array model is a set of design tools that can
20
+
be used for algorithmically adjusting or optimizing parts of the a floating
21
+
array. Specific tools existing for mooring lines, shared mooring systems,
22
+
dynamic power cables, static power cable routing, and overall array layout.
23
+
These capabilities work with the design representation and evaluation functions
24
+
in FAModel, and they can be applied by users in various combinations to suit
25
+
different purposes.
26
+
27
+
In addition to standalone uses of the FAD Toolset, a coupling has been made with
28
+
[Ard](https://github.com/WISDEM/Ard), a sophisticated and flexible wind farm
29
+
optimization tool. This coupling allows Ard to use certain mooring system
30
+
capabilities from FAD to perform layout optimization of floating wind farms
31
+
with Ard's more advanced layout optimization capabilities.
32
+
33
+
The FAD Toolset works with the [IEA Wind Task 49 Ontology](https://github.com/IEAWindTask49/Ontology),
34
+
which provides a standardized format for describing floating wind farm sites
35
+
and designs.
36
+
37
+
See example use cases in our [examples](./examples/README.md) folder.
29
38
30
39
## Pre-installation Requirements
31
-
The FAModel package is built entirely in Python. It is recommended that users familiarize themselves with basic Python commands before use.
32
-
It is important to understand the general structure of FAModel and how to access models and stored information. Please see the model structure
33
-
document (./famodel/README.md).
40
+
The FAD Toolset is built entirely in Python. It is recommended that users
41
+
familiarize themselves with basic Python commands before use.
42
+
For working with the library, it is important to understand the floating array
43
+
model structure, which is described more [here](./famodel/README.md).
34
44
35
45
36
46
## Installation
37
-
To install FAModel itself, first clone the FAModel repository.
47
+
To install the FAD Toolset itself, first clone this FAD-Toolset repository.
38
48
39
-
The dependencies required by FAModel depend on how it is used. To install all
49
+
The dependencies required by FAD depend on how it is used. To install all
40
50
possible required dependencies, you can create a
41
51
new python virtual environment based on the included yaml listing the required
42
52
dependencies.
@@ -47,24 +57,25 @@ run the following command:
47
57
48
58
conda env create -f famodel-env.yaml
49
59
50
-
This command will install all the dependencies required to run FAModel.
51
-
Activate your virtual environment before using FAModel with ```conda activate famodel-env```
60
+
This command will install all the dependencies required to run FAD.
61
+
Activate your virtual environment before using FAD with ```conda activate famodel-env```
52
62
53
-
To install the FAModel package in your environment, enter the
54
-
following in the command line from the FAModel directory.
63
+
To install the FAD Toolset package in your environment, enter the
64
+
following in the command line from the FAD-Toolset directory.
55
65
56
66
For development use:
57
67
58
-
run ```python setup.py develop``` or ```pip install -e .``` from the command line in the main FAModel directory.
68
+
run ```python setup.py develop``` or ```pip install -e .``` from the command
69
+
line in the main FAD-Toolset directory.
59
70
60
71
For non-development use:
61
72
62
-
run ```python setup.py``` or ```pip install .``` from the command line in the main FAModel directory.
73
+
run ```python setup.py``` or ```pip install .``` from the command line in
74
+
the main FAD-Toolset directory.
63
75
64
-
** At this time, FAModel requires the latest MoorPy development branch version to be used. **
65
-
Therefore, you must install MoorPy with ```git clone https://github.com/NREL/MoorPy.git```
66
-
then navigate to the MoorPy folder and checkout the development branch with ```git checkout dev```
67
-
Finally, install this version into your environment with ```pip install -e .```.
76
+
FAD requires MoorPy and we currently install it separately. If you don't already have it,
77
+
you can install MoorPy with ```git clone https://github.com/NREL/MoorPy.git```
78
+
then navigate to the MoorPy folder and install with ```pip install .```.
68
79
Make sure your virtual enviroment is activated before installing MoorPy.
69
80
70
81
@@ -74,19 +85,30 @@ The library has a core Project class for organizing information, classes for eac
74
85
collection of subpackages for specific functions. The current subpackages are:
75
86
76
87
- anchors: contains modules for anchor capacity calculations, in addition to the anchor class
77
-
- failures: contains modules for failure modeling with graph theory, and allows for enactment of a failure mode in integrated FAModel tools such as MoorPy and RAFT.
88
+
- failures: contains modules for failure modeling with graph theory, and allows for enactment of a failure mode.
78
89
- seabed: contains modules for seabed bathymetry and boundary information
90
+
- design: contains various tools for performing design steps.
79
91
80
92
Please navigate into the subfolders above for additional information.
81
93
82
94
## Getting Started
83
-
The easiest way to create an FAModel project is to provide the array information in an ontology yaml file. FAModel has been designed to work with a specific ontology yaml setup, which is described in detail in the [Ontology ReadMe](./famodel/ontology/README.md).
84
-
85
-
The [example driver file](./famodel/example_driver.py) creates an FAModel project from a pre-set ontology file and shows the syntax and outputs of various capabilities. For guidance on creating your own ontology yaml file, it is recommended to read through the [Ontology ReadMe](./famodel/ontology/README.md), then either adapt one of the ontology samples or fill in the ontology template.
86
-
87
-
The [FAModel core readme](./famodel/README.md) describes the FAModel class structure, as well as the properties and methods of each component class.
88
-
89
-
There are some limited helper functions to auntomatically fill in sections of a yaml from a moorpy system or a list of platform locations. See [FAModel helpers](./famodel/helpers.py) for the full list of yaml writing capabilities. Many of these are a work in progress.
95
+
The easiest way to create a FAD project is to provide the array
96
+
information in an ontology yaml file. FAD has been designed
97
+
to work with a specific ontology yaml setup, which is described
98
+
in detail in the [Ontology ReadMe](./famodel/ontology/README.md).
99
+
100
+
The [example driver file](./famodel/example_driver.py) creates a FAD Project
101
+
object from a pre-set ontology file and shows the syntax and outputs of
102
+
various capabilities. For guidance on creating your own ontology yaml file,
103
+
it is recommended to read through the [Ontology ReadMe](./famodel/ontology/README.md),
104
+
then either adapt one of the ontology samples or fill in the ontology template.
105
+
106
+
The [core model readme](./famodel/README.md) describes the Project class structure,
107
+
as well as the properties and methods of each component class.
108
+
109
+
There are some limited helper functions to automatically fill in sections
110
+
of a yaml from a MoorPy system or a list of platform locations.
111
+
See [helpers](./famodel/helpers.py) for the full list of yaml writing capabilities.
0 commit comments