Skip to content

Commit 4af0768

Browse files
authored
Added documentation to readme
1 parent 48a1d42 commit 4af0768

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ The main features of ForceFinder are:
1616

1717
The SourcePathReceiver object has also been built into a Rattlesnake control law for random vibration control, meaning that the same exact code can be used in offline predictions and online control during a multiple-input/multiple-output (MIMO) vibration test. Note that the control law is included with this package for completeness, but are not imported to the Python environment when ForceFinder is used.
1818

19+
## Documentation
20+
The [theory and API documentation](https://sandialabs.github.io/forcefinder) provides useful information for theory and programming interface that is used in ForceFinder. Examples will be added to this documentation over time.
21+
1922
## Goals
2023
The ForceFinder project has two main goals:
2124

@@ -58,3 +61,4 @@ import forcefinder as ff
5861

5962

6063

64+

0 commit comments

Comments
 (0)