Modified creation of cyclus input from PRIS data

input/predicting-the-past/templates/recipes_template.xml

@@ -63,14 +63,14 @@
   </recipe>
   <recipe>
     <name>cool_spent_uox</name>
-    <basis>atom</basis>
+    <basis>mass</basis>
     {% for key, value in spent.items() -%}
     <nuclide> <id>{{ key }}</id> <comp>{{ value }}</comp> </nuclide>
     {% endfor -%}
   </recipe>
   <recipe>
     <name>casked_spent_uox</name>
-    <basis>atom</basis>
+    <basis>mass</basis>
     {% for key, value in spent.items() -%}
     <nuclide> <id>{{ key }}</id> <comp>{{ value }}</comp> </nuclide>
     {% endfor -%}

input/predicting-the-past/templates/united_states/united_states_template.xml

@@ -247,4 +247,4 @@
         <xi:include href="united_states/buildtimes/{{country}}/deployinst.xml"/></config>
     </institution>{% endfor %}</region>
   <xi:include href="united_states/recipes/uox_{{burnup}}.xml#xpointer(/recipes/child::*)"/>
-</simulation>
+</simulation>

input/predicting-the-past/united_states.ipynb

@@ -1640,7 +1640,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.4"
+   "version": "3.6.11"
   },
   "varInspector": {
    "cols": {

scripts/create_input.py

@@ -0,0 +1,55 @@
+import pandas as pd
+import sys
+
+import predicting_the_past_import as import_data
+
+# user defined characteristics of cyclus simulation
+data_year = 2020
+start_year = 1965
+region = 'united_states'
+project = 'haleu'
+
+import_data.merge_coordinates('../database/Year-end Reactor Status_' + str(data_year) + '.csv',
+                              '../database/coordinates.sqlite', data_year)
+
+pris_file = '../database/reactors_pris_' + str(data_year) + '.csv'
+deployinst_tmpl = '../input/predicting-the-past/templates/' + \
+    region + '/deployinst_template.xml'
+inclusions_tmpl = '../input/predicting-the-past/templates/inclusions_template.xml'
+deployment_path = '../input/' + project + '/inputs/' + region + '/buildtimes'
+reactor_path = '../input/' + project + '/inputs/' + region + '/reactors'
+reactor_template = '../input/predicting-the-past/templates/reactors_template.xml'
+
+
+pris = import_data.import_csv(pris_file)
+
+
+recipes = import_data.import_csv('../database/vision_recipes/uox.csv', ',')
+recipe_template = import_data.load_template(
+    '../input/predicting-the-past/templates/recipes_template.xml')
+burnups = [33, 51, 100]
+for bu in burnups:
+    fresh = import_data.get_composition_fresh(recipes, bu)
+    spent = import_data.get_composition_spent(recipes, bu)
+    import_data.write_recipes(fresh, spent, recipe_template, bu, region)
+
+reactor_list = import_data.select_region(pris, region)
+import_data.write_reactors(
+    reactor_list,
+    reactor_path,
+    reactor_template,
+    18,
+    1)  # change cycle and refuel time
+buildtime = import_data.deploy_reactors(pris_file, region, start_year, deployinst_tmpl,
+                                        inclusions_tmpl, reactor_path, deployment_path)
+
+cyclus_tmpl = ('../input/predicting-the-past/templates/' +
+               region + '/' + region + '_template.xml')
+import_data.render_cyclus(
+    cyclus_tmpl,
+    region,
+    buildtime,
+    '../input/' +
+    project +
+    '/inputs/',
+    51)  # change burn up

scripts/predicting_the_past_import.py

@@ -43,10 +43,18 @@ def import_pris(pris_link):
     """
     pris = pd.read_csv(pris_link,
                        delimiter=',',
-                       encoding='iso-8859-1'
+                       encoding='iso-8859-1',
+                       skiprows=20,
                        )
-    pris.insert(13, 'Latitude', np.nan)
-    pris.insert(14, 'Longitude', np.nan)
+
+    pris = pris.rename(columns={pris.columns[2]: 'Country'})
+    pris = pris[['Country', 'Unit', 'Current Status', 'Type',
+                 'Model', 'Operator', 'Reactor Supplier', 'Const. Date',
+                 'Grid Date', 'Shutdown Date', 'RUP [MWe]']]
+    pris.insert(11, 'Latitude', np.nan)
+    pris.insert(12, 'Longitude', np.nan)
+    pris = pris[pris.Unit.notnull()]
+    pris = pris[pris.Unit != 'Unit']
     pris = pris.replace(np.nan, '')
     return pris
 
@@ -172,7 +180,7 @@ def is_int(str):
     return answer
 
 
-def merge_coordinates(pris_link, scrape_link):
+def merge_coordinates(pris_link, scrape_link, data_year):
     """ Obtains coordinates from webscrape.sqlite and
     writes them to matching reactors in PRIS reactor file.
 
@@ -182,6 +190,8 @@ def merge_coordinates(pris_link, scrape_link):
         path and name of pris reactor text file
     scrape: str
         path and name of webscrape sqlite file
+    data_year: int
+        year the data is pulled from
 
     Returns
     -------
@@ -196,20 +206,45 @@ def merge_coordinates(pris_link, scrape_link):
             webscrape_name = sanitize_webscrape_name(web['name'])
             pris_name = sanitize_pris_name(prs[1])
             if fuzz.ratio(webscrape_name, pris_name) > 78:
-                prs[13] = web['lat']
-                prs[14] = web['long']
+                prs[11] = web['lat']
+                prs[12] = web['long']
             else:
                 for other in others.keys():
                     edge_case_key = other.lower()
                     edge_case_value = others[other].lower()
                     if fuzz.ratio(pris_name, edge_case_key) > 80:
                         if fuzz.ratio(webscrape_name, edge_case_value) > 75:
-                            prs[13] = web['lat']
-                            prs[14] = web['long']
-    pris.to_csv('reactors_pris_2016.csv', index=False, sep=',')
+                            prs[11] = web['lat']
+                            prs[12] = web['long']
+    pris.to_csv(
+        '../database/reactors_pris_' +
+        str(data_year) +
+        '.csv',
+        index=False,
+        sep=',')
+
+
+def save_output(pris, data_year):
+    """ Saves updated PRIS database as 'reactors_pris_2016.csv'
+
+    Parameters
+    ----------
+    pris: pd.DataFrame
+        updated PRIS database with latitude and longitude info
+    data_year: int
+        year the data is pulled from
+
+    Returns
+    -------
+
+    """
+    pris.to_csv('../database/reactors_pris_' + str(data_year) + '.csv',
+                index=False,
+                sep=',',
+                )
 
 
-def import_csv(in_csv, delimit):
+def import_csv(in_csv, delimit=','):
     """ Imports contents of a csv text file to a list of
     lists.
 
@@ -314,7 +349,8 @@ def get_composition_spent(in_list, burnup):
     return data_dict
 
 
-def write_recipes(fresh_dict, spent_dict, in_template, burnup, region):
+def write_recipes(fresh_dict, spent_dict, in_template,
+                  burnup, region='united_states'):
     """ Renders jinja template using fresh and spent fuel composition.
 
     Parameters
@@ -335,7 +371,7 @@ def write_recipes(fresh_dict, spent_dict, in_template, burnup, region):
     null
         generates recipe files for cyclus.
     """
-    out_path = 'cyclus/input/' + region + '/recipes/'
+    out_path = '../input/haleu/inputs/' + region + '/recipes/'
     pathlib.Path(out_path).mkdir(parents=True, exist_ok=True)
     rendered = in_template.render(fresh=fresh_dict,
                                   spent=spent_dict)
@@ -389,7 +425,7 @@ def confirm_deployment(date_str, capacity):
         try:
             date.parse(date_str)
             is_deployed = True
-        except:
+        except BaseException:
             pass
     return is_deployed
 
@@ -410,21 +446,24 @@ def select_region(in_list, region):
     reactor_list: list
             list of reactors from PRIS
     """
-    ASIA = {'IRAN', 'JAPAN', 'KAZAKHSTAN',
+    ASIA = {'IRAN, ISLAMIC REPUBLIC OF', 'JAPAN',
+            'KAZAKHSTAN',
             'BANGLADESH', 'CHINA', 'INDIA',
             'UNITED ARAB EMIRATES', 'VIETNAM',
-            'PAKISTAN', 'PHILIPPINES', 'SOUTH KOREA'
+            'PAKISTAN', 'PHILIPPINES', 'KOREA, REPUBLIC OF',
+            'KAZAKHSTAN', 'ARMENIA', 'TAIWAM. CHINA'
             }
-    UNITED_STATES = {'UNITED STATES'}
+    UNITED_STATES = {'UNITED STATES OF AMERICA'}
     SOUTH_AMERICA = {'ARGENTINA', 'BRAZIL'}
-    NORTH_AMERICA = {'CANADA', 'MEXICO', 'UNITED STATES'}
+    NORTH_AMERICA = {'CANADA', 'MEXICO', 'UNITED STATES OF AMERICA'}
     EUROPE = {'UKRAINE', 'UNITED KINGDOM',
               'POLAND', 'ROMANIA', 'RUSSIA',
               'BELARUS', 'BELGIUM', 'BULGARIA',
               'GERMANY', 'ITALY', 'NETHERLANDS',
               'SWEDEN', 'SWITZERLAND', 'TURKEY',
               'SLOVENIA', 'SOVIET UNION', 'SPAIN',
-              'CZECHOSLOVAKIA', 'FINLAND', 'FRANCE'
+              'CZECH REPUBLIC', 'FINLAND', 'FRANCE',
+              'SLOVAKIA', 'HUNGARY', 'LITHUANIA'
               }
     AFRICA = {'EGYPT', 'MOROCCO', 'SOUTH AFRICA', 'TUNISIA'}
     ALL = (SOUTH_AMERICA | NORTH_AMERICA |
@@ -442,8 +481,8 @@ def select_region(in_list, region):
     for row in in_list:
         country = row[0]
         if country.upper() in regions[region.upper()]:
-            capacity = row[3]
-            start_date = row[10]
+            capacity = row[10]
+            start_date = row[8]
             if confirm_deployment(start_date, capacity):
                 reactor_list.append(row)
     return reactor_list
@@ -465,8 +504,8 @@ def get_lifetime(in_row):
     lifetime: int
         lifetime of reactor
     """
-    comm_date = in_row[10]
-    shutdown_date = in_row[11]
+    comm_date = in_row[8]
+    shutdown_date = in_row[9]
     if not shutdown_date.strip():
         return 720
     else:
@@ -475,7 +514,8 @@ def get_lifetime(in_row):
         return int(delta / n_days_month)
 
 
-def write_reactors(in_list, out_path, reactor_template):
+def write_reactors(in_list, out_path, reactor_template,
+                   cycle_time=18, refuel_time=1):
     """ Renders CYCAMORE::reactor specifications using jinja2.
 
     Parameters
@@ -486,6 +526,10 @@ def write_reactors(in_list, out_path, reactor_template):
         output path for reactor files
     reactor_template: str
         path to reactor template
+    cycle_time: int
+        cycle length of reactors in months
+    refuel_time: int
+        average refuel time in months
 
     Returns
     -------
@@ -497,15 +541,15 @@ def write_reactors(in_list, out_path, reactor_template):
     pathlib.Path(out_path).mkdir(parents=True, exist_ok=True)
     reactor_template = load_template(reactor_template)
     for row in in_list:
-        capacity = float(row[3])
+        capacity = float(row[10])
         if capacity >= 400:
             name = row[1].replace(' ', '_')
             assem_per_batch = 0
             assem_no = 0
             assem_size = 0
-            reactor_type = row[2]
-            latitude = row[13] if row[13] != '' else 0
-            longitude = row[14] if row[14] != '' else 0
+            reactor_type = row[3]
+            latitude = row[11] if row[11] != '' else 0
+            longitude = row[12] if row[12] != '' else 0
             if reactor_type in ['BWR', 'ESBWR']:
                 assem_no = 732
                 assem_per_batch = int(assem_no / 3)
@@ -536,10 +580,12 @@ def write_reactors(in_list, out_path, reactor_template):
                 assem_size = 103000 / assem_no
             config = reactor_template.render(name=name,
                                              lifetime=get_lifetime(row),
+                                             cycletime=cycle_time,
+                                             refueltime=refuel_time,
                                              assem_size=assem_size,
                                              n_assem_core=assem_no,
                                              n_assem_batch=assem_per_batch,
-                                             power_cap=row[3],
+                                             power_cap=row[10],
                                              lon=longitude,
                                              lat=latitude)
             with open(out_path + name.replace(' ', '_') + '.xml',
@@ -636,7 +682,7 @@ def get_buildtime(in_list, start_year, path_list):
     """
     buildtime_dict = {}
     for row in in_list:
-        comm_date = date.parse(row[10])
+        comm_date = date.parse(row[8])
         start_date = [comm_date.year, comm_date.month, comm_date.day]
         delta = ((start_date[0] - int(start_year)) * 12 +
                  (start_date[1]) +
@@ -692,7 +738,7 @@ def deploy_reactors(in_csv, region, start_year, deployinst_template,
     return buildtime
 
 
-def render_cyclus(cyclus_template, region, in_dict, out_path):
+def render_cyclus(cyclus_template, region, in_dict, out_path, burn_up=50):
     """ Renders final CYCLUS input file with xml base, and institutions
     for each country
 
@@ -706,7 +752,10 @@ def render_cyclus(cyclus_template, region, in_dict, out_path):
         in_dict should be buildtime_dict from get_buildtime function
     out_path: str
         output path for CYCLUS input file
-    output_name:
+    data_year: int
+        year the data was pulled from
+    burn_up: int
+        burnup in GWd/MTU
 
     Returns
     -------
@@ -717,7 +766,8 @@ def render_cyclus(cyclus_template, region, in_dict, out_path):
         out_path += '/'
     cyclus_template = load_template(cyclus_template)
     country_list = {value[0].replace(' ', '_') for value in in_dict.values()}
-    rendered = cyclus_template.render(countries=country_list,
+    rendered = cyclus_template.render(burnup=burn_up,
+                                      countries=country_list,
                                       base_dir=os.path.abspath(out_path) + '/')
     with open(out_path + region + '.xml', 'w') as output:
         output.write(rendered)