.. _api_start:

Programmatic Interface
======================

.. automodule:: bfrescox

Infrastructure
--------------
.. autofunction:: bfrescox.test
.. autofunction:: bfrescox.information
.. autofunction:: bfrescox.print_information

Simulation Configuration
------------------------
.. autoclass:: bfrescox.Configuration
   :members:

Template Generation
-------------------
.. autofunction:: bfrescox.generate_elastic_template
.. autofunction:: bfrescox.generate_inelastic_template

Execution & Results
-------------------
.. autofunction:: bfrescox.run_simulation
.. autofunction:: bfrescox.parse_fort16
.. autofunction:: bfrescox.parse_performance_results
.. autofunction:: bfrescox.parse_parallelization_setup