Documentation To-Do¶
Todo
Add link to exposition(?) of how RotConst expression is developed, once written.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/const.py:docstring of opan.const.EnumUnitsRotConst, line 9.)
Todo
Add object references once the DOM is more established?
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/error.py:docstring of opan.error.AnharmError, line 6.)
Todo
Add note about this being subject to future development?
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/error.py:docstring of opan.error.SymmError, line 6.)
Todo
Need COSMO reference
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/output.py:docstring of opan.output.OrcaOutput, line 90.)
Todo
Update oo.converged with any robustifications
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/output.py:docstring of opan.output.OrcaOutput, line 238.)
Todo
Update oo.optimized with any robustifications
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/output.py:docstring of opan.output.OrcaOutput, line 253.)
Todo
execute_orca: The different output modes, depending on waiting or not.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/utils/execute.py:docstring of opan.utils.execute.execute_orca, line 24.)
Todo
Replace cite eventually with link to exposition in user guide.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/utils/inertia.py:docstring of opan.utils.inertia.inertia_tensor, line 9.)
Todo
Add ref to exposition in webdocs once written up.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/utils/inertia.py:docstring of opan.utils.inertia.principals, line 12.)
Todo
Complete symm module docstring, including the member functions
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/utils/symm.py:docstring of opan.utils.symm, line 12.)
Todo
Main docstring for OpanAnharmRepo (renamed to VPT2…)
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/vpt2/repo.py:docstring of opan.vpt2.repo.OpanAnharmRepo, line 10.)
Todo
REPO.__init__ docstring
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/vpt2/repo.py:docstring of opan.vpt2.repo.OpanAnharmRepo.__init__, line 1.)
Todo
Pull the above to User Guide eventually, with figures.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/opan/checkouts/latest/opan/xyz.py:docstring of opan.xyz.OpanXYZ.dihed_single, line 18.)