PoreSim 0.2
  • API
  • Simulation
  • Complex Pore Simulation
  • Simulation 2-Phase
  • Site
    • Page
        • Simulate
          • Simulate
    • Simulate
      • Simulate
    Source

    Simulate¶

    class poresim.simulate.Simulate(link='./simulation/', box=None)¶

    This class generates the simulation folder for a series of simulations.

    The output of this class can then be uploaded to a computing cluster.

    Parameters:
    linkstring, optional

    Simulation folder link

    boxBox, list, optional

    Simulation box object, a series of those

    Methods

    _update_config()

    Update simulation config file.

    add_box(box)

    Add simulation box to simulation dictionary.

    generate()

    Generate simulation folder.

    get_box()

    Return the simulation box dictionary.

    get_sim_dict()

    Return the simulation dictionary.

    set_box(box)

    Set the simulation box.

    set_cluster(cluster)

    Set the dictionary containing all cluster preferences.

    set_job(job)

    Set the dictionary containing all simulation information.

    set_param(param)

    Set the dictionary containing all systems parameters.

    set_sim_dict(sim_dict)

    Set the simulation dictionary.

    Back to top

    © Copyright 2023, Hamzeh Kraus.
    Created using Sphinx 7.4.6.