Documentation
This Documentation is yet very incomplete. By contrast, the Biskit
source code consist to about 30 % of doc strings and comments. Most modules have
moreover quite instructive unit test cases... If you want to familiarize yourself with Biskit, please first read the Quick overview, then you could inspect 'using PDBModel' and browse over the tutorial for getting a taste of the further possibilities. The end-user scripts in biskit/scripts give some good examples for using the library. From there you can poke through the source code of the different classes. Last not least, feel free to contact us with any question or suggestion! |
Introduction
start here!
Basics
follow the links to external tutorials
- Numpy
- array handling (overview)
- take
- compress & masks (condition arrays)
- finding help and documentation
- Python dir
- Biskit.tools.info
Handling structures
How to deal with static structures, incomplete
- using PDBModel
- PDBDope
Handling trajectories
Manipulate and analyze molecular dynamics trajectories
Handling complexes
Manipulate and analyze protein-protein complexes, interfaces, and docking results
- the Biskit.Dock package
- Complex
- ComplexList
Interfaces with external programs
Tutorials & Examples
Step-by step examples
Extending Biskit
Hints for extending and modifying Biskit itself
- Testing Biskit Modules
- Checking code coverage
- SVN Howto
- wrap external applications (Executor)
- Parallelizing tasks
- Writing end-user scripts
- Creating workflows
- Various hints
- Creating a new release
Troubleshooting
If things don't work as advertised...
API reference
epydoc-generated API documentation (usually a bit outdated)