pyvibdmc.simulation_utilities.sim_archive
=========================================

.. py:module:: pyvibdmc.simulation_utilities.sim_archive


Classes
-------

.. autoapisummary::

   pyvibdmc.simulation_utilities.sim_archive.SimArchivist


Module Contents
---------------

.. py:class:: SimArchivist

   A utility class for saving wave functions, checkpoint files, and reloading DMC sims


   .. py:method:: save_h5(fname, keyz, valz)
      :staticmethod:


      Helper function to take in keys and values and save them in an hdf5 file
      :param fname: The name of the hdf5 file to be saved
      :param keyz: The keys used in saving the hdf5 file
      :param valz: The values that correspond to each key



   .. py:method:: chkpt(dmc_obj, prop_step)
      :staticmethod:


      Given a DMC object and its current time step , this will save it as a .pickle file (excluding the potential!)



   .. py:method:: reload_sim(chkpt_folder, sim_name)
      :staticmethod:


      Given a .pickle file, reinitialize the DMC object and reassign potential.
      :return: DMC Object for one to run.