Skip to content

Commit ce0da10

Browse files
committed
Update README.md
1 parent 514af08 commit ce0da10

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

README.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ Paste the above reformated [`set_view()`](http://pymolwiki.org/index.php/Set_Vie
4949

5050
###What is the roundview() function?
5151

52-
5352
The Python script roundview.py includes the function `roundview()` that reformats the viewing port settings from seven rows to one row. The more compact format from roundview() is easy to copy and paste onto the command line. Other commands that are separated by semicolons can be added to the command line along with the settings. This defines a horiontal script. The script can include commnents that are isolated by semicolons. The horizontal script can be edited and tested repeatedly within PyMOL for many cycles without using an external text editor. This saves time during the development of a new molecular scene. The cursor can be moved around quickly on the command line with the readline commands:
5453

5554
* **cntrl-a** moves cursor to the beginning of the line
@@ -59,21 +58,16 @@ The Python script roundview.py includes the function `roundview()` that reformat
5958
* **command-f** move forward by one word
6059
* **commend-b** move backward by one word
6160

62-
Requirements
63-
--------------------------------------------------------------------------------
61+
###Requirements
6462

65-
Requires a molecular object loaded into an interactive session of PyMOL. Does not
66-
require any modules outside of two in PyMOL. Should work on all versions of PyMOL.
63+
Requires a molecular object loaded into an interactive session of PyMOL. Does not require any modules other than two in PyMOL. Should work on all versions of PyMOL.
6764
Tested on:
6865
* Ubuntu 14.04 64 bit with PyMOL 1.7.2.2.
6966
* Windows 8 32 bit running PyMOL 1.7.6.2 and PyMOL 1.7.6.6.
7067
* Mac OSX 10.10.5 64 bit running PyMOL 1.5.0.5, 1.7.6.6 (via macports), and 1.8.0.5.
7168

72-
We tried to make the code backward compatible to PyMOL 1.5. We do not gaurantee that this
73-
code works with earlier versions of PyMOL. Nor do we guarantee that the code will
74-
not fail in future versions of PyMOL. In PyMOL version 1.6, there were
75-
several changes that reduced backward compatibility. We also do not guarantee that
76-
the code will work if you install in a way that is different from the methods that we describe below.
69+
We tried to make the code backward compatible to PyMOL 1.5. We do not gaurantee that this code works with earlier versions of PyMOL. Nor do we guarantee that the code will not fail in future versions of PyMOL. In PyMOL version 1.6, there were
70+
several changes that reduced the backward compatibility. We also do not guarantee that the code will work if you install the code in a location that is different from that described below.
7771

7872
###Instructions
7973

@@ -123,14 +117,13 @@ There are at least four different ways of loading the script into PyMOL:
123117
```py
124118
run roundview.py
125119
```
126-
Please note that the "run" command just loads the script into PyMOL. It does not execute it. Now the roundview command is available by typing "roundview", and the on-line documentation is available by typing "roundview".
120+
Please note that the "run" command just loads the script into PyMOL. It does not execute it. Now the roundview() command is available by typing "roundview", and the on-line documentation is available by typing "roundview".
127121

128122
2. load [`roundview.py`](./roundview.py) with the plugin manager (see plugin pulldown) in PyMOL
129123

130-
3. copy [`roundview.py`](./roundview.py) to safe folder that will not be deleted when you delete PyMOL. I use `~/Scripts/PyMOLScripts/`. Then load into PyMOL using method 1 or 2.
124+
3. copy [`roundview.py`](./roundview.py) to a safe folder that will not be deleted when you delete PyMOL. I use `~/Scripts/PyMOLScripts/`. Then load roundview() into PyMOL using method 1 or 2.
131125

132-
4. create or edit the hidden file `.pymolrc` (`pymolrc.pml` and not hidden on Windows) text file in the home directory so that it includes the following lines so that roundview.py is always loaded upon startup. This option also works without the first two lines.
133-
126+
4. create or edit the hidden text file `.pymolrc` (named `pymolrc.pml` and not hidden on Windows) in the home directory so that it includes the following lines so that `roundview.py` is always loaded upon startup. This option also works without the first two lines.
134127
```py
135128
import sys
136129
sys.path.append('/Path/To/roundview')
@@ -142,14 +135,14 @@ For example:
142135
sys.path.append('/Users/blaine-mooers/Scripts/PyMOLScripts/')
143136
run /Users/blaine-mooers/Scripts/Scripts_PyMOL/roundview.py
144137
```
145-
Restart pymol. You should see something like the following in the command history window if your path to the script is correct.
138+
Restart PyMOL. You should see something like the following in the command history window if your path to the script is correct.
146139
```py
147140
PyMOL>import sys
148141
PyMOL>sys.path.append('/Users/blaine-mooers/Scripts/PyMOLScripts/')
149142
PyMOL>run /Users/blaine-mooers/Scripts/Scripts_PyMOL/roundview.py
150143
```
151144

152-
Type "roundview" on either command line. You should get back this if no molecule is loaded:
145+
Type "roundview" on either command line. You should get back the following in the command history window if no molecule is loaded:
153146
```py
154147
set_view (1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,-50.0,0.0,0.0,0.0,40.0,100.0,-20.0);
155148
```
@@ -158,31 +151,32 @@ Type "roundview" on either command line. You should get back this if no molecule
158151

159152
[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/watch?v=XTwwWgwj4z0/0.jpg)](http://www.youtube.com/watch?v=XTwwWgwj4z0)
160153

161-
## Link to roundview.py installation video for PyMOL om Windows:
154+
## Link to roundview.py installation video for PyMOL on Windows:
162155

163156
[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/watch?v=XTwwWgwj4z0/0.jpg)](http://www.youtube.com/watch?v=Dh2ihD5mIxY)
164157

165-
## Link to roundview.py installation video for Linux and PyMOLHyridX11 for the mac on YouTube:
158+
## Link to roundview.py installation video for Linux and PyMOLHyridX11 for Mac:
166159

167160
[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/watch?v=XQWQzq48DeA/0.jpg)](http://www.youtube.com/watch?v=XQWQzq48DeA)
168161

169162

170163
#### How to run
171164
--------------------------------------------------------------------------------
172165

173-
After loading a pdb file and setting up the molecular scene, type on one of the command lines in PyMOL:
166+
After loading a pdb file and setting up the molecular scene, type on a command line in PyMOL:
174167

175168
```py
176169
PyMOL>roundview
177170
```
178171

179172
##### How to get help
180173

181-
Type the following on one of the command lines in PyMOL
174+
Type the following on a command line in PyMOL
182175

183176
```py
184177
PyMOL> help roundview
185178
```
179+
Something like the following should be printed to the command history window:
186180

187181
Usage: `roundview [view, decimal places, outname]`
188182
* The values in the [ ] are optional.

0 commit comments

Comments
 (0)