Skip to content

Commit 43c7640

Browse files
committed
Added instructions for pdfgui installation under existing python tree.
1 parent 7aace0b commit 43c7640

File tree

1 file changed

+44
-14
lines changed

1 file changed

+44
-14
lines changed

download.shtml

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ in place.
3434
<p>
3535
The DiffPy components are registered at the Python Package Index (PyPI),
3636
therefore the most straightforward way to install is to execute
37-
<i>easy_install&nbsp;MODULE_NAME</i>. The easy_install command
37+
<tt>easy_install&nbsp;MODULE_NAME</tt>. The easy_install command
3838
downloads, unzips and installs the required package together with
3939
its requirements, for example
4040
</p>
@@ -45,17 +45,22 @@ its requirements, for example
4545

4646
<p>
4747
would install diffpy.pdfgui together with diffpy.pdffit2 and diffpy.Structure
48-
that are required for its function. The <i>easy_install</i> command is a part
49-
of Python setuptools library.
48+
that are required for its function. The programs can be then started
49+
as <tt>pdfgui</tt> or <tt>pdffit2</tt>.
50+
</p>
51+
52+
<p>
53+
The <tt>easy_install</tt> command is a
54+
part of the Python setuptools library.
5055
If it is not available, install the "python-setuptools"
5156
package with the system package manager or use the ".tgz" archive
52-
below, which comes with <i>easy_install</i> included.
57+
below, which comes with <tt>easy_install</tt> included.
5358
</p>
5459

5560
<p>
5661
If you prefer to install from local files, download the latest
5762
<b>diffpy-VERSION.tgz</b> archive list below, unpack
58-
and run the enclosed easy_install script
63+
and run the enclosed <tt>easy_install</tt> script
5964
</p>
6065

6166
<pre>
@@ -79,24 +84,48 @@ the latest <b>diffpy-VERSION.exe</b> file below, run it and follow
7984
the prompts.
8085
</p>
8186

87+
<p>
88+
The self-installing archive includes a complete installation of Python
89+
that is used to run PDFgui and PDFfit2. Nevertheless, PDFgui (and other
90+
DiffPy components) can be also installed under existing Python tree.
91+
This requires Python 2.5 with several external Python packages,
92+
namely setuptools, numpy, wxPython and matplotlib.
93+
To add PDFgui to an existing Python tree, start Windows command prompt
94+
and run the <tt>easy_install</tt> script from the <tt>Python25/Scripts</tt>
95+
directory
96+
</p>
97+
98+
<pre>
99+
cd c:\Python25\Scripts
100+
..\python.exe easy_install-script.py diffpy.pdfgui
101+
</pre>
102+
103+
<p>
104+
This installs library files under <tt>Python25/Lib/site-packages</tt>
105+
and executable scripts for <tt>pdfgui</tt> and <tt>pdffit2</tt> under
106+
<tt>Python25/Scripts</tt>.
107+
</p>
108+
82109

83110
<a name="updates"></a>
84111
<h2>DiffPy updates</h2>
85112

86113
<p>
87-
Both Unix and Windows platforms can use the <i>easy_install</i> command
88-
to obtain the latest updates to the code. For example, to obtain any
89-
new PDFgui upgrades, run
114+
Both Unix and Windows platforms can use the <tt>easy_install</tt> command
115+
to obtain the latest updates to the code. For example, to upgrade
116+
PDFgui, run
90117
</p>
91118

92119
<pre>
93120
easy_install -U diffpy.pdfgui
94121
</pre>
95122

96123
<p>
97-
This installs only the changed DiffPy components. These will
98-
be released more more frequently than the complete installation
99-
archives.
124+
This installs only the changed DiffPy components as they become
125+
available at the DiffPy
126+
<a href="packages/">package repository</a>. These packages
127+
are smaller and will be updated more frequently than the complete
128+
installation archives.
100129
</p>
101130

102131

@@ -115,7 +144,8 @@ version of a DiffPy component called MODULE_NAME, run
115144

116145
<p>
117146
Another option is to install in a development mode, which is more
118-
convenient for code checking and debugging. This can be done as
147+
convenient for debugging and experimenting with the code.
148+
This can be done as
119149
</p>
120150

121151
<pre>
@@ -143,8 +173,8 @@ forum for tips and tricks and feedback.
143173
<!--#include virtual="pybin/download_index.py/download" -->
144174

145175
<small>
146-
Older releases are available in the
147-
<a href="download/archive">archive</a>.
176+
The older releases can be found in the
177+
<a href="download/archive">downloads archive</a>.
148178
</small>
149179

150180

0 commit comments

Comments
 (0)