File: phases.rst

package info (click to toggle)
pyxrd 0.8.4-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,848 kB
  • sloc: python: 26,500; sh: 301; makefile: 128
file content (50 lines) | stat: -rw-r--r-- 904 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
Phases module
=============

The phases module contains a number of classes that allow to create complex
mixed-layer phases. 

TODO: add example code on how to use them!

Phase
-----

.. module:: pyxrd.phases.models.phase
.. autoclass:: Phase
   :members:

CSDS
----
   
.. module:: pyxrd.phases.models.CSDS
.. autoclass:: LogNormalCSDSDistribution
   :members:
.. autoclass:: DritsCSDSDistribution
   :members:

Unit-cell properties
--------------------

.. module:: pyxrd.phases.models.unit_cell_prop
.. autoclass:: UnitCellProperty
   :members:

Component
---------
   
.. module:: pyxrd.phases.models.component
.. autoclass:: Component
   :members:
   
Atom Relations
--------------
   
.. module:: pyxrd.phases.models.atom_relations
.. autoclass:: AtomRelation
   :members:
.. autoclass:: AtomRatio
   :members:
.. autoclass:: AtomContentObject
   :members:
.. autoclass:: AtomContents
   :members: