Skip to content

Commit

Permalink
Final 0.2 changes
Browse files Browse the repository at this point in the history
  • Loading branch information
samirelanduk committed Jun 14, 2017
1 parent 6b15c05 commit 324b1a4
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 8 deletions.
24 changes: 24 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,20 @@ distance to that:
>>> atom.distance_to(model.center_of_mass())
1.3371237139950765

Atoms can be bonded to one another using the ``Atom.bond`` method:

>>> other_atom = model.atom(element="O")
>>> atom.bond(other_atom)
>>> atom.bonds()
{"<C-O Bond>"}
>>> atom.bonded_atoms()
{<O Atom at (37.441, 29.265, 52.113)>}
>>> atom.unbond(other_atom)
>>> atom.bonds()
{}
>>> atom.bonded_atoms()
{}


Saving
~~~~~~
Expand All @@ -150,6 +164,16 @@ The ``Xyz`` object itself can also be saved:
Changelog
---------

Release 0.2.0
~~~~~~~~~~~~~

`14 June 2017`

* Made all Atomic Structures savable.
* Added Atom IDs and uniqueness constraints.
* Added Atom Bonds.


Release 0.1.1
~~~~~~~~~~~~~

Expand Down
2 changes: 1 addition & 1 deletion atomium/structures/atoms.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ def atom_id(self, atom_id=None):
will be updated, provided it is a unique integer.
:param int atom_id: If given, the ID will be set to this.
:param TypeError: if the ID given is not numeric.
:raises TypeError: if the ID given is not numeric.
:raises ValueError: if the ID given is already in use."""

if atom_id is None:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Converters
.. toctree ::
api/strings
api/string2xyz
api/model2xyzstring
api/structure2xyzstring
6 changes: 0 additions & 6 deletions docs/source/api/model2xyzstring.rst

This file was deleted.

6 changes: 6 additions & 0 deletions docs/source/api/structure2xyzstring.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
``atomium.converters.structure2xyzstring`` (Structure to .xyz conversion)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: atomium.converters.structure2xyzstring
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Changelog
---------

Release 0.2.0
~~~~~~~~~~~~~

`14 June 2017`

* Made all Atomic Structures savable.
* Added Atom IDs and uniqueness constraints.
* Added Atom Bonds.


Release 0.1.1
~~~~~~~~~~~~~

Expand Down

0 comments on commit 324b1a4

Please sign in to comment.