GEOS GCM Documentation and Access: Difference between revisions

From GEOS-5
Jump to navigation Jump to search
← Older edit
mNo edit summary
m Mathomp4 moved page GEOS-5 public AGCM Documentation and Access to GEOS GCM Documentation and Access: GEOS is now GEOS-5 and we should refer to the GCM not AGCM
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
This page describes the minimum steps required to checkout GEOS AGCM.  
This page describes the minimum steps required to checkout GEOS GCM.  


'''NOTE NOTE NOTE:''' This is only to get the '''code''' for the GEOS AGCM. If you wish to use the production output from GEOS as run at the GMAO, please refer to the [https://gmao.gsfc.nasa.gov/GMAO_products/ GMAO page on GEOS products].
'''NOTE NOTE NOTE:''' This is only to get the '''code''' for the GEOS GCM. If you wish to use the production output from GEOS as run at the GMAO, please refer to the [https://gmao.gsfc.nasa.gov/GMAO_products/ GMAO page on GEOS products].


== Checking Out GEOS AGCM using subversion ==
== Checking Out GEOS GCM using Git ==


The commands below assume that you have a svn client installed on your machine.  
The commands below assume that you have git 2.x installed on your machine.  


The first thing you need to do is to register in the GEOS trac system using the following link:
The GEOS GCM can be found here:
https://geos5.org/trac


In order to access the SVN repository as a developer, you need to be approved by the GEOS5 AGCM maintainer at the following email address: [mailto:matthew.thompson@nasa.gov matthew.thompson@nasa.gov]
https://github.com/GEOS-ESM/GEOSgcm


Once approved, you will be able to checkout the source code with the following command:
You can then clone with


  svn --username ''username'' checkout <nowiki>https://geos5.org/svn/branches/Icarus-2_0/</nowiki> GEOSagcm
  git clone https://github.com/GEOS-ESM/GEOSgcm


You can create tickets through the trac system and contribute to the code.
but note that GEOS GCM is what we call a "fixture" that is quite lightweight and you'll see the source tree is mainly empty. In order to get the rest of GEOS, you need to use a utility called [https://github.com/ESMCI/manage_externals checkout_externals]. Once you have that installed, you run:
 
checkout_externals
 
inside the GEOSgcm directory. This then checks out all the sub-repositories needed for GEOS.
 
The code is publicly available, but in order to contribute to the GEOS GCM development, you will need to be added as a collaborator with the [https://github.com/GEOS-ESM GEOS-ESM] organization. Please send an email to [mailto:geos5-support@lists.nasa.gov GEOS Support] with your GitHub username. You can create tickets through the GitHub issue system and contribute to the code.


== Building GEOS ==
== Building GEOS ==


'''NOTE:''' GMAO does '''not''' generally support building or running GEOS on systems other than on NASA Supercomputers. This code access is provided mainly for collaborators with GMAO who are unable to gain access to the GMAO internal version control system.
'''NOTE:''' GMAO does '''not''' generally support building or running GEOS on systems other than on NASA Supercomputers.  


GEOS-5 AGCM can be built, but you will need a variety of programs. An F90 compiler (Intel, PGI, and GCC are tested) and an MPI stack (Open MPI, Intel MPI, MVAPICH2, and SGI MPT have been tested). Beyond that, you'll also need the GMAO Baselibs, a collection of base libraries for GEOS-5 which include HDF5, netCDF-C, netCDF-Fortran, ESMF, and more. Note that while these can be built individually, GEOS-5 at present expects the libraries to be bundled in a specific way (directory-wise) to work.
GEOS GCM can be built, but you will need a variety of programs. An F90 compiler (Intel and GCC are supported and tested) and an MPI stack (Open MPI, Intel MPI, MVAPICH2, and SGI MPT have been tested). Beyond that, you'll also need the [https://github.com/GEOS-ESM/ESMA-Baselibs ESMA Baselibs], a collection of base libraries for GEOS which include HDF5, netCDF-C, netCDF-Fortran, ESMF, and more. Note that while these can be built individually, GEOS at present expects the libraries to be bundled in a specific way (directory-wise) to work.


== Boundary Conditions ==
== Boundary Conditions ==
Line 30: Line 34:


A minimal, small set of boundary conditions of approximately 300 MB (4-degree resolution or coarser, probably could only run a few model days) have been made and could possibly be distributed if needed. Contact [mailto:matthew.thompson@nasa.gov Matthew Thompson] for further inquiries.
A minimal, small set of boundary conditions of approximately 300 MB (4-degree resolution or coarser, probably could only run a few model days) have been made and could possibly be distributed if needed. Contact [mailto:matthew.thompson@nasa.gov Matthew Thompson] for further inquiries.
<!--
Boundary conditions are available by ftp from the GMAO site:
  ftp gmaoftp.gsfc.nasa.gov  (login as anonymous)
  cd /pub/data/takacs/GEOS5/boundary_conditions
There you will find the boundary conditions for the tag Fortuna-2_1.  These bcs are currently being used for tags Fortuna-2_1 and later.
SST and aerosol data are forthcoming.
--!>

Latest revision as of 06:37, 6 December 2019

This page describes the minimum steps required to checkout GEOS GCM.

NOTE NOTE NOTE: This is only to get the code for the GEOS GCM. If you wish to use the production output from GEOS as run at the GMAO, please refer to the GMAO page on GEOS products.

Checking Out GEOS GCM using Git

The commands below assume that you have git 2.x installed on your machine.

The GEOS GCM can be found here: 

https://github.com/GEOS-ESM/GEOSgcm

You can then clone with 

git clone https://github.com/GEOS-ESM/GEOSgcm

but note that GEOS GCM is what we call a "fixture" that is quite lightweight and you'll see the source tree is mainly empty. In order to get the rest of GEOS, you need to use a utility called checkout_externals. Once you have that installed, you run: 

checkout_externals

inside the GEOSgcm directory. This then checks out all the sub-repositories needed for GEOS.

The code is publicly available, but in order to contribute to the GEOS GCM development, you will need to be added as a collaborator with the GEOS-ESM organization. Please send an email to GEOS Support with your GitHub username. You can create tickets through the GitHub issue system and contribute to the code.

Building GEOS

NOTE: GMAO does not generally support building or running GEOS on systems other than on NASA Supercomputers.

GEOS GCM can be built, but you will need a variety of programs. An F90 compiler (Intel and GCC are supported and tested) and an MPI stack (Open MPI, Intel MPI, MVAPICH2, and SGI MPT have been tested). Beyond that, you'll also need the ESMA Baselibs, a collection of base libraries for GEOS which include HDF5, netCDF-C, netCDF-Fortran, ESMF, and more. Note that while these can be built individually, GEOS at present expects the libraries to be bundled in a specific way (directory-wise) to work.

Boundary Conditions

Boundary conditions are available at NCCS, NAS, and on GMAO Desktops (limited to very low-res).

A minimal, small set of boundary conditions of approximately 300 MB (4-degree resolution or coarser, probably could only run a few model days) have been made and could possibly be distributed if needed. Contact Matthew Thompson for further inquiries.

Retrieved from "https://geos5.org/wiki/index.php?title=GEOS_GCM_Documentation_and_Access&oldid=4367"