========================
Release notes for v0.4.0
========================

.. note:: These release notes are currently in production.

..
  When documenting a bug fix or feature, please do so in the following format

..
  - `Fixed typo in depcode.py <https://github.com/arfc/saltproc/pull/xx>`_ by @pr_author_username

..
  Links to packages/issues/bug fixes/contributors/reviewers

.. _jsonschema: https://github.com/Julian/jsonschema
.. _@yardasol: https://github.com/yardasol
.. _@abachma2: https://github.com/abachma2
.. _@ZoeRichter: https://github.com/ZoeRichter
.. _@gwenchee: https://github.com/gwenchee
.. _@LukeSeifert: https://github.com/LukeSeifert
.. _@munkm: https://github.com/munkm


Summary
=======

..
  Describe generally the features of this release

This version of SaltProc refactors the code in preparation for supporting ``OpenMC``.


Dependency Changes
==================

..
  Describe any new/removed/modified package dependencies

- Saltproc now requires the following packages

  - (new) → `jsonschema`_


New Features
============

..
  Describe any new features to the code.

- `Refactor app.py and simulation.py to prepare for OpenMC support <https://github.com/arfc/saltproc/pull/98>`_ by `@yardasol`_
- `New input file format that is checked against a verifiable JSON Schema <https://github.com/arfc/saltproc/pull/98>`_ by `@yardasol`_
- `Release notes in the online docs <https://github.com/arfc/saltproc/pull/115>`_ by `@yardasol`_


Bug Fixes
=========

..
  Describe any bug fixes.

- `Fix typos in process_j312.bash <https://github.com/arfc/saltproc/pull/100>`_


Script Changes
==============

..
  Describe any script additions/modifications/removals

- The following scripts have been renamed:

  - ``process_j312.sh`` → ``process_j312.bash``


Python API Changes
==================

- New tests for previously untested functions in ``simulation.py``:

  - ``test_check_switch_geo_trigger``
  - ``test_store_after_repr``
  - ``test_store_mat_data``
  - ``test_store_run_init_info``
  - ``test_store_run_step_info``
 
- The following class methods have been added/(re)moved:

  - ``App.check_restart()`` → ``Simulation.check_restart()``
  - ``Simulation.switch_to_next_geometry`` → ``DepcodeSerpent.switch_to_next_geometry``
  - ``Simulation.runsim_no_reproc`` → ``test/integration_tests/test_no_reproc_run.py::runsim_no_reproc``
  - ``Simulation.store_run_step_info``
  - ``Simulation.store_run_init_info``
  - (new) → ``Depcode.switch_to_next_geometry``
  - (new) → ``Depcode.read_depcode_info``
  - (new) → ``Depcode.read_repcode_step_param``
  - ``DepcodeSerpent.sss_meta_zzz`` → ``DepcodeSerpent.convert_nuclide_name_serpent_to_zam``
  - ``DepcodeSerpent.get_tra_or_dec`` → ``DepcodeSerpent.create_nuclide_name_map_zam_to_serpent`` 
  - ``DepcodeSerpent.read_depcode_template`` → ``DepcodeSerpent.read_plaintext_file``

- Updated input file structure:

  - ``App.depcode_inp`` dictionary

    - (new) → ``App.depcode_inp['codename']``
    - ``App.exec_path``
    - ``App.template_file``
    - ``App.neutron_pop`` → ``App.depcode_inp['npop']``
    - ``App.active_cycles``
    - ``App.inactive_cycles``
    - ``App.geo_file`` → ``App.depcode_inp['geo_file_paths']``

  - ``App.simulation_inp`` dictionary:

    - (new) → ``App.simulation['sim_name']``
    - ``App.db_file`` → ``App.simulation['db_name']``
    - ``App.restart_flag``
    - ``App.adjust_geo``

  - ``App.reactor_inp`` dictionary

    - (new) → ``App.reactor_inp['volume']``
    - (new) → ``App.reactor_inp['mass_flowrate']``
    - ``App.power_levels``
    - ``App.depl_hist`` → ``App.reactor_inp['dep_step_length_cumulative']``

- The following class attributes have been added/(re)moved:

  - ``Depcode`` class:

    - ``template_path`` → ``template_inputfile_path``
    - ``input_path`` → ``iter_inputfile``
    - ``geo_file`` → ``geo_files``

  - ``Simulation`` class:

    - ``h5_file`` → ``db_path``
    - (new) → ``restart_flag``
    - (new) → ``adjust_geo``
    - ``iter_matfile`` → (removed)

- The signatures for the following class methods have changed to better make use of object data encapsulation:

  - ``Depcode.read_dep_comp``
  - ``Depcode.write_depcode_input``
  - ``Depcode.write_mat_file``
  - ``DepcodeSerpent.read_depcode_template``
  - ``DepcodeSerpent.create_nuclide_map_serpent_to_zam``

Contributors
============

..
  List of people who contributed features and fixes to this release

The following people contributed code to this release of SaltProc:

..
  `@gh_username <https://github.com/gh_uname>`_

- `@yardasol`_


Reviewers
=========

..
  List of people who reviewed PRs for this release

The following people reviewed code for this release of SaltProc:

..
  `@gh_username <https://github.com/gh_uname>`_

- `@abachma2`_
- `@ZoeRichter`_
- `@gwenchee`_
- `@LukeSeifert`_
- `@munkm`_