# DO NOT EDIT !  
from pyesdoc.ipython.model_topic import NotebookOutput  

# DO NOT EDIT !  
DOC = NotebookOutput('cmip6', 'csiro-bom', 'sandbox-2', 'landice')

"""
Explanation: ES-DOC CMIP6 Model Properties - Landice
MIP Era: CMIP6
Institute: CSIRO-BOM
Source ID: SANDBOX-2
Topic: Landice
Sub-Topics: Glaciers, Ice. 
Properties: 30 (21 required)
Model descriptions: Model description details
Initialized From: --  
Notebook Help: Goto notebook help page
Notebook Initialised: 2018-02-15 16:53:56
Document Setup
IMPORTANT: to be executed each time you run the notebook
End of explanation
"""


# Set as follows: DOC.set_author("name", "email")  
# TODO - please enter value(s)

"""
Explanation: Document Authors
Set document authors
End of explanation
"""


# Set as follows: DOC.set_contributor("name", "email")  
# TODO - please enter value(s)

"""
Explanation: Document Contributors
Specify document contributors
End of explanation
"""


# Set publication status:  
# 0=do not publish, 1=publish.   
DOC.set_publication_status(0)

"""
Explanation: Document Publication
Specify document publication status
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.key_properties.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: Document Table of Contents
1. Key Properties
2. Key Properties --&gt; Software Properties
3. Grid
4. Glaciers
5. Ice
6. Ice --&gt; Mass Balance
7. Ice --&gt; Mass Balance --&gt; Basal
8. Ice --&gt; Mass Balance --&gt; Frontal
9. Ice --&gt; Dynamics  
1. Key Properties
Land ice key properties
1.1. Overview
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Overview of land surface model.
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.key_properties.model_name')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 1.2. Model Name
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Name of land surface model code
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.key_properties.ice_albedo')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "prescribed"  
#      "function of ice age"  
#      "function of ice density"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)


"""
Explanation: 1.3. Ice Albedo
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: ENUM&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.N
Specify how ice albedo is modelled
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.key_properties.atmospheric_coupling_variables')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 1.4. Atmospheric Coupling Variables
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Which variables are passed between the atmosphere and ice (e.g. orography, ice mass)
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.key_properties.oceanic_coupling_variables')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 1.5. Oceanic Coupling Variables
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Which variables are passed between the ocean and ice
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.key_properties.prognostic_variables')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "ice velocity"  
#      "ice thickness"  
#      "ice temperature"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)


"""
Explanation: 1.6. Prognostic Variables
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: ENUM&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.N
Which variables are prognostically calculated in the ice model
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.key_properties.software_properties.repository')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 2. Key Properties --&gt; Software Properties
Software properties of land ice code
2.1. Repository
Is Required: FALSE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 0.1
Location of code for this component.
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.key_properties.software_properties.code_version')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 2.2. Code Version
Is Required: FALSE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 0.1
Code version identifier.
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.key_properties.software_properties.code_languages')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 2.3. Code Languages
Is Required: FALSE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 0.N
Code language(s).
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.grid.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 3. Grid
Land ice grid
3.1. Overview
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Overview of the grid in the land ice scheme
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.grid.adaptive_grid')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)


"""
Explanation: 3.2. Adaptive Grid
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: BOOLEAN&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Is an adative grid being used?
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.grid.base_resolution')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)


"""
Explanation: 3.3. Base Resolution
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: FLOAT&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
The base resolution (in metres), before any adaption
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.grid.resolution_limit')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)


"""
Explanation: 3.4. Resolution Limit
Is Required: FALSE&nbsp;&nbsp;&nbsp;&nbsp;Type: FLOAT&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 0.1
If an adaptive grid is being used, what is the limit of the resolution (in metres)
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.grid.projection')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 3.5. Projection
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
The projection of the land ice grid (e.g. albers_equal_area)
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.glaciers.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 4. Glaciers
Land ice glaciers
4.1. Overview
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Overview of glaciers in the land ice scheme
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.glaciers.description')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 4.2. Description
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Describe the treatment of glaciers, if any
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.glaciers.dynamic_areal_extent')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)


"""
Explanation: 4.3. Dynamic Areal Extent
Is Required: FALSE&nbsp;&nbsp;&nbsp;&nbsp;Type: BOOLEAN&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 0.1
Does the model include a dynamic glacial extent?
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.overview')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 5. Ice
Ice sheet and ice shelf
5.1. Overview
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Overview of the ice sheet and ice shelf in the land ice scheme
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.grounding_line_method')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "grounding line prescribed"  
#      "flux prescribed (Schoof)"  
#      "fixed grid size"  
#      "moving grid"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)


"""
Explanation: 5.2. Grounding Line Method
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: ENUM&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Specify the technique used for modelling the grounding line in the ice sheet-ice shelf coupling
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.ice_sheet')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)


"""
Explanation: 5.3. Ice Sheet
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: BOOLEAN&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Are ice sheets simulated?
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.ice_shelf')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)


"""
Explanation: 5.4. Ice Shelf
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: BOOLEAN&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Are ice shelves simulated?
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.mass_balance.surface_mass_balance')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 6. Ice --&gt; Mass Balance
Description of the surface mass balance treatment
6.1. Surface Mass Balance
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Describe how and where the surface mass balance (SMB) is calulated. Include the temporal coupling frequeny from the atmosphere, whether or not a seperate  SMB model is used, and if so details of this model, such as its resolution
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.mass_balance.basal.bedrock')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 7. Ice --&gt; Mass Balance --&gt; Basal
Description of basal melting
7.1. Bedrock
Is Required: FALSE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 0.1
Describe the implementation of basal melting over bedrock
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.mass_balance.basal.ocean')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 7.2. Ocean
Is Required: FALSE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 0.1
Describe the implementation of basal melting over the ocean
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.mass_balance.frontal.calving')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 8. Ice --&gt; Mass Balance --&gt; Frontal
Description of claving/melting from the ice shelf front
8.1. Calving
Is Required: FALSE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 0.1
Describe the implementation of calving from the front of the ice shelf
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.mass_balance.frontal.melting')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 8.2. Melting
Is Required: FALSE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 0.1
Describe the implementation of melting from the front of the ice shelf
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.dynamics.description')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value("value")  
# TODO - please enter value(s)


"""
Explanation: 9. Ice --&gt; Dynamics
**
9.1. Description
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: STRING&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
General description if ice sheet and ice shelf dynamics
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.dynamics.approximation')  

# PROPERTY VALUE(S): 
# Set as follows: DOC.set_value("value")  
# Valid Choices: 
#      "SIA"  
#      "SAA"  
#      "full stokes"  
#      "Other: [Please specify]"  
# TODO - please enter value(s)


"""
Explanation: 9.2. Approximation
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: ENUM&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.N
Approximation type used in modelling ice dynamics
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.dynamics.adaptive_timestep')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# Valid Choices: 
#     True  
#     False  
# TODO - please enter value(s)


"""
Explanation: 9.3. Adaptive Timestep
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: BOOLEAN&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Is there an adaptive time scheme for the ice scheme?
End of explanation
"""


# PROPERTY ID - DO NOT EDIT !  
DOC.set_id('cmip6.landice.ice.dynamics.timestep')  

# PROPERTY VALUE: 
# Set as follows: DOC.set_value(value)  
# TODO - please enter value(s)


"""
Explanation: 9.4. Timestep
Is Required: TRUE&nbsp;&nbsp;&nbsp;&nbsp;Type: INTEGER&nbsp;&nbsp;&nbsp;&nbsp;Cardinality: 1.1
Timestep (in seconds) of the ice scheme. If the timestep is adaptive, then state a representative timestep.
End of explanation
"""


