3.0 release updates (#4)

* deleted benchmarks directory

* Updated README

* Deleted old README

* Added LICENSE

LICENSE

@@ -0,0 +1,106 @@
+NCAR TIE-GCM OPEN SOURCE ACADEMIC RESEARCH LICENSE AGREEMENT
+
+1. License.  The University Corporation for Atmospheric Research (UCAR), The
+National Center for Atmospheric Research (NCAR), and the High Altitude
+Observatory (HAO) grant you a non-exclusive, non-transferable, world-wide,
+royalty-free license to use, reproduce, and prepare derivative works of the
+NCAR Thermosphere-Ionosphere-Electrodynamics General Circulation Model
+(TIE-GCM) software ("Software") for research, academic, and non-profit purposes
+only. This license applies to TIE-GCM Version 2, Version 3  and subsequent 
+(3.xx) versions. Any and all licenses issued for earlier versions do not apply 
+to this version.
+
+2. Basis.  This software was written by Raymond G. Roble and colleagues, 
+as noted in the individual files. Some of the routines are based on 
+source code obtained from a variety of public domain sources. The Weimer
+model of high-latitude potential is the intellectual property of Daniel
+Weimer and may not be extracted, distributed, or used for any purpose other
+than as implemented in the TIE-GCM. For further information concerning this
+model, please contact Dan Weimer.
+
+3. Restrictions and Use. 
+a. No Sales.  You shall not sell, or license, or transfer for a fee the 
+Software, or any work that in any manner contains the Software, or any
+data products generated by the Software. The Software may not be used for
+operational purposes, i.e., any applications intended to create forecast,
+nowcast, or hindcast products potentially useful for functional description
+of the atmospheric state.
+b. Modifications.  All modifications or changes to the Software and 
+derivative works that incorporate or utilize the Software, shall carry 
+prominent notices stating that you changed the files and the date of the 
+change. Any reproductions of derivative works shall also be on an open 
+source basis. You are requested to transfer such modifications, changes, 
+and/or derivative works back to UCAR.
+c. Copyright/Notices.  Each copy of the Software, modification, or 
+derivative work shall include a file containing this Agreement. Reference 
+to this file will be displayed on any documents, media, printouts, or on 
+any other electronic or tangible expressions associated with, related to 
+or derived from the Software, as follows: "This software is part of the 
+NCAR TIE-GCM. Use is governed by the Open Source Academic Research License 
+Agreement contained in the file tiegcmlicense.txt."
+d. "Rules of the Road."  The academic standards and practices with respect 
+to notification, citation, co-authorship, etc., are specified by the 
+"rules of the road" of the NSF CEDAR project and the NASA TIMED mission
+(c.f., cedarweb.vsp.ucar.edu, www.timed.jhuapl.edu.) 
+
+4. Termination.  Your rights under this Agreement will terminate 
+automatically without notice from UCAR if you fail to comply with any 
+term(s) of this Agreement. The following provisions shall survive 
+termination: Sections 3, 6, 7, and 11. 
+
+5. Proprietary Rights.  Title, ownership rights, and intellectual property 
+rights in the Software shall remain in UCAR. You acknowledge such 
+ownership and intellectual property rights and will not take any action to 
+jeopardize, limit or interfere in any manner with UCAR's ownership of or 
+rights with respect to the Software. 
+
+6. Disclaimer of Warranty on Software.  You expressly acknowledge and agree 
+that use of the Software is at your sole risk. The Software is provided 
+"as is" and without warranty of any kind and UCAR expressly disclaims all 
+warranties and/or conditions of any kind, express or implied, including, 
+but not limited to, any warranties or conditions of title, non-
+infringement of a third party's intellectual property, merchantability or 
+satisfactory quality and fitness for a particular purpose. UCAR does not 
+warrant that the functions contained in the software will meet your 
+requirements, or that the operation of the software will be uninterrupted 
+or error-free, or that defects in the software will be corrected.
+Furthermore, UCAR does not warrant or make any representations and you 
+assume all risk regarding the use or the results of the use of the 
+software or related documentation in terms of their correctness, accuracy, 
+reliability, or otherwise. the parties expressly disclaim that the uniform 
+computer information transactions act (UCITA) applies to or governs this 
+agreement. No oral or written information or advice given by UCAR shall 
+create a warranty or in any way increase the scope of this warranty. 
+Should the Software prove defective, you (and not UCAR or any UCAR 
+representative) assume the cost of all necessary correction. 
+
+7. Limitation of Liability.  Under no circumstances, including negligence, 
+shall UCAR be liable for any direct, incidental, special, indirect or 
+consequential damages including lost revenue, profit or data, whether in 
+an action in contract or tort arising out of or relating to the use of or 
+inability to use the software, even if UCAR has been advised of the 
+possibility of such damages. 
+
+8. Export Law Assurances.  All Software and any technical data delivered 
+under this Agreement are subject to U.S. export control laws and may be 
+subject to export or import regulations in other countries. You agree to 
+comply strictly with all such laws and regulations and you acknowledge 
+that you have responsibility to obtain such license to export, re-export, 
+or import as may be required after delivery to you. 
+
+9. No Support/Modifications.  The Software is provided without any support 
+or maintenance, and without any obligation to provide you with 
+modifications, improvements, enhancements, or updates of the Software.
+
+10. Controlling Law and Severability.  This Agreement shall be governed by 
+the laws of the United States. If for any reason a court of competent 
+jurisdiction finds any provision, or portion thereof, to be unenforceable, 
+the remainder of this Agreement shall continue in full force and effect. 
+This Agreement shall not be governed by the United Nations Convention on 
+Contracts for the International Sale of Goods, the application of which is 
+hereby expressly excluded.
+
+11. Complete Agreement.  This Agreement constitutes the entire agreement 
+between the parties with respect to the use of the Software and supersedes 
+all prior or contemporaneous understandings regarding such subject matter. 
+

README.md

@@ -1,4 +1,25 @@
-Changes of the current version compared to public TIEGCM v2\.0 \(2016\):
+# TEIGCM v3.0
+
+### Documentation: [TIEGCM ReadtheDocs](https://tiegcm-docs.readthedocs.io/en/latest/) 
+
+## Subdirectories and Descriptions
+
+| Subdirectory   | Description           | Summary of Contents                                 |
+|----------------|-----------------------|-----------------------------------------------------|
+| scripts/       | Support scripts       | Job scripts, Make files, Utilities                  |
+| src/           | Source code           | Source files *.F, *.F90, *.h                        |
+| tiegcmrun/       | TIEGCM User Interface      | Python program for pre-processes, build routines and job execution               |
+
+For a brief set of instructions to build the model and make a short default run, see [documentation](https://tiegcm-docs.readthedocs.io/en/latest/).
+
+Please also see the main TGCM website: [TGCM Website](http://www.hao.ucar.edu/modeling/tgcm)
+
+Additional data may be available on the HAO public FTP site: [HAO Public FTP Site](http://download.hao.ucar.edu/pub/tgcm)
+
+User's Guide, Model Description, and Release documentation are available from the on [TIEGCM ReadtheDocs](https://tiegcm-docs.readthedocs.io/en/latest/)).
+
+
+## Changes of the current version compared to public TIEGCM v2\.0 \(2016\):
 
 - The job script is modified to support arbitrary combination of horizontal and vertical resolutions, change of magnetic grids is also supported\.
 - The job script, defs\.h and initialization of some altitude\-dependent variables \(xfac/ar\_glbm/aureff/bdriz\) are rewritten to support the extension of the upper boundary\.
@@ -16,7 +37,7 @@ Changes of the current version compared to public TIEGCM v2\.0 \(2016\):
 - dipmin is set to sin\(dlat\*2\*dtr\) instead of manual setup in different resolutions\.
 - Some minor bug fixes\.
 
-Change of physics:
+### Change of physics:
 - Modified the coefficients of solar heating \(Astrid Maute\)\.
 - Add a scaling factor in accounting for the height variation of equatorward electric field \(elam\) \(Astrid Maute\)\.
 - Include the field\-aligned ion drag in the momentum equation \(Jiuhou Lei\)\.
@@ -25,4 +46,12 @@ Change of physics:
 - Electrojet turbulent heating, default off \(Jing Liu\)\.
 - Empirical SAPS, default off \(Cheng Sheng\)\.
 - Support eclipse solar EUV masking \(Tong Dang\)\.
-- Support lower boundary forcing by external data \(SD nudging, Haonan Wu\)\.
+- Support lower boundary forcing by external data \(SD nudging, Haonan Wu\)\.
+
+### Utility Tools
+
+#### TIEGCMrun
+Tiegcmrun is a Python tool (/tiegcmrun directory) that is used to compile and execute tiegcm in an automated fashion. Tiegcmrun can be executed interactively on the command line. See example of usage under [QuickStart](https://tiegcm-docs.readthedocs.io/en/latest/tiegcm/quickstart.html).
+
+#### [TIEGCMpy](https://tiegcmpy.readthedocs.io/en/latest/)
+Tiegcmpy is a Python tool ([Tiegcmpy github](https://github.com/NCAR/tiegcmpy)) that is used for post processing and data visualization of TIEGCM outputs. Tiegcmpy can be executed interactively on the command line or as an API in a python script. See example of usage [TIEGCMpy Docs](https://tiegcmpy.readthedocs.io/en/latest/).