Skip to content

Commit 4bf8834

Browse files
committed
Changed headers in README
1 parent 0d7faa8 commit 4bf8834

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.org

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ As such amino acid "residues" are usually part of the fundamental datastructures
99
Design decisions like this and others are essentially isomorphic to the way textbooks write about these molecules.
1010
My experience was that while this is convenient for simple systems more complicated systems with many proteins, small molecules, etc. quickly become difficult to query and manipulate.
1111

12-
Overarching Goals:
12+
** Overarching Goals
1313
1) An abstract layer for representing multi-atom structures and selections that is extensible via object-oriented programming in Python.
1414
2) An applied layer of advanced subclasses that represents the objects (Features) which are more isomorphic to textbook knowledge including:
1515
- Organic chemistry features e.g. functional groups
@@ -29,26 +29,23 @@ Overarching Goals:
2929
- profiling of receptor-ligand interactions
3030
- profiling of protein-protein interactions
3131

32-
Design Goals:
32+
** Design Goals
3333
1) Separation of types (i.e. classes; e.g. protein topology) and instances (i.e. type + coordinates).
3434
2) Separation and development of both expressive and complete patterns.
3535
2) Ability to incorporate data from many other libraries representations easily via an extensible interface.
3636
3) Ability to use portions of this library as a stable and fairly future-proof solution across the python ecosystem.
3737
4) Minimal core dependencies, with optional features provided by other libraries.
3838

39-
Other goals:
39+
** Other goals
4040
1) Language agnostic file-format for storing objects and preserving complex relations within them, i.e. hdf5.
4141
2) Ability to export representations to many other commonly used formats (PDB dialects perhaps?).
4242
3) Optimization and parallelization built in.
4343
4) Optional type system (via python type hints and mypy) for developing and debugging the construction of molecules and systems.
4444
5) API for accessing databases of Features.
4545

46+
** Usage
4647
The immediate "killer feature" will be for easily profiling intermolecular interactions, but there is definitely potential for use in setting up complex multi-molecular systems, structural analyses, and complex distance metric calculations in enhanced sampling simulations.
4748

48-
49-
50-
51-
5249
* Version numbers
5350

5451
See [[http://semver.org/]] for version number meanings.

0 commit comments

Comments
 (0)