A collection of utilities used by our lab for computational biophysics
Project description
klab - The Kortemme Lab Tools Repository
========================
A collection of utilities used by our lab for computational biophysics, including PDB parsing, SGE cluster submission scripts, and interfaces with the Rosetta macromolecular software suite.
Coding convention
=================
Besides the whitespace convention (spaces, not tabs), contributors can / generally do use their own preferences. However, code within a module should follow a consistent convention. Finally, please do not reformat modules created by other developers to your preferences.
Here are some semi-standard guidelines:
- General rules : The PEP 8 conventions (https://www.python.org/dev/peps/pep-0008/) are mostly sensible.
- Blank lines : See "Blank Lines" in PEP 8. Particularly, surround top-level function and class definitions with two blank lines.
- Line length : Up to the module creator programmer.
- Whitespace : Use spaces instead of tabs, with indents set to 4 spaces. Feel free to nuke any tabbed indents with prejudice.
- Import order : Import standard Python packages first (sys, os) then higher-level/add-on packages (sqlalchemy, numpy), then our other packages (klab), then this package (kddg). Put a line break between each section of imports.
- Natural language : Please do not introduce contractions into alien modules unless that is the usual for that module.
Installation
============
This package can be installed via:
::
pip install klab
To install via pip and allow git push/pulling, use:
In a virtualenv:
::
pip install -e git+ssh://git@github.com/Kortemme-Lab/klab.git#egg=klab
In your user-directory:
::
pip install --user -e git+ssh://git@github.com/Kortemme-Lab/klab.git#egg=klab
In your user-directory, without using SSH:
::
pip install --user -e git+https://github.com/Kortemme-Lab/klab.git#egg=klab
========================
A collection of utilities used by our lab for computational biophysics, including PDB parsing, SGE cluster submission scripts, and interfaces with the Rosetta macromolecular software suite.
Coding convention
=================
Besides the whitespace convention (spaces, not tabs), contributors can / generally do use their own preferences. However, code within a module should follow a consistent convention. Finally, please do not reformat modules created by other developers to your preferences.
Here are some semi-standard guidelines:
- General rules : The PEP 8 conventions (https://www.python.org/dev/peps/pep-0008/) are mostly sensible.
- Blank lines : See "Blank Lines" in PEP 8. Particularly, surround top-level function and class definitions with two blank lines.
- Line length : Up to the module creator programmer.
- Whitespace : Use spaces instead of tabs, with indents set to 4 spaces. Feel free to nuke any tabbed indents with prejudice.
- Import order : Import standard Python packages first (sys, os) then higher-level/add-on packages (sqlalchemy, numpy), then our other packages (klab), then this package (kddg). Put a line break between each section of imports.
- Natural language : Please do not introduce contractions into alien modules unless that is the usual for that module.
Installation
============
This package can be installed via:
::
pip install klab
To install via pip and allow git push/pulling, use:
In a virtualenv:
::
pip install -e git+ssh://git@github.com/Kortemme-Lab/klab.git#egg=klab
In your user-directory:
::
pip install --user -e git+ssh://git@github.com/Kortemme-Lab/klab.git#egg=klab
In your user-directory, without using SSH:
::
pip install --user -e git+https://github.com/Kortemme-Lab/klab.git#egg=klab
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
klab-0.4.1.tar.gz
(503.4 kB
view details)
File details
Details for the file klab-0.4.1.tar.gz
.
File metadata
- Download URL: klab-0.4.1.tar.gz
- Upload date:
- Size: 503.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 667c51901ca0185c511c81ed0d005df100a9b5e63537bf01c17affed18df90f8 |
|
MD5 | 379f25a760d2e49d6a3fa333dd36bcb0 |
|
BLAKE2b-256 | c794fff58e073c8a05d9ad8b3535d4e531e10b079616339adc693b4610eee900 |