Read Me

\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
\_                                                                                    \_
\_   MACROMS    : Mid Atlantic Chesapeake-Delaware Regional Ocean Modeling System     \_
\_                                                                                    \_
\_          Team: Elizabeth North, Wen Long, Zack Schlag                              \_
\_                                                                                    \_
\_ Documentation: Wen Long, May 10th, 2009                                            \_
\_                                                                                    \_
\_ Last Editing:                                                                      \_
\_               Wen Long, May 10th, 2009                                             \_
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_



 System Requiremens and How to Get It:

      This is the official developing version of MACROMS 0.1 

      Please untar it and follow the readme_install.txt file to install and try out.  We appreciate 
      your feedback very much!

      Operational System:  Linux/unix

      You will ONLY need the followings softwares installed to run the example case of year 2005
      with forcing files and inputs already prepared in ./ohms/MACROMS/work/yearly/2005

        *1) netcdf 
        *2) c compiler: cc, g++, gcc or icc
        *3) fortran compiler: f77 and  f90 or  ifort or gfortran
        *4) matlab in linux/unix 

      You will need the following softwares in addition to run years from 1991 to 2005 yet other than 2005 in order to 
      first retrieve data and then prepare for the forcing files using scrips provided.  They are also needed for
      the model to be run under operational mode.

      4) NCL  ---NCAR Command Language (This is used for generating forcing files for the operational runs)

      5) wget ---command line webbrowser (this is normally included in linux/unix box, and it is 
                 used for downloading data from USGS, NWLON, etc). This is used to download 
                 data and webpages from various sources
 
      6) curl ---command line ftp data retriever (this is normally included in linux/unix box, and 
                 it is used to download NARR (North American Regional Reanalysis) meteorological data  
                 to generate surface forcing.

      7) NCO  ---NetCDF Operators (this is also used to manipulate grib files from NARR, and generate
                 netcdf data files for NARR data) NCO is can be pretty hard to install
		 see notes in COMF/oqcs/support_softwares

      8) mexnc  ---a tool box that enables matlab to manipulate netcdf files easily. Called by the 
                   forcing making matlab scripts  and post-process matlab scripts.
                   This is a third party toolbox for matlab, and it is free under GPL license.
                   Please get it from internet such as 

                   https://sourceforge.net/project/showfiles.php?group_id=119464&package_id=139428
            or
                   http://mexcdf.sourceforge.net/downloads/

      9) awk    ---command line file/text processor (used in various locations in retrieving data downloaded
                   from USGS, NWLON etc. Normally it  is already installed in linux/unix box)
     
     10) shapelib--C libraray to make GIS shapfiles. You will need it for operational runs
                  to compile chesroms2shp for postprocess.  You can download it from 
                  http://shapelib.maptools.org/  and http://shapelib.maptools.org/dl, please use 
                  version 1.2.9 

     11) NetCDF Toolbox

               ---A set of matlab .m progams to access and modify netcdf files.
                  http://sourceforge.net/project/showfiles.php?group_id=119464&package_id=130914 
                  and 
                  http://sourceforge.net/project/showfiles.php?group_id=119464&package_id=130912

     12) perl  ---word processing language, normally installed on linux/unix machines. Perl is used
                 in OQCS for data retrieval.

     13) SNCTOOLS --netcdf tools used for creating tidal forcing in MACROMS

    How to download and install:

      1)goto soureforge chesroms project site: http://sourceforge.net/projects/macroms/ 

      2)download the code in $HOME/MACROMS/ directory  

      3)cd MACROMS

      4)follow ./readme_install.txt for setup and usage


MACROMS team
2009-05-10