BornProfiler
latest
  • Overview
  • Building and installing BornProfiler
  • User documentation
  • Developer documentation
    • Core functionality — bornprofiler.core
    • APBS calculations: Membrane simulations — bornprofiler.electrostatics
    • Analysis of calculations — bornprofiler.analysis
    • Configuration file handling and setup — bornprofiler.config
    • Input/Output for the BornProfiler modules — bornprofiler.io
    • Setting up logging — bornprofiler.log
    • Helper functions and classes — bornprofiler.utilities
  • References
BornProfiler
  • Docs »
  • Developer documentation
  • Edit on GitHub

Developer documentation¶

Most users will likely use BornProfiler through the provided scripts. However, in order to extend functionality and develop new tools one can also use the bornprofiler Python module as a library.

Content:

  • Core functionality — bornprofiler.core
  • APBS calculations: Membrane simulations — bornprofiler.electrostatics
  • Analysis of calculations — bornprofiler.analysis
  • Configuration file handling and setup — bornprofiler.config
    • Format
    • Meaning of variables
    • Accessing the configuration
  • Input/Output for the BornProfiler modules — bornprofiler.io
  • Setting up logging — bornprofiler.log
  • Helper functions and classes — bornprofiler.utilities
    • Classes
    • Functions
Next Previous

© Copyright 2013, Lennard van der Feltz, Kaihsu Tai, Oliver Beckstein Revision 1869d7ec.

Built with Sphinx using a theme provided by Read the Docs.