55 < head >
66 < meta charset ="utf-8 " />
77 < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
8- < title > cdds.common.plugins.base.base_plugin — CDDS documentation</ title >
8+ < title > cdds.common.plugins.base.base_plugin — CDDS 2.5.0 documentation</ title >
99 < link rel ="stylesheet " type ="text/css " href ="../../../../../_static/pygments.css " />
1010 < link rel ="stylesheet " type ="text/css " href ="../../../../../_static/nature.css " />
1111 < script data-url_root ="../../../../../ " id ="documentation_options " src ="../../../../../_static/documentation_options.js "> </ script >
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
2525 < li class ="right " >
2626 < a href ="../../../../../py-modindex.html " title ="Python Module Index "
2727 > modules</ a > |</ li >
28- < li class ="nav-item nav-item-0 "> < a href ="../../../../../index.html "> CDDS documentation</ a > »</ li >
28+ < li class ="nav-item nav-item-0 "> < a href ="../../../../../index.html "> CDDS 2.5.0 documentation</ a > »</ li >
2929 < li class ="nav-item nav-item-1 "> < a href ="../../../../index.html " accesskey ="U "> Module code</ a > »</ li >
3030 < li class ="nav-item nav-item-this "> < a href =""> cdds.common.plugins.base.base_plugin</ a > </ li >
3131 </ ul >
@@ -37,7 +37,7 @@ <h3>Navigation</h3>
3737 < div class ="body " role ="main ">
3838
3939 < h1 > Source code for cdds.common.plugins.base.base_plugin</ h1 > < div class ="highlight "> < pre >
40- < span > </ span > < span class ="c1 "> # (C) British Crown Copyright 2021-2022 , Met Office.</ span >
40+ < span > </ span > < span class ="c1 "> # (C) British Crown Copyright 2021-2023 , Met Office.</ span >
4141< span class ="c1 "> # Please see LICENSE.rst for license details.</ span >
4242< span class ="sd "> """</ span >
4343< span class ="sd "> The :mod:`base_plugin` module contains the basic code for plugins.</ span >
@@ -48,7 +48,7 @@ <h1>Source code for cdds.common.plugins.base.base_plugin</h1><div class="highlig
4848
4949
5050< div class ="viewcode-block " id ="MipEra "> < a class ="viewcode-back " href ="../../../../../plugins/plugins.base.html#cdds.common.plugins.base.base_plugin.MipEra "> [docs]</ a > < span class ="k "> class</ span > < span class ="nc "> MipEra</ span > < span class ="p "> (</ span > < span class ="n "> Enum</ span > < span class ="p "> ):</ span >
51- < span class ="sd "> """</ span >
51+ < span class =" w " > </ span > < span class ="sd "> """</ span >
5252< span class ="sd "> MIP eras of projects (e.g. cmip6, cmip7, ...)</ span >
5353
5454< span class ="sd "> At the moment, only cmip6 is supported. That will change</ span >
@@ -57,7 +57,7 @@ <h1>Source code for cdds.common.plugins.base.base_plugin</h1><div class="highlig
5757
5858< div class ="viewcode-block " id ="MipEra.from_str "> < a class ="viewcode-back " href ="../../../../../plugins/plugins.base.html#cdds.common.plugins.base.base_plugin.MipEra.from_str "> [docs]</ a > < span class ="nd "> @staticmethod</ span >
5959 < span class ="k "> def</ span > < span class ="nf "> from_str</ span > < span class ="p "> (</ span > < span class ="n "> str_value</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="s1 "> 'MipEra'</ span > < span class ="p "> :</ span >
60- < span class ="sd "> """</ span >
60+ < span class =" w " > </ span > < span class ="sd "> """</ span >
6161< span class ="sd "> Returns the corresponding MIP era to the given string representation.</ span >
6262
6363< span class ="sd "> :param str_value: MIP era as string</ span >
@@ -72,7 +72,7 @@ <h1>Source code for cdds.common.plugins.base.base_plugin</h1><div class="highlig
7272
7373< div class ="viewcode-block " id ="MipEra.is_cmip "> < a class ="viewcode-back " href ="../../../../../plugins/plugins.base.html#cdds.common.plugins.base.base_plugin.MipEra.is_cmip "> [docs]</ a > < span class ="nd "> @staticmethod</ span >
7474 < span class ="k "> def</ span > < span class ="nf "> is_cmip</ span > < span class ="p "> (</ span > < span class ="n "> mip_era</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="nb "> bool</ span > < span class ="p "> :</ span >
75- < span class ="sd "> """</ span >
75+ < span class =" w " > </ span > < span class ="sd "> """</ span >
7676< span class ="sd "> Checks if given project is a CMIP project.</ span >
7777
7878< span class ="sd "> :param mip_era: ID of project to check (case-sensitive check!)</ span >
@@ -87,7 +87,7 @@ <h1>Source code for cdds.common.plugins.base.base_plugin</h1><div class="highlig
8787
8888< div class ="viewcode-block " id ="MipEra.is_gcmodeldev "> < a class ="viewcode-back " href ="../../../../../plugins/plugins.base.html#cdds.common.plugins.base.base_plugin.MipEra.is_gcmodeldev "> [docs]</ a > < span class ="nd "> @staticmethod</ span >
8989 < span class ="k "> def</ span > < span class ="nf "> is_gcmodeldev</ span > < span class ="p "> (</ span > < span class ="n "> mip_era</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="nb "> bool</ span > < span class ="p "> :</ span >
90- < span class ="sd "> """</ span >
90+ < span class =" w " > </ span > < span class ="sd "> """</ span >
9191< span class ="sd "> Checks if given project is a GcModelDev project.</ span >
9292
9393< span class ="sd "> :param mip_era: ID of project to check (case-sensitive check!)</ span >
@@ -100,12 +100,20 @@ <h1>Source code for cdds.common.plugins.base.base_plugin</h1><div class="highlig
100100 < span class ="k "> return</ span > < span class ="kc "> True</ span >
101101 < span class ="k "> return</ span > < span class ="kc "> False</ span > </ div >
102102
103+ < div class ="viewcode-block " id ="MipEra.is_cordex "> < a class ="viewcode-back " href ="../../../../../plugins/plugins.base.html#cdds.common.plugins.base.base_plugin.MipEra.is_cordex "> [docs]</ a > < span class ="nd "> @staticmethod</ span >
104+ < span class ="k "> def</ span > < span class ="nf "> is_cordex</ span > < span class ="p "> (</ span > < span class ="n "> mip_era</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="nb "> bool</ span > < span class ="p "> :</ span >
105+ < span class ="k "> for</ span > < span class ="n "> cordex</ span > < span class ="ow "> in</ span > < span class ="p "> [</ span > < span class ="n "> MipEra</ span > < span class ="o "> .</ span > < span class ="n "> CORDEX</ span > < span class ="p "> ]:</ span >
106+ < span class ="k "> if</ span > < span class ="n "> mip_era</ span > < span class ="o "> ==</ span > < span class ="n "> cordex</ span > < span class ="o "> .</ span > < span class ="n "> value</ span > < span class ="p "> :</ span >
107+ < span class ="k "> return</ span > < span class ="kc "> True</ span >
108+ < span class ="k "> return</ span > < span class ="kc "> False</ span > </ div >
109+
103110 < span class ="n "> CMIP6</ span > < span class ="o "> =</ span > < span class ="s2 "> "CMIP6"</ span >
104- < span class ="n "> GC_MODEL_DEV</ span > < span class ="o "> =</ span > < span class ="s2 "> "GCModelDev"</ span > </ div >
111+ < span class ="n "> GC_MODEL_DEV</ span > < span class ="o "> =</ span > < span class ="s2 "> "GCModelDev"</ span >
112+ < span class ="n "> CORDEX</ span > < span class ="o "> =</ span > < span class ="s2 "> "CORDEX"</ span > </ div >
105113
106114
107115< div class ="viewcode-block " id ="BasePlugin "> < a class ="viewcode-back " href ="../../../../../plugins/plugins.base.html#cdds.common.plugins.base.base_plugin.BasePlugin "> [docs]</ a > < span class ="k "> class</ span > < span class ="nc "> BasePlugin</ span > < span class ="p "> (</ span > < span class ="n "> CddsPlugin</ span > < span class ="p "> ,</ span > < span class ="n "> ABC</ span > < span class ="p "> ):</ span >
108- < span class ="sd "> """</ span >
116+ < span class =" w " > </ span > < span class ="sd "> """</ span >
109117< span class ="sd "> Abstract class that provides some basic functionality for plugins.</ span >
110118< span class ="sd "> """</ span >
111119
@@ -142,13 +150,13 @@ <h3>Navigation</h3>
142150 < li class ="right " >
143151 < a href ="../../../../../py-modindex.html " title ="Python Module Index "
144152 > modules</ a > |</ li >
145- < li class ="nav-item nav-item-0 "> < a href ="../../../../../index.html "> CDDS documentation</ a > »</ li >
153+ < li class ="nav-item nav-item-0 "> < a href ="../../../../../index.html "> CDDS 2.5.0 documentation</ a > »</ li >
146154 < li class ="nav-item nav-item-1 "> < a href ="../../../../index.html " > Module code</ a > »</ li >
147155 < li class ="nav-item nav-item-this "> < a href =""> cdds.common.plugins.base.base_plugin</ a > </ li >
148156 </ ul >
149157 </ div >
150158 < div class ="footer " role ="contentinfo ">
151- © Copyright 2022, The Climate Data Delivery Team .
159+ © Copyright British Crown 2015-2023, Met Office .
152160 Created using < a href ="https://www.sphinx-doc.org/ "> Sphinx</ a > 4.2.0.
153161 </ div >
154162 </ body >
0 commit comments