Skip to content

Commit

Permalink
Add warning about _4 vs _8 in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderRichert-NOAA committed Oct 25, 2023
1 parent f74acdd commit 4f87655
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ should always be zero, as should the global mean of any divergence and
vorticity fields. The stride between the start of successive wave
fields is general, defaulting to the computed length of each field.

It should be noted that some routines may behave poorly or unpredictably when
using 4-byte reals (libsp_4). In some routines, small numerical differences can
be amplified into noticeable differences in output field values. Some
applications may therefore benefit from the use of 8-byte reals (libsp_d).

This documentation is divided into 3 chapters. Chapter I is this
introduction. Chapter II is a list of all entry points. Chapter III
is a set of examples.
Expand Down

0 comments on commit 4f87655

Please sign in to comment.