-
Notifications
You must be signed in to change notification settings - Fork 12
API
Alex Marchenko edited this page Jan 23, 2016
·
10 revisions
The atomic universe contains numerous data frames of potentially related information (the three types of DataFrames used are inherited from exa's base data frame classes, see exa-analytics/exa Wiki). Here is a layout of how this new organizational structure applies to the atomic package:
| Concept | utility | class | type | index | foreign keys | attributes |
|---|---|---|---|---|---|---|
| frame | public | Frame | DataFrame | frame | - | atom_count |
| atom | public | Atom | DataFrame | atom | frame | x, y, z, symbol, label |
| unitatom | private | UnitAtom | Updater | atom | - | x, y, z |
| superatom | private | SuperAtom | DataFrame | satom | frame, atom | x, y, z, symbol |
| vizatom | private | VizAtom | Updater | atom | - | x, y, z |
| two | public | TwoBody | DataFrame | two | frame | distance, bond, symbols |
| supertwo | private | SuperTwo | DataFrame | stwo | frame | distance, bond, symbols |
| atomtwo | private | AtomTwo | ManyToMany | - | atom, two | - |
| satomstwo | private | SAtomSTwo | ManyToMany | - | satom, stwo | - |
| orbital | public | Orbital | DataFrame | orbital | frame | occupation, energy |
What about:
| Concept | utility | class | type | index | foreign keys | attributes |
|---|---|---|---|---|---|---|
| frame | public | Frame | DataFrame | frame | - | atom_count |
| atom | public | Atom | DataFrame | atom | frame | x, y, z, symbol, label |
| unit_atom | private | UnitAtom | Updater | atom | - | x, y, z |
| prj_atom | private | ProjectedAtom | DataFrame | prjatom | frame, atom | x, y, z, symbol |
| viz_atom | private | VizAtom | Updater | atom | - | x, y, z |
| two | public | TwoBody | DataFrame | two | frame | distance, bond, symbols |
| prj_two | private | ProjectedTwo | DataFrame | prjtwo | frame | distance, bond, symbols |
| atomtwo | private | AtomTwo | ManyToMany | - | atom, two | - |
| prjatomtwo | private | SuperAtomTwo | ManyToMany | - | prjat, prjtwo | - |
| orbital | public | Orbital | DataFrame | orbital | frame | occupation, energy |
| molecule | public | Molecule | DataFrame | molecule | frame | cx, cy, cz, mass, simple |
| prj_molecule | public | ProjectedMolecule | DataFrame | molecule | frame | cx, cy, cz, mass, simple |