Difference between revisions of "Sandbox"

From Geos-chem
Jump to: navigation, search
 
(156 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== feel free to experiment here ==
+
== Instructions for adding tracers to GEOS-Chem ==
  
<!-- ======================================================== -->
+
'''''By [mailto:mpayer@seas.harvard.edu Melissa Payer]'''''
<!-- ===== TOP TITLE                                    ===== -->
+
<!-- ======================================================== -->
+
<table width="100%" border="1" bordercolor="#000000" cellspacing="0" cellpadding="5" align="center">
+
<tr bgcolor="#FF0000">
+
<th colspan="2" height="80" valign="middle"><p><font color="#FFFFFF" size="+3">GEOS&#150;Chem Wiki</font></p></th>
+
</tr>
+
</table>
+
  
<!-- ======================================================== -->
+
These instructions describe how to add advected tracers to GEOS-Chem.  Advected tracers are carried in the <tt>STT</tt> array (which is declared in <tt>GeosCore/tracer_mod.F</tt>), and are transported by the winds. 
<!-- ===== GENERAL INFO ABOUT GEOS-CHEM                ===== -->
+
<!-- ======================================================== -->
+
<p>&nbsp;</p>
+
<table width="100%" border="1" bordercolor="#000000" cellspacing="0" cellpadding="5" align="center">
+
  
<tr bgcolor="#00AAAA">
+
NOTE: Some advected tracers are also chemical species, which comprise GEOS-Chem's NOx-Ox-HC-aerosol chemistry mechanism.
<th colspan="2" height="50" valign="middle"><p><font color="#FFFFFF" size="+2">General information about GEOS&#150;Chem</font></p></th>
+
</tr>
+
  
<!-- ======================================================== -->
+
#<p>Add tracers to input.geos under Tracer Menu</p>
<!-- ===== GENERAL INFO : FIRST ROW                    ===== -->
+
##<p>Increase “Number of tracers” accordingly</p>
<!-- ======================================================== -->
+
##<p>Add tracer number, name, molecular weight, and emitted species to end of tracer list</p>
 +
#<p>Add tracer(s) to restart file – see separate instructions</p>
 +
#<p>Modify the following source code routines:</p>
 +
##<p><tt>Headers/CMN_SIZE_mod.F</tt></p>
 +
###<p>Increase <tt>NNPAR</tt> by number of tracers being added</p>
 +
###<p>If the species have anthropogenic emissions, increase NEMPARA accordingly</p>
 +
###<p>If the species have biogenic emissions, increase NEMPARB accordingly</p>
 +
###<p>If the species have biomass burning emissions, increase NBIOMAX accordingly</p>
 +
##<p><tt>GeosCore/tracerid_mod.F</tt></p>
 +
###<p>Increase <tt>NNNTRID</tt> by the number of tracers being added NOTE: <tt>NNNTRID</tt> must be equal to <tt>NNPAR</tt> in <tt>CMN_SIZE_mod.F</tt></p>
 +
###<p>Define tracer IDs as needed:</p>
 +
####<p>IDxxxx – ID for SMVGEAR species</p>
 +
####<p>IDTxxxx – GEOS-Chem tracer ID</p>
 +
####<p>IDExxxx – GEOS-Chem emission ID</p>
 +
####<p>IDBFxxxx – GEOS-Chem biofuel ID</p>
 +
####<p>IDBxxxx – GEOS-Chem biomass ID</p>
 +
###<p>In subroutine <tt>TRACERID</tt>,</p>
 +
####<p>Under “Assign tracer, biomass, biofuel, and anthro emission ID’s,” add case for added tracers to initialize IDTxxxx, IDBFxxxx, IDBxxxx</p>
 +
####<p>Under “Initialize the IDExxx flags,” add IF statement for added tracer IDs and initialize IDExxxx</p>
 +
####<p>Under “Fill IDEMS with appropriate tracer ID #’s,” add IF statement for added tracers</p>
 +
####<p>Under “Print additional information,” add WRITE statements for added tracers</p>
 +
###<p>In subroutine SETTRACE  (NOTE: Only do the following if species is included in SMVGEAR chemical mechanism<p>
 +
####<p>Add IF statement, to initialize IDxxxx</p>
 +
####<p>In subroutine INIT_TRACERID,</p>
 +
####<p>Zero all IDs added (IDxxxx, IDTxxxx, IDExxxx, etc.)</p>
 +
##<p>Other modules that may need to be updated include:</p>
 +
###<p>wetscav_mod.F</p>
 +
###<p>drydep_mod.F</p>
 +
###<p>emissions_mod.F</p>
 +
###<p>biomass_mod.F</p>
 +
###<p>biofuel_mod.F</p> etc.
  
<!-- Header title -->
 
<tr bgcolor="#cccccc">
 
<th width="50%"scope="col"><big>Introduction and overview</big></th>
 
<th width="50%"scope="col"><big>Steering Committee And Working Groups</big></th>
 
</tr>
 
  
<tr>
 
  
<!-- Introduction & Overview: Links -->
+
Instructions for adding species to GEOS-Chem
<td width="50%" valign="top">
+
* [[Features of the GEOS-Chem public wiki]]
+
* [[GEOS-Chem welcome letter for new users]]
+
* [http://acmg.seas.harvard.edu/geos/geos_overview.html GEOS-Chem Overview]
+
* [http://acmg.seas.harvard.edu/geos/geos_people.html GEOS-Chem People & Projects]
+
* [http://acmg.seas.harvard.edu/geos/word_pdf_docs/resources_guidelines_tips.pdf User Resources, Code Development Guidelines, and Debugging Tips]
+
* [[GEOS-Chem programming staff]]
+
* [[GEOS-Chem newsletters]]
+
</td>
+
  
<!-- Steering Committee and Working Groups: Links -->
+
Modify run directory files
<td width="50%" valign="top">
+
* [http://acmg.seas.harvard.edu/geos/geos_steering_cmte.html GEOS-Chem Steering Committee]
+
** [[GEOS-Chem model development priorities]]
+
* [http://acmg.seas.harvard.edu/geos/geos_working_groups.html GEOS-Chem Working Groups]
+
** [[GEOS-Chem Adjoint|Adjoint Model and Data Assimilation Working Group]]
+
** [[Aerosols_overview:_projects_and_developments|Aerosols Working Group]]
+
** [[Carbon Gases and Organics Working Group]]
+
** [[Emissions Working Group]]
+
** [[Chemistry Issues|Oxidants and Chemistry Working Group]]
+
** [[Regional Air Quality Working Group]]
+
</td>
+
  
</tr>
+
1) Add tracers to input.geos under Tracer Menu
 +
c) Increase “Number of tracers” accordingly
 +
d) Add tracer number, name, molecular weight, and emitted species to end of tracer list
  
<!-- ======================================================== -->
+
2) Add tracer(s) to restart file – see separate instructions
<!-- ===== GENERAL INFO : SECOND ROW                    ===== -->
+
<!-- ======================================================== -->
+
  
<!-- Header title -->
+
3) Modify globchem.dat to include additional species, kinetic reactions (including emissions and drydep), or photolysis reactions
<tr bgcolor="#cccccc">
+
NOTE: If you modify globchem.dat and plan to run GEOS-Chem using the KPP chemical solver, you will need to generate new gckpp*.F90 files. For more information see the following wiki pages:
<th width="50%"scope="col"><big>Getting Started With GEOS-Chem</big></th>
+
http://wiki.seas.harvard.edu/geos-chem/index.php/KPP_solvers_FAQ#What_are_the_cons_of_using_KPP.3F
<th width="50%"scope="col"><big>General Technical Information</big></th>
+
http://wiki.seas.harvard.edu/geos-chem/index.php/Interfacing_GEOS-Chem_with_KPP#Generating_KPP_input_files_from_GEOS-Chem_globchem.dat
</tr>
+
  
<tr>
+
4) If necessary, modify:
 
+
a) ratj.d – contains species names and branching ratios for FAST–JX photolysis species
<!-- Getting Started With GEOS-Chem: Links -->
+
For more information: http://acmg.seas.harvard.edu/geos/doc/man/chapter_5.html#5.4.1
<td width="50%" valign="top">
+
b) jv_spec.dat – contains cross-sections and quantum yields for FAST–JX photolysis species
* [[Minimum system requirements for GEOS-Chem]]
+
For more information: http://acmg.seas.harvard.edu/geos/doc/man/chapter_5.html#5.4.3
* [[GEOS-Chem supported platforms and compilers]]
+
* [[Downloading GEOS-Chem source code and data]]
+
* [[GEOS-Chem code development cycle]]
+
* [[GEOS-Chem programming resources]] (e.g. tutorials, user guides, etc.)
+
* [http://acmg.seas.harvard.edu/geos/doc/man/appendix_7.html GEOS-Chem Programming Style Guide]
+
* [[Running GEOS-Chem with TESTRUN]]
+
</td>
+
 
+
<!-- General Technical Information: Links -->
+
<td width="50%" valign="top">
+
* [[Initial conditions for GEOS-Chem]]
+
* [[GEOS-Chem Debugging Tips|Tips on how to debug GEOS-Chem effectively]]
+
* [[Reporting GEOS-Chem bugs]]
+
* [[Parallelizing GEOS-Chem]] with the OpenMP directives
+
* [[Common GEOS-Chem error messages]]
+
* [http://acmg.seas.harvard.edu/geos/geos_search.html GEOS-Chem Search Engines]
+
</td>
+
 
+
</tr>
+
</table>
+
 
+
<!-- ======================================================== -->
+
<!-- ===== CODE DEVELOPER'S FORUMS: TITLE              ===== -->
+
<!-- ======================================================== -->
+
<p>&nbsp;</p>
+
<table width="100%" border="1" bordercolor="#000000" cellspacing="0" cellpadding="5" align="center">
+
 
+
<tr bgcolor="#00AAAA">
+
<th colspan="2" height="50" valign="middle"><p><font color="#FFFFFF" size="+2">GEOS&#150;Chem Code Developers' Forums</font></p></th>
+
</tr>
+
 
+
<!-- ======================================================== -->
+
<!-- ===== CODE DEVELOPER'S FORUMS : FIRST ROW          ===== -->
+
<!-- ======================================================== -->
+
<tr bgcolor="#cccccc">
+
<th width="50%"scope="col"><big>Coding</big></th>
+
<th width="50%"scope="col"><big>Diagnostics</big></th>
+
</tr>
+
 
+
<tr>
+
 
+
<!-- Coding: Links -->
+
<td width="50%" valign="top">
+
* [[GEOS-Chem versions under development]]
+
* [[Machine issues & portability]]
+
* [[Floating point math issues]]
+
* [[Bugs and fixes|List of GEOS-Chem bugs and in which version they were resolved]]
+
</td>
+
 
+
<!-- Diagnostics: Links -->
+
<td width="50%" valign="top">
+
* [http://acmg.seas.harvard.edu/geos/doc/man/appendix_5.html Overview of diagnostics characteristics]
+
* [[Mass Flux (ND24/25/26)]]
+
* [[Additional diagnostics]]
+
</td>
+
 
+
</tr>
+
 
+
<!-- ======================================================== -->
+
<!-- ===== CODE DEVELOPER'S FORUMS : SECOND ROW        ===== -->
+
<!-- ======================================================== -->
+
 
+
<!-- Header title -->
+
<tr bgcolor="#cccccc">
+
<th width="50%"scope="col"><big>Emissions</big></th>
+
<th width="50%"scope="col"><big>Chemistry</big></th>
+
</tr>
+
 
+
<tr>
+
 
+
<!-- Emissions: Links -->
+
<td width="50%" valign="top">
+
* [[Overview]]
+
* [[Aircraft emissions]]
+
* [[Anthropogenic emissions]]
+
** [http://acmg.seas.harvard.edu/geos/word_pdf_docs/emissions_v8_02_03.pdf Description of anthropogenic emissions inventories in GEOS-Chem v8-02-03]
+
** [http://wiki.seas.harvard.edu/geos-chem/images/Anth_emiss_gc_v8-01-04.pdf Description of anthropogenic emissions inventories in GEOS-Chem v8-01-04]
+
** [http://acmg.seas.harvard.edu/geos/word_pdf_docs/INVENTORY_GC_public-pre_v8.pdf Table of available anthropogenic emissions inventories for use w/ GEOS-Chem (pre-v8)]
+
* [[Biofuel emissions]]
+
* [[Biogenic emissions]]
+
* [[Biomass burning emissions]]
+
* [[Lightning NOx emissions]]
+
</td>
+
 
+
<!-- Chemistry Links -->
+
<td width="50%" valign="top">
+
* [[Chemistry Issues]]
+
* [[NOx-Ox-HC-aerosol|NOx-Ox-hydrocarbon-aerosol (aka "full-chemistry") simulation]]
+
* [[Photolysis mechanism]]
+
* [[Mercury|Mercury simulation]]
+
* [[Tagged CO simulation]]
+
* [[KPP solvers FAQ]]
+
* [[Isoprene]]
+
* [[Linoz stratospheric ozone chemistry]]
+
</td>
+
 
+
</tr>
+
 
+
<!-- ======================================================== -->
+
<!-- ===== CODE DEVELOPER'S FORUMS : THIRD ROW          ===== -->
+
<!-- ======================================================== -->
+
<tr bgcolor="#cccccc">
+
<th width="50%"scope="col"><big>Nested Grid Simulations</big></th>
+
<th width="50%"scope="col"><big>Earth System Model Framework</big></th>
+
</tr>
+
 
+
<tr>
+
 
+
<!-- Nested Grid Simulations: Links -->
+
<td width="50%" valign="top">
+
* [[GEOS-Chem nested grid simulations]]
+
* [[Available met data for nested grid simulations]]
+
** [http://acmg.seas.harvard.edu/geos/wiki_docs/nested_grids/geos_data_downloads.pdf Protocol for nested-grid data downloads]
+
</td>
+
 
+
<!-- Met Fields: Links -->
+
<td width="50%" valign="top">
+
* [[Installing ESMF and other required libraries]]
+
* [[Code development with the Earth System Model Framework]]
+
* [[Automatic documentation with protex|Generating automatic LaTeX documentation with protex]]
+
** [http://frodo.elon.edu/tutorial/tutorial/tutorial.html Web-based LaTeX tutorial]
+
</td>
+
 
+
</tr>
+
 
+
<!-- ======================================================== -->
+
<!-- ===== CODE DEVELOPER'S FORUMS : FOURTH ROW        ===== -->
+
<!-- ======================================================== -->
+
<tr bgcolor="#cccccc">
+
<th width="50%"scope="col"><big>Related Projects</big></th>
+
<th width="50%"scope="col"><big></big></th>
+
</tr>
+
 
+
<tr>
+
 
+
<!-- Related Projects: Links -->
+
<td width="50%" valign="top">
+
* [[GEOS-Chem column code]]
+
* [[GEOS-Chem Adjoint]]
+
* [[GEOS-Chem Near-Real-Time Simulations]]
+
</td>
+
 
+
<!-- Diagnostics: Links -->
+
<td width="50%" valign="top">
+
 
+
</td>
+
 
+
</tr>
+
</table>
+
 
+
<!-- ======================================================== -->
+
<!-- ===== CODE DEVELOPER'S FORUMS: TITLE              ===== -->
+
<!-- ======================================================== -->
+
<p>&nbsp;</p>
+
<table width="100%" border="1" bordercolor="#000000" cellspacing="0" cellpadding="5" align="center">
+
 
+
<tr bgcolor="#00AAAA">
+
<th colspan="2" height="50" valign="middle"><p><font color="#FFFFFF" size="+2">Reference: Visualization, Analysis, and Wiki</font></p></th>
+
</tr>
+
 
+
<!-- ======================================================== -->
+
<!-- ===== VISUALIZATION : FIRST ROW                    ===== -->
+
<!-- ======================================================== -->
+
<tr bgcolor="#cccccc">
+
<th width="50%"scope="col"><big>IDL</big></th>
+
<th width="50%"scope="col"><big>GAMAP</big></th>
+
</tr>
+
 
+
<tr>
+
 
+
<!-- IDL: Links -->
+
<td width="50%" valign="top">
+
* [http://www.ittvis.com/ ITT Visualization (vendor)]
+
* [http://idlastro.gsfc.nasa.gov/idl_html_help/Structures.html Structures in IDL]
+
* [http://idlastro.gsfc.nasa.gov/idl_html_help/Pointers.html Pointers in IDL]
+
* [http://idlastro.gsfc.nasa.gov/idl_html_help/Overview_of_Mathematics_in_IDL.html Overview of Mathematics in IDL]
+
* [http://www.dfanning.com/ Coyote's Guide to IDL Programming (David Fanning's Web Site)] - Lots of tips on how to accomplish programming tasks
+
* [http://www.mpimet.mpg.de/en/misc/software/idl IDL Page at Max Planck Institute for Meteorology]
+
* [http://www.mpimet.mpg.de/en/misc/software/idl/doc/mgs_script.pdf Martin Schultz's IDL Tutorial (PDF Format)]
+
* [http://idlastro.gsfc.nasa.gov/homepage.html IDL Astronomy User's Library]
+
* [http://fermi.jhuapl.edu/s1r/idl/idl.html JHU/APL/S1R IDL routines page]
+
* [http://cow.physics.wisc.edu/~craigm/idl/idl.html Craig Markwardt's IDL library]
+
* [http://cimss.ssec.wisc.edu/~gumley/doc/idltips.pdf The Underground Guide to IDL by Liam Gumley (PDF)]
+
* [[Reading binary files in IDL]]
+
</td>
+
 
+
<!-- Diagnostics: Links -->
+
<td width="50%" valign="top">
+
* [http://acmg.seas.harvard.edu/gamap/ GAMAP web page]
+
* [http://acmg.seas.harvard.edu/gamap/doc/ GAMAP on-line users' guide]
+
* [[GAMAP bugs and fixes]]
+
* [[GAMAP tips and tricks]]
+
**[[General GAMAP usage]]
+
**[[File I/O with GAMAP]]
+
***[http://acmg.seas.harvard.edu/gamap/doc/timeseries_brief_tutorial.pdf Working with timeseries output in GAMAP]
+
**[[Color and graphics with GAMAP]]
+
*** [http://acmg.seas.harvard.edu/geos/wiki_docs/gamap/gamap_color_table_file.pdf Loading Color Tables in GAMAP v2.12]
+
*** [http://acmg.seas.harvard.edu/forum_files/cdh_ColorInIDL.pdf Working with color in IDL by Chris Holmes]
+
**[[Regridding with GAMAP]]
+
**[[Date and time computations with GAMAP]]
+
**[[Text manipulation with GAMAP]]
+
</td>
+
 
+
</tr>
+
 
+
<!-- ======================================================== -->
+
<!-- ===== VISUALIZATION: SECOND ROW                    ===== -->
+
<!-- ======================================================== -->
+
 
+
<!-- Header title -->
+
<tr bgcolor="#cccccc">
+
<th width="50%"scope="col"><big>Wiki Documentation</big></th>
+
<th width="50%"scope="col"><big></big></th>
+
</tr>
+
 
+
<tr>
+
 
+
<!-- Wiki Documentation: Links -->
+
<td width="50%" valign="top">
+
* [[Sandbox]]
+
* [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
+
* [http://meta.wikimedia.org/wiki/Help:Contents MediaWiki User's Guide]
+
* [http://meta.wikimedia.org/wiki/Help:Wikitext Examples of Wiki markup text]
+
* [http://meta.wikimedia.org/wiki/Help:Reference_card One-page editing reference card]
+
* [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration Settings list]
+
* [http://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
+
</td>
+
 
+
<!-- Spaceholder-->
+
<td width="50%" valign="top">
+
 
+
</td>
+
 
+
</tr>
+
</table>
+

Latest revision as of 21:25, 10 May 2023

Instructions for adding tracers to GEOS-Chem

By Melissa Payer

These instructions describe how to add advected tracers to GEOS-Chem. Advected tracers are carried in the STT array (which is declared in GeosCore/tracer_mod.F), and are transported by the winds.

NOTE: Some advected tracers are also chemical species, which comprise GEOS-Chem's NOx-Ox-HC-aerosol chemistry mechanism.

  1. Add tracers to input.geos under Tracer Menu

    1. Increase “Number of tracers” accordingly

    2. Add tracer number, name, molecular weight, and emitted species to end of tracer list

  2. Add tracer(s) to restart file – see separate instructions

  3. Modify the following source code routines:

    1. Headers/CMN_SIZE_mod.F

      1. Increase NNPAR by number of tracers being added

      2. If the species have anthropogenic emissions, increase NEMPARA accordingly

      3. If the species have biogenic emissions, increase NEMPARB accordingly

      4. If the species have biomass burning emissions, increase NBIOMAX accordingly

    2. GeosCore/tracerid_mod.F

      1. Increase NNNTRID by the number of tracers being added NOTE: NNNTRID must be equal to NNPAR in CMN_SIZE_mod.F

      2. Define tracer IDs as needed:

        1. IDxxxx – ID for SMVGEAR species

        2. IDTxxxx – GEOS-Chem tracer ID

        3. IDExxxx – GEOS-Chem emission ID

        4. IDBFxxxx – GEOS-Chem biofuel ID

        5. IDBxxxx – GEOS-Chem biomass ID

      3. In subroutine TRACERID,

        1. Under “Assign tracer, biomass, biofuel, and anthro emission ID’s,” add case for added tracers to initialize IDTxxxx, IDBFxxxx, IDBxxxx

        2. Under “Initialize the IDExxx flags,” add IF statement for added tracer IDs and initialize IDExxxx

        3. Under “Fill IDEMS with appropriate tracer ID #’s,” add IF statement for added tracers

        4. Under “Print additional information,” add WRITE statements for added tracers

      4. In subroutine SETTRACE (NOTE: Only do the following if species is included in SMVGEAR chemical mechanism<p>

        1. <p>Add IF statement, to initialize IDxxxx

        2. In subroutine INIT_TRACERID,

        3. Zero all IDs added (IDxxxx, IDTxxxx, IDExxxx, etc.)

    3. Other modules that may need to be updated include:

      1. wetscav_mod.F

      2. drydep_mod.F

      3. emissions_mod.F

      4. biomass_mod.F

      5. biofuel_mod.F

        etc.


Instructions for adding species to GEOS-Chem

Modify run directory files

1) Add tracers to input.geos under Tracer Menu c) Increase “Number of tracers” accordingly d) Add tracer number, name, molecular weight, and emitted species to end of tracer list

2) Add tracer(s) to restart file – see separate instructions

3) Modify globchem.dat to include additional species, kinetic reactions (including emissions and drydep), or photolysis reactions NOTE: If you modify globchem.dat and plan to run GEOS-Chem using the KPP chemical solver, you will need to generate new gckpp*.F90 files. For more information see the following wiki pages: http://wiki.seas.harvard.edu/geos-chem/index.php/KPP_solvers_FAQ#What_are_the_cons_of_using_KPP.3F http://wiki.seas.harvard.edu/geos-chem/index.php/Interfacing_GEOS-Chem_with_KPP#Generating_KPP_input_files_from_GEOS-Chem_globchem.dat

4) If necessary, modify: a) ratj.d – contains species names and branching ratios for FAST–JX photolysis species For more information: http://acmg.seas.harvard.edu/geos/doc/man/chapter_5.html#5.4.1 b) jv_spec.dat – contains cross-sections and quantum yields for FAST–JX photolysis species For more information: http://acmg.seas.harvard.edu/geos/doc/man/chapter_5.html#5.4.3