diff --git a/README.md b/README.md index 083c342..f171b0d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,74 @@ -# emmsynth_fast - Software for fast and accurate evaluation of geomagnetic quantities at scattered points in space + + + + + Fast and accurate evaluation of geomagnetic quantities + + + + +
+ + Software for fast and accurate evaluation
of geomagnetic quantities at scattered points in space
+
+ + emmsynth_fast + +
+ + + +

Overview + + +

We present FORTRAN and MATLAB software for fast and accurate evaluation of +the components of the geomagnetic field represented in high degree (above 720) solid spherical or ellipsoidal harmonics +at many scattered points in the space above the surface of the Earth. + +

The evaluated magnetic field components are: +

+The values of the components are derived from the official NOAA Enhanced Magnetic Models EMM2015 or EMM2017. +These models are determined by their coefficients, given +in the files EMM2015.COF and EMM2015SV.COF for EMM2015 and +in the files EMM2017.COF and EMM2017SV.COF for EMM2017. + +

The standard algorithm for evaluation of the above magnetic field components is relatively slow due to the high degree of the EMM. +Our algorithm performs several hundred times faster than the standard algorithm and evaluate every quantity with a guaranteed accuracy of less than 1 nT. + +

The codes evaluate the magnetic field at millions of points given by their geodetic geographic coordinates: +latitude, longitude and the height above the Earth reference ellipsoid. +The height ranges from -0.417 km to 1,000 km. + +

+ +

Resources + + +

This is the GitHub +repository of emmsynth_fast source code, including instructions for compiling +and installing it. +The FORTRAN version of the code is contained in the zip archive emmsynth_fast_f.zip (32MB), +while the MATLAB version of the code is contained in the zip archive emmsynth_fast_m.zip (32MB). + +

Every zip file contains the respective source codes, the model coefficients, test files with coordinates of randomly distributed points in space, +the code output for these points and a user manual file readme_emmsynth_fast.pdf. +These user manuals contain a detailed description of the software with instructions for its use and test statistics. + +

The homepage for emmsynth_fast project can be found at +http://imi.cas.sc.edu/sw-geomagnetic-fields/ +from the University of South Carolina website. + + + + \ No newline at end of file