/usr/share/doc/psi4/html/pep0001.html is in psi4-data 1:0.3-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>PEP1: Proposing PsiPEP for Psi4 — Psi4 [] Docs</title>
<link rel="stylesheet" href="_static/psi4.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="./" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/jquery.cookie.js"></script>
<script type="text/javascript" src="_static/toggle_sections.js"></script>
<script type="text/javascript" src="_static/toggle_sidebar.js"></script>
<script type="text/javascript" src="_static/toggle_codeprompt.js"></script>
<link rel="shortcut icon" href="_static/favicon-psi4.ico"/>
<link rel="top" title="Psi4 [] Docs" href="index.html" />
<link rel="up" title="PsiPEP: Plans and Practices to Organize Psi4" href="psipep.html" />
<link rel="next" title="Programming: Using the Core Libraries" href="programming.html" />
<link rel="prev" title="PsiPEP: Plans and Practices to Organize Psi4" href="psipep.html" />
</head>
<body role="document">
<div class="relbar-top">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="contents.html" title="Table Of Contents"
accesskey="C">toc</a> </li>
<li class="right" >
<a href="programming.html" title="Programming: Using the Core Libraries"
accesskey="N">next</a> </li>
<li class="right" >
<a href="psipep.html" title="PsiPEP: Plans and Practices to Organize Psi4"
accesskey="P">previous</a> </li>
<li><a href="index.html">Psi4 []</a> » </li>
<li class="nav-item nav-item-1"><a href="contributing.html" >Contributions: Intro to Programming in <span class="sc">Psi4</span></a> »</li>
<li class="nav-item nav-item-2"><a href="psipep.html" accesskey="U">PsiPEP: Plans and Practices to Organize <span class="sc">Psi4</span></a> »</li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<a class="reference internal image-reference" href="_images/psi4banner.png"><img alt="Psi4 Project Logo" src="_images/psi4banner.png" style="width: 100%;" /></a>
<div class="section" id="pep1-proposing-psipep-for-psifour">
<span id="sec-pep1"></span><span id="index-0"></span><h1>PEP1: Proposing PsiPEP for <span class="sc">Psi4</span><a class="headerlink" href="#pep1-proposing-psipep-for-psifour" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">PEP:</th><td class="field-body">1</td>
</tr>
<tr class="field-even field"><th class="field-name">Title:</th><td class="field-body">Proposing PsiPEP for <span class="sc">Psi4</span></td>
</tr>
<tr class="field-odd field"><th class="field-name">Last-Modified:</th><td class="field-body">04-Jul-2012</td>
</tr>
<tr class="field-even field"><th class="field-name">Author:</th><td class="field-body">Lori Burns</td>
</tr>
<tr class="field-odd field"><th class="field-name">Content-Type:</th><td class="field-body">text/x-rst</td>
</tr>
<tr class="field-even field"><th class="field-name">Created:</th><td class="field-body">04-Jul-2012</td>
</tr>
</tbody>
</table>
<p>This document proposes using a (much more informal) version of Python’s
PEP (Python Enhancement Proposal <a class="reference external" href="http://www.python.org/dev/peps/pep-0001/">PEP1</a>) protocol to organize
<span class="sc">Psi4</span>. Presently, topics are brought up on e-mail threads (where
discussion is very temporally localized and not everyone is aware of it
unless cc’d), are brought up at workshops (where people may be absent, no
record is left, and not everyone may have prepared a position on the
topic), or agreed between a couple people over g-chat (others remain
unaware of plans), or planned by someone (who may not have committed those
plans to a ticket or who wants general approval before restructuring the
code).</p>
<div class="section" id="path-of-a-psipep">
<h2>Path of a PsiPEP<a class="headerlink" href="#path-of-a-psipep" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Someone creates a file <code class="docutils literal"><span class="pre">psi4/doc/sphinxman/source/pepXXXX.rst</span></code> modeled
on <a class="reference external" href="https://github.com/psi4/psi4public/blob/master/doc/sphinxman/source/pep0000model.rst">psi4/doc/sphinxman/source/pep0000model.rst</a> and adds
it to <code class="docutils literal"><span class="pre">STATICDOC</span></code> in <a class="reference external" href="https://github.com/psi4/psi4public/blob/master/doc/sphinxman/Makefile.in">psi4/doc/sphinxman/Makefile.in</a>. The file
should have header fields modeled on another PsiPEP and a discussion of
the proposed change or practice.</li>
<li>Anyone can comment by adding sections to the bottom of the reST file.
Alternatively, e-mail discussions can go out and the (possibly edited)
results be pasted into the bottom of the reST file once the furor dies
down.</li>
<li>Comments can be simple statements of agreement (useful for gauging
consensus), notation of possible problems, proposed re-writes of the
proposal, etc. Only the original author or his designate should change
the main body of the PsiPEP (to maintain a history).</li>
<li>Once there’s agreement, file can be stamped final and be placed into
effect. (Yes, this is very vague.)</li>
</ul>
</div>
<div class="section" id="roles-of-a-psipep-include">
<h2>Roles of a PsiPEP Include<a class="headerlink" href="#roles-of-a-psipep-include" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first"><strong>Best practices or re-vamped best practices</strong></p>
<p>Practices can be easily linked- or referred-to by number and can be
tagged as obsolete by a single label change months later.</p>
</li>
<li><p class="first"><strong>Request/present viewpoint on organization</strong></p>
<p>Draw attention to organization needed in code outside one’s area of
expertise. Request interface for some structure (e.g., gradients) or
viewpoints on how that interface will behave to ensure compatibility.
Offer philosophy on how processes/definitions should be.</p>
</li>
<li><p class="first"><strong>Fair Warning: Proposal to change things up</strong></p>
<p>Announce plans to re-organize code structure or how something is
handled. List goals (may be conflicting) and how proposed scheme best
satisfies them. PsiPEP allows discussion before roll-out in case
proposal has deleterious side-effects.</p>
</li>
</ul>
<p>The contrast between a PsiPEP and a ticket is that for the latter, there’s
no question of whether the task is to be done as described.</p>
</div>
<div class="section" id="comments">
<h2>Comments<a class="headerlink" href="#comments" title="Permalink to this headline">¶</a></h2>
<p>04-Jul-2012, LAB</p>
<p>This is an example comment that refers to <a class="reference internal" href="#sec-pep1"><span>PEP1: Proposing PsiPEP for Psi4</span></a> and a trac ticket <a href="#id1"><span class="problematic" id="id2">:trac:`#221`</span></a>.</p>
<hr class="docutils" />
<style type="text/css"><!--
.green {color: red;}
.sc {font-variant: small-caps;}
--></style></div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">PEP1: Proposing PsiPEP for <span class="sc">Psi4</span></a><ul>
<li><a class="reference internal" href="#path-of-a-psipep">Path of a PsiPEP</a></li>
<li><a class="reference internal" href="#roles-of-a-psipep-include">Roles of a PsiPEP Include</a></li>
<li><a class="reference internal" href="#comments">Comments</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="psipep.html"
title="previous chapter">PsiPEP: Plans and Practices to Organize <span class="sc">Psi4</span></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="programming.html"
title="next chapter">Programming: Using the Core Libraries</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pep0001.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="relbar-bottom">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="contents.html" title="Table Of Contents"
>toc</a> </li>
<li class="right" >
<a href="programming.html" title="Programming: Using the Core Libraries"
>next</a> </li>
<li class="right" >
<a href="psipep.html" title="PsiPEP: Plans and Practices to Organize Psi4"
>previous</a> </li>
<li><a href="index.html">Psi4 []</a> » </li>
<li class="nav-item nav-item-1"><a href="contributing.html" >Contributions: Intro to Programming in <span class="sc">Psi4</span></a> »</li>
<li class="nav-item nav-item-2"><a href="psipep.html" >PsiPEP: Plans and Practices to Organize <span class="sc">Psi4</span></a> »</li>
</ul>
</div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2015, The Psi4 Project.
Last updated on Tuesday, 12 January 2016 03:10PM.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.3.
</div>
<!-- cloud_sptheme 1.3 -->
</body>
</html>
|