Skip to content

Commit

Permalink
up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mmagnus committed Oct 22, 2023
1 parent 3683231 commit 408e184
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 30 deletions.
2 changes: 1 addition & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To install pytube, run the following command in your terminal::
$ pip install rna-tools

Get the Source Code
=============================================
-----------------------------------------------

rna-toos is actively developed on GitHub, where the source is available:

Expand Down
64 changes: 35 additions & 29 deletions docs/source/main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,34 +104,6 @@ RNAStructure (rna_tools_lib)
.. automodule:: rna_tools.rna_tools_lib
:members:

PDB Edit Bfactor/Occupancy
------------------------------------------

.. autoprogram:: rna_tools.tools.rna_pdb_edit_occupancy_bfactor.rna_pdb_edit_occupancy_bfactor:get_parser()
:prog: rna_pdb_edit_occupancy_bfactor.py

.. autofunction:: rna_tools.tools.rna_pdb_edit_occupancy_bfactor.rna_pdb_edit_occupancy_bfactor.edit_occupancy_of_pdb

Add chain to a file
------------------------------------------

.. automodule:: rna_tools.tools.misc.rna_add_chain
:members:
:undoc-members:

.. autoprogram:: rna_tools.tools.misc.rna_add_chain:get_parser()
:prog: rna_add_chain.py

Measure distance between atoms
------------------------------------------

.. autoprogram:: rna_tools.tools.pdbs_measure_atom_dists.pdbs_measure_atom_dists:get_parser()
:prog: pdbs_measure_atom_dists.py

.. automodule:: rna_tools.tools.pdbs_measure_atom_dists.pdbs_measure_atom_dists
:members:
:undoc-members:

Standardize your PDB files
-----------------------------------------------

Expand Down Expand Up @@ -189,5 +161,39 @@ The first residue will have only OP1 and OP2 (OP3 will be removed)::

Listing. An example: `1ehz.pdb`.

.. image :: ../pngs/op3.jpg # op3.pse
.. image :: ../pngs/op3.jpg
Torsion angle analysis
-----------------------------------------------

.. autoprogram:: rna_tools.rna_torsions:get_parser()
:prog: rna_torsions.py

PDB Edit Bfactor/Occupancy
------------------------------------------

.. autoprogram:: rna_tools.tools.rna_pdb_edit_occupancy_bfactor.rna_pdb_edit_occupancy_bfactor:get_parser()
:prog: rna_pdb_edit_occupancy_bfactor.py

.. autofunction:: rna_tools.tools.rna_pdb_edit_occupancy_bfactor.rna_pdb_edit_occupancy_bfactor.edit_occupancy_of_pdb

Add chain to a file
------------------------------------------

.. automodule:: rna_tools.tools.misc.rna_add_chain
:members:
:undoc-members:

.. autoprogram:: rna_tools.tools.misc.rna_add_chain:get_parser()
:prog: rna_add_chain.py

Measure distance between atoms
------------------------------------------

.. autoprogram:: rna_tools.tools.pdbs_measure_atom_dists.pdbs_measure_atom_dists:get_parser()
:prog: pdbs_measure_atom_dists.py

.. automodule:: rna_tools.tools.pdbs_measure_atom_dists.pdbs_measure_atom_dists
:members:
:undoc-members:

0 comments on commit 408e184

Please sign in to comment.