Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
i-samos authored Apr 6, 2023
1 parent d872618 commit fbc0df2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This MATLAB application is designed to analyze meteorological parameters, such a

The purpose of this application is to provide an easy way to visualize Medicane charasteristics from GRIB1 files. Running "medicanes.m" will open a GUI where you can select the time based on the GRIB1 files, that you want to analyze. The application will then extract the necessary parameters and use Hart's methodology to identify medicane characteristics, such as the cyclone's location and intensity. This application has been tested on Windows 10 64 platforms (Linux has not been tested yet, but probably no need for major modifications).

The INPUT_GRIB directory is a required component of the application, as it contains files with the same projection, in order for them to be read correctly. Additionally, the GRIB files must have a ".grb" extension (e.g. "test.grb") in order to be recognized by the application. All of the files contained in INPUT_GRIB directory must be a) of the same run and has multiple forecasts, or b) has only analyses without any forecasts, as you cannot select model etc. If needed to change grib files, just replace them and re-run. This application has been tested with MATLAB versions 16b and 17a.
The INPUT_GRIB directory is a required component of the application, as it contains files with the same projection, in order for them to be read correctly. Additionally, the GRIB files must have a ".grb" extension (e.g. "test.grb") in order to be recognized by the application. All of the files contained in INPUT_GRIB directory must be a) of the same run with multiple forecasts, or b) has only analyses without any forecasts, as you cannot select model etc. If needed to change grib files, just replace them and re-run. This application has been tested with MATLAB versions 16b and 17a.

<h2> Code Modifications and Future Work </h2>
This application uses C code for MEX files, which has been modified to export the output to a text file in the filesystem and then read the text file back into MATLAB. This was done as a temporary solution until further work can be done to properly modify the code to assign the data to a matrix inside MATLAB. Future work for this application can include modifying the code to read GRIB2 files using nctoolbox. Currently, the application only supports GRIB1 files due to limitations with the code. In the future, the plan is to expand this application to include support for additional file formats, such as GRIB2. It is also planed to add more advanced features, such as the ability to generate reports and/or export results in various formats.
Expand Down

0 comments on commit fbc0df2

Please sign in to comment.