GitHub - willsheffler/pymol: pymol scripts

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 54 Commits
data		data
david_examples		david_examples
docs		docs
ide		ide
lib		lib
log		log
misc		misc
tools		tools
.gitignore		.gitignore
README		README
SymFile.py		SymFile.py
SymTrie.py		SymTrie.py
extract_pymol_commands		extract_pymol_commands
gl_example.py		gl_example.py
helix_util.py		helix_util.py
inspector.py		inspector.py
marshmallows.py		marshmallows.py
minimock.py		minimock.py
misc.py		misc.py
motif_util.py		motif_util.py
packing_utils.py		packing_utils.py
pymol_plot3d.py		pymol_plot3d.py
pymol_util.py		pymol_util.py
pytest.ini		pytest.ini
server.py		server.py
setup.cfg		setup.cfg
soccerball_faces.py		soccerball_faces.py
space_group.py		space_group.py
sym_comp.py		sym_comp.py
sym_util.py		sym_util.py
symgen.py		symgen.py
symgen_test.py		symgen_test.py
test.py		test.py
test_matplotlib.py		test_matplotlib.py
xyzGeom.py		xyzGeom.py
xyzMath.py		xyzMath.py

Repository files navigation

open ./doc/build/html/index.html

In case that doesn't work, here are the basics:

You *should* be able to run / import these file without changing your path

To test, run 'python -m unittest discover' in the pymol directory. 
To test an individual module, run that file and it will do all the doctests.

To build docs, you need Sphinx (I use v1.1.3), which is the standard python doc generator
cd into doc and 'make html'. You can add docs as you like in the docstrings and in doc/source.

xyzGeom is unused, but will replace xyzMath at some point