Page MenuHomeHEPForge
Files F8308850

No OneTemporary
Actions

View Options

Index: www/examples.html
===================================================================
--- www/examples.html (revision 0)
+++ www/examples.html (revision 1916)
@@ -0,0 +1,78 @@
+<h2>PyFeyn examples</h2>
+<a href="pyfeyn-logo"><img style="margin:1em; border:0; float:right;" src="pyfeyn-logo-small" /></a>
+<p>
+ Here's some sample output from pyfeyn, with the source code that produces it:
+</p>
+
+<h4>Drell-Yan with QCD vertex correction</h4>
+<p>Very little code is needed to produce simple diagrams like this one. Note that
+the labels on the lines are produced by LaTeX and use the predefined names in the
+hepnames LaTeX package if it's available.</p>
+<hf:highlight lang="python" src="pyfeyn-test1.py" />
+<p>produces (click to enlarge):</p>
+<a href="pyfeyn-test1.png">
+ <img src="pyfeyn-test1-small.png" width="320" height="165" style="border:1px grey dashed; padding:0.5em;"/>
+</a>
+(<a href="pyfeyn-test1.pdf">PDF version</a>)
+
+<h4>Curves and blobs</h4>
+<p>Note that the curly lines automatically match themselves to the outlines
+of the interaction blobs! I hope this isn't meant to be a real process...</p>
+<hf:highlight lang="python" src="pyfeyn-test2.py" />
+<p>produces (click to enlarge):</p>
+<a href="pyfeyn-test2.png">
+ <img src="pyfeyn-test2-small.png" width="257" height="258" style="border:1px grey dashed; padding:0.5em;"/>
+</a>
+(<a href="pyfeyn-test2.pdf">PDF version</a>)
+
+<h4>B meson decay</h4>
+<p>This is a colour-suppressed penguin decay diagram. We'd like to improve the
+quality of the blob rendering.</p>
+<hf:highlight lang="python" src="pyfeyn-test3.py" />
+<p>produces (click to enlarge):</p>
+<a href="pyfeyn-test3.png">
+ <img src="pyfeyn-test3-small.png" width="458" height="383" style="border:1px grey dashed; padding:0.5em;"/>
+</a>
+(<a href="pyfeyn-test3.pdf">PDF version</a>)
+
+<h4>Higgs loop</h4>
+<p>A top loop contribution to the Higgs boson mass &mdash; the canonical "why we need SUSY"
+diagram. The main point is that it's pretty simple and the code is correspondingly short.</p>
+<hf:highlight lang="python" src="pyfeyn-test4.py" />
+<p>produces (click to enlarge):</p>
+<a href="pyfeyn-test4.png">
+ <img src="pyfeyn-test4-small.png" width="238" height="122" style="border:1px grey dashed; padding:0.5em;"/>
+</a>
+(<a href="pyfeyn-test4.pdf">PDF version</a>)
+
+<h4>Multi-lines</h4>
+<p>Multi-lines like these aren't finished yet, but with code like this you can at least get
+most of the right effect.</p>
+<hf:highlight lang="python" src="pyfeyn-test5.py" />
+<p>produces (click to enlarge):</p>
+<a href="pyfeyn-test5.png">
+ <img src="pyfeyn-test5-small.png" width="198" height="63" style="border:1px grey dashed; padding:0.5em;"/>
+</a>
+(<a href="pyfeyn-test5.pdf">PDF version</a>)
+
+<h4>Graviton and SUSY lines</h4>
+<p>No, we don't know why there are graviton and SUSY lines available by default. Oh, yes we do:
+they were fun to write!</p>
+<hf:highlight lang="python" src="pyfeyn-test6.py" />
+<p>produces (click to enlarge):</p>
+<a href="pyfeyn-test6.png">
+ <img src="pyfeyn-test6-small.png" width="316" height="173" style="border:1px grey dashed; padding:0.5em;"/>
+</a>
+(<a href="pyfeyn-test6.pdf">PDF version</a>)
+
+<h4>Silly effects</h4>
+<p>Where PyFeyn ends, <a href="http://pyx.sourceforge.net">PyX</a> begins. You can take the
+output of PyFeyn and use it to make silly effects like these transparency-based rotation and
+translation "blurs".</p>
+<hf:highlight lang="python" src="pyfeyn-test7.py" />
+<p>produces (click to enlarge):</p>
+<a href="pyfeyn-test7.png">
+ <img src="pyfeyn-test7-small.png" width="363" height="398" style="border:1px grey dashed; padding:0.5em;"/>
+</a>
+(<a href="pyfeyn-test7.pdf">PDF version</a>)
+
Index: www/include/header
===================================================================
--- www/include/header (revision 1915)
+++ www/include/header (revision 1916)
@@ -1,24 +1,21 @@
-<link rel="stylesheet" type="text/css" href="https://common.cedar.ac.uk/include/srchighlight.css" />
+<link rel="stylesheet" type="text/css" href="/common/include/srchighlight.css" />
<style type="text/css">
h4 { color:grey; }
</style>
<table><tr>
<td class="noprint" style="vertical-align:top; padding-top:0.5em;">
<ul class="nowrap" style="background:#eec; border:#cca 5px solid; padding:1em; padding-left:2em; margin-right:2em;">
<strong><em>pyfeyn</em></strong>
- <li><a href="/pyfeyn">Home</a></li>
+ <li><a href="/pyfeyn">Home</a></li>
+ <li><a href="/pyfeyn/examples">Examples</a></li>
+ <li><a href="/pyfeyn/install">Installation</a></li>
+ <li><a href="/pyfeyn/doc">API documentation</a></li>
+ <li><a href="/pyfeyn/downloads">Downloads</a></li>
+ <li><a href="/pyfeyn/bugtrack/report/3">Bug tracking</a></li>
<li><a href="/pyfeyn/svn/">Subversion</a></li>
- <li><a href="/pyfeyn/bugtrack/">Tracker</a>
- <ul style="padding-left:0.8em">
- <li style="font-size:smaller"><a href="/pyfeyn/bugtrack/roadmap/">Milestones</a></li>
- <li style="font-size:smaller"><a href="/pyfeyn/bugtrack/report/3">Tickets</a></li>
- <li style="font-size:smaller"><a href="/pyfeyn/bugtrack/timeline">Timeline</a></li>
- </ul>
- </li>
<li><a href="/pyfeyn/bugtrack/wiki/">Wiki</a></li>
- <li><a href="/pyfeyn/downloads">Downloads</a></li>
<li><a href="mailto:pyfeyn@cedar.ac.uk">Contact</a></li>
</ul>
</td>
<td style="vertical-align:top;">
Index: www/install.html
===================================================================
--- www/install.html (revision 0)
+++ www/install.html (revision 1916)
@@ -0,0 +1,84 @@
+<h2>PyFeyn installation guide</h2>
+<a href="pyfeyn-logo"><img style="margin:1em; border:0; float:right;" src="pyfeyn-logo-small" /></a>
+<p>
+ PyFeyn is a standard Python package using the
+ <a href="http://peak.telecommunity.com/DevCenter/setuptools">setuptools</a>
+ system, which for the main part behaves just like Python's normal "distutils".
+ For now, installation can only be carried out using the <kbd>setup.py</kbd>
+ script - we'll get the automatic <kbd>easy_install</kbd> method working soon.
+</p>
+
+
+<h3>Dependencies</h3>
+<p>
+ PyFeyn depends on the <a href="http://pyx.sf.net">PyX</a> Python graphics
+ library - you'll have to install it for PyFeyn to work.
+</p>
+<p>
+ If you want to have LaTeX output in your Feynman graphs, then obviously
+ you need to have LaTeX installed on your system. If you want to have access
+ to the convenient particle name macros used in the examples, then you'll need
+ to install the LaTeX <a href="http://www.ctan.org/tex-archive/help/Catalogue/entries/hepnames.html">hepnames</a>
+ package. This in turn requires two other non-standard LaTeX packages,
+ <kbd>hepparticles</kbd> and <kbd>maybemath</kbd>, but it's worth it!
+</p>
+
+
+<h3>Installing using <kbd>setup.py</kbd></h3>
+<p>
+ The "normal" way to install a Python package applies for PyFeyn. There are
+ <a href="http://docs.python.org/inst/trivial-install.html">good instructions</a>
+ in the <a href="http://docs.python.org">Python documentation</a>, otherwise
+ my comparably haphazard instructions are below :-)
+</p>
+<p>
+ So, first download and expand the source tarball, then <kbd>cd</kbd> to the
+ expanded directory. Now the command that you'll run depends on whether you
+ have root access on your system.
+</p>
+<p>
+ If you do have root access and want to make a system-wide installation, run
+ <kbd>python setup.py install</kbd>. This will probably install the libraries into
+ your <kbd>/usr/local/lib/python2.x/site-packages/pyfeyn</kbd> directory. That
+ should be all you need to do (please let us know if it isn't).
+</p>
+<p>
+ If you don't have root privileges or for other reasons just want to make a local
+ installation, then you probably want to run the <kbd>setup.py</kbd> script with
+ an argument to point at a local Python library directory. The Python docs have a
+ <a href="http://docs.python.org/inst/alt-install-windows.html">page which specially
+ covers this situation</a> &mdash; I'm going to use the "home" scheme here.
+</p>
+<p>
+ We're going to install PyFeyn into a directory within my home directory. I put <em>my</em>
+ local Python libraries into <kbd>$HOME/local/lib/python</kbd>, and include this
+ directory in the colon-delimited <kbd>PYTHONPATH</kbd> shell variable, by putting
+ the line <kbd>export PYTHONPATH="$PYTHONPATH:$HOME/local/lib/python"</kbd> into my
+ <kbd>.bashrc</kbd> file. This is standard Python configuration stuff &mdash; I
+ hope you can work out the equivalent statement if you use a CSH-type shell.
+</p>
+<p>
+ Now, assuming that you've made such a directory and added it to <kbd>PYTHONPATH</kbd>,
+ you should run <kbd>setup.py</kbd> as above, but with the <kbd>--home</kbd> option:
+ <kbd>./setup.py install --home $HOME/local</kbd>. PyFeyn should now install itself
+ neatly into the <kbd>lib/python</kbd> directory in your chosen "home" path.
+</p>
+
+
+<h3>Installation with <kbd>easy_install</kbd></h3>
+<p>
+ I haven't made <kbd>easy_install</kbd> work quite right yet &mdash; I'll remedy this
+ soon!
+</p>
+
+
+<h3>Testing the installation</h3>
+<p>
+ We don't yet have a proper suite of unit tests, so the best check that PyFeyn has
+ installed properly is to run <kbd>python</kbd> and then type <code>import pyfeyn</code>
+ at the Python prompt. If it doesn't complain, chances are it's worked: now try running
+ one of the <a href="examples">test examples</a> and check that the output looks okay.
+ Make sure you do the tests somewhere other than the expanded tarball, otherwise Python
+ will use the local sources (in the <kbd>pyfeyn</kbd> directory) rather than the installed
+ library.
+</p>
Index: www/index.html
===================================================================
--- www/index.html (revision 1915)
+++ www/index.html (revision 1916)
@@ -1,123 +1,61 @@
<h2>PyFeyn</h2>
<a href="pyfeyn-logo"><img style="margin:1em; border:0; float:right;" src="pyfeyn-logo-small" /></a>
<p>
PyFeyn is a <a href="http://www.python.org">Python-language</a> based
system for drawing Feynman diagrams. It was inspired by the C++
<a href="http://www.feyndiagram.com">FeynDiagram</a> system, and aims
to provide the same functionality and quality of output as that, with
the added benefits of a modern interpreted language, an improved interface
and output direct to both EPS and PDF. Behind the scenes, PyFeyn uses
the excellent <a href="http://pyx.sf.net">PyX</a> system - you can use
PyX constructs in PyFeyn diagrams if you want, too.
</p>
+<h3>Examples</h3>
+<p>
+There are a range of demonstrations of PyFeyn's capabilities on
+the <a href="examples">examples page.
+</p>
+
+
<h3>Getting PyFeyn</h3>
<p>
- PyFeyn is currently in pre-release status: you can currently draw lines,
- vertices, interaction blobs and do some semi-clever stuff with vectors,
- gluons and specifying points that lines should arc through. You can see
- a few demos of how it works lower down on this page.
+ The current PyFeyn version is <strong>0.3b1</strong> &mdash; the
+ final 0.3 release should happen soon. You can get it from the
+ <a href="http://www.hepforge.org/downloads/pyfeyn">HepForge
+ downloads area</a> either as a tarball or a Python Egg. You can
+ also use the Python "easy install" system - see the
+ <a href="http://cheeseshop.python.org/pypi/pyfeyn/">PyFeyn
+ entry on PyPI</a>. Or you can check it out directly from HepForge
+ Subversion if you fancy following the bleeding edge releases.
+</p>
+<p>
+ Please see the <a href="install">installation guide page</a> for
+ installation instructions if you're unfamiliar with installing
+ Python packages. Note that PyFeyn depends on <a href="http://pyx.sf.net">PyX</a>
+ as its rendering back-end, so you'll need to have PyX installed
+ before PyFeyn will work.
</p>
<h3>Using PyFeyn</h3>
<p>
PyFeyn is almost ready for a public beta version. Thanks to Georg von Hippel
for providing some very nice functionality when I was too busy (for months!)
to do any work on it. You can try using the code from the Subversion
trunk now, but we'll have a "proper" release soon.
</p>
<p>
There's currently no "proper" manual, but there is automatically generated
<a href="doc/">code documentation</a> which should hopefully be enough. Hopefully
most of the examples above are fairly self-explanatory &mdash; please let us know
by email if you get confused.
</ul>
-
-<h3>Examples</h3>
-<p>
- Here's some sample output from pyfeyn, with the source code that produces it:
-</p>
-
-<h4>Drell-Yan with QCD vertex correction</h4>
-<p>Very little code is needed to produce simple diagrams like this one. Note that
-the labels on the lines are produced by LaTeX and use the predefined names in the
-hepnames LaTeX package if it's available.</p>
-<hf:highlight lang="python" src="pyfeyn-test1.py" />
-<p>produces (click to enlarge):</p>
-<a href="pyfeyn-test1.png">
- <img src="pyfeyn-test1-small.png" width="320" height="165" style="border:1px grey dashed; padding:0.5em;"/>
-</a>
-(<a href="pyfeyn-test1.pdf">PDF version</a>)
-
-<h4>Curves and blobs</h4>
-<p>Note that the curly lines automatically match themselves to the outlines
-of the interaction blobs! I hope this isn't meant to be a real process...</p>
-<hf:highlight lang="python" src="pyfeyn-test2.py" />
-<p>produces (click to enlarge):</p>
-<a href="pyfeyn-test2.png">
- <img src="pyfeyn-test2-small.png" width="257" height="258" style="border:1px grey dashed; padding:0.5em;"/>
-</a>
-(<a href="pyfeyn-test2.pdf">PDF version</a>)
-
-<h4>B meson decay</h4>
-<p>This is a colour-suppressed penguin decay diagram. We'd like to improve the
-quality of the blob rendering.</p>
-<hf:highlight lang="python" src="pyfeyn-test3.py" />
-<p>produces (click to enlarge):</p>
-<a href="pyfeyn-test3.png">
- <img src="pyfeyn-test3-small.png" width="458" height="383" style="border:1px grey dashed; padding:0.5em;"/>
-</a>
-(<a href="pyfeyn-test3.pdf">PDF version</a>)
-
-<h4>Higgs loop</h4>
-<p>A top loop contribution to the Higgs boson mass &mdash; the canonical "why we need SUSY"
-diagram. The main point is that it's pretty simple and the code is correspondingly short.</p>
-<hf:highlight lang="python" src="pyfeyn-test4.py" />
-<p>produces (click to enlarge):</p>
-<a href="pyfeyn-test4.png">
- <img src="pyfeyn-test4-small.png" width="238" height="122" style="border:1px grey dashed; padding:0.5em;"/>
-</a>
-(<a href="pyfeyn-test4.pdf">PDF version</a>)
-
-<h4>Multi-lines</h4>
-<p>Multi-lines like these aren't finished yet, but with code like this you can at least get
-most of the right effect.</p>
-<hf:highlight lang="python" src="pyfeyn-test5.py" />
-<p>produces (click to enlarge):</p>
-<a href="pyfeyn-test5.png">
- <img src="pyfeyn-test5-small.png" width="198" height="63" style="border:1px grey dashed; padding:0.5em;"/>
-</a>
-(<a href="pyfeyn-test5.pdf">PDF version</a>)
-
-<h4>Graviton and SUSY lines</h4>
-<p>No, we don't know why there are graviton and SUSY lines available by default. Oh, yes we do:
-they were fun to write!</p>
-<hf:highlight lang="python" src="pyfeyn-test6.py" />
-<p>produces (click to enlarge):</p>
-<a href="pyfeyn-test6.png">
- <img src="pyfeyn-test6-small.png" width="316" height="173" style="border:1px grey dashed; padding:0.5em;"/>
-</a>
-(<a href="pyfeyn-test6.pdf">PDF version</a>)
-
-<h4>Silly effects</h4>
-<p>Where PyFeyn ends, <a href="http://pyx.sourceforge.net">PyX</a> begins. You can take the
-output of PyFeyn and use it to make silly effects like these transparency-based rotation and
-translation "blurs".</p>
-<hf:highlight lang="python" src="pyfeyn-test7.py" />
-<p>produces (click to enlarge):</p>
-<a href="pyfeyn-test7.png">
- <img src="pyfeyn-test7-small.png" width="363" height="398" style="border:1px grey dashed; padding:0.5em;"/>
-</a>
-(<a href="pyfeyn-test7.pdf">PDF version</a>)
-
-
-
<p style="font-size:small; color:darkgrey;">
- PyFeyn is managed by
- <a href="http://www.ippp.dur.ac.uk/~buckley/">Andy Buckley</a>, who
- also wrote most of it (and is very, very modest).
+ PyFeyn was written by
+ <a href="http://www.ippp.dur.ac.uk/~buckley/">Andy Buckley</a>
+ and Georg von Hippel.
</p>

File Metadata

Mime Type
text/x-diff
Expires
Sat, Dec 21, 1:22 PM (1 d, 47 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
4022938
Default Alt Text
(16 KB)

Event Timeline