Skip to content

Commit 77c43c4

Browse files
JohnVolkJohnVolk
committed
update docs, add manifest.in, conda env
1 parent 2059eff commit 77c43c4

55 files changed

Lines changed: 1372 additions & 22298 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎MANIFEST.in‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
include license
2+
include environment.yml
3+
graft notebooks

‎docs/build/doctrees/api.doctree‎

9.33 KB
Binary file not shown.

‎docs/build/doctrees/cli.doctree‎

575 Bytes
Binary file not shown.

‎docs/build/doctrees/environment.pickle‎

2.07 MB
Binary file not shown.

‎docs/build/doctrees/index.doctree‎

267 Bytes
Binary file not shown.

‎docs/build/doctrees/tutorial.doctree‎

1.03 KB
Binary file not shown.

‎docs/build/html/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 3de3d9b3633f7e1b6ff0a4d823402522
3+
config: 7780509472e0ef8e45a4e9c93bce38c7
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/_modules/index.html‎

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11

2-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<!DOCTYPE html>
43

54
<html xmlns="http://www.w3.org/1999/xhtml">
65
<head>
7-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<meta charset="utf-8" />
97
<title>Overview: module code &#8212; PRMS-Python v1.0.0</title>
108
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
119
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
10+
<link rel="stylesheet" type="text/css" href="../_static/custom.css" />
1211
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
1312
<script type="text/javascript" src="../_static/jquery.js"></script>
1413
<script type="text/javascript" src="../_static/underscore.js"></script>
1514
<script type="text/javascript" src="../_static/doctools.js"></script>
16-
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
15+
<script type="text/javascript" src="../_static/language_data.js"></script>
16+
<script type="text/javascript" src="../_static/copybutton.js"></script>
17+
<script type="text/javascript" src="../_static/custom.js"></script>
18+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/clipboard@1/dist/clipboard.min.js"></script>
19+
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
1720
<link rel="shortcut icon" href="../_static/prms-python-32x.png"/>
1821
<link rel="index" title="Index" href="../genindex.html" />
1922
<link rel="search" title="Search" href="../search.html" />
@@ -57,7 +60,7 @@ <h1>All modules for which code is available</h1>
5760

5861

5962
<p>
60-
<iframe src="https://ghbtns.com/github-btn.html?user=PRMS-Python&repo=docs&type=watch&count=true&size=large&v=2"
63+
<iframe src="https://ghbtns.com/github-btn.html?user=PRMS-Python&repo=PRMS-Python&type=watch&count=true&size=large&v=2"
6164
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
6265
</p>
6366

@@ -72,6 +75,7 @@ <h3>Navigation</h3>
7275
<li class="toctree-l1"><a class="reference internal" href="../cli.html">Command-Line Interface</a></li>
7376
<li class="toctree-l1"><a class="reference internal" href="../api.html">API Reference</a></li>
7477
<li class="toctree-l1"><a class="reference internal" href="../api.html#indices-and-tables">Indices and tables</a></li>
78+
<li class="toctree-l1"><a class="reference internal" href="../citation.html">Citation</a></li>
7579
</ul>
7680

7781
<div class="relations">
@@ -82,17 +86,31 @@ <h3>Related Topics</h3>
8286
</ul>
8387
</div>
8488
<div id="searchbox" style="display: none" role="search">
85-
<h3>Quick search</h3>
89+
<h3 id="searchlabel">Quick search</h3>
8690
<div class="searchformwrapper">
8791
<form class="search" action="../search.html" method="get">
88-
<input type="text" name="q" />
92+
<input type="text" name="q" aria-labelledby="searchlabel" />
8993
<input type="submit" value="Go" />
90-
<input type="hidden" name="check_keywords" value="yes" />
91-
<input type="hidden" name="area" value="default" />
9294
</form>
9395
</div>
9496
</div>
9597
<script type="text/javascript">$('#searchbox').show(0);</script>
98+
99+
100+
<h3 class="donation">Donate/support</h3>
101+
102+
103+
104+
<p>
105+
<a class="badge" href="https://www.patreon.com/bePatron?u=25576909">
106+
<img src="https://img.shields.io/badge/donate-%E2%9D%A4%C2%A0-ff69b4.svg?style=flat" alt="Donate">
107+
</a>
108+
</p>
109+
110+
111+
112+
113+
96114
</div>
97115
</div>
98116
<div class="clearer"></div>
@@ -101,8 +119,8 @@ <h3>Quick search</h3>
101119
&copy;2016, John Volk and Matthew Turner.
102120

103121
|
104-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.6</a>
105-
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
122+
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
123+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
106124

107125
</div>
108126

‎docs/build/html/_modules/prms_python/data.html‎

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11

2-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<!DOCTYPE html>
43

54
<html xmlns="http://www.w3.org/1999/xhtml">
65
<head>
7-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<meta charset="utf-8" />
97
<title>prms_python.data &#8212; PRMS-Python v1.0.0</title>
108
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
119
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
10+
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
1211
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
1312
<script type="text/javascript" src="../../_static/jquery.js"></script>
1413
<script type="text/javascript" src="../../_static/underscore.js"></script>
1514
<script type="text/javascript" src="../../_static/doctools.js"></script>
16-
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
15+
<script type="text/javascript" src="../../_static/language_data.js"></script>
16+
<script type="text/javascript" src="../../_static/copybutton.js"></script>
17+
<script type="text/javascript" src="../../_static/custom.js"></script>
18+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/clipboard@1/dist/clipboard.min.js"></script>
19+
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
1720
<link rel="shortcut icon" href="../../_static/prms-python-32x.png"/>
1821
<link rel="index" title="Index" href="../../genindex.html" />
1922
<link rel="search" title="Search" href="../../search.html" />
@@ -314,7 +317,7 @@ <h1>Source code for prms_python.data</h1><div class="highlight"><pre>
314317

315318

316319
<p>
317-
<iframe src="https://ghbtns.com/github-btn.html?user=PRMS-Python&repo=docs&type=watch&count=true&size=large&v=2"
320+
<iframe src="https://ghbtns.com/github-btn.html?user=PRMS-Python&repo=PRMS-Python&type=watch&count=true&size=large&v=2"
318321
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
319322
</p>
320323

@@ -329,6 +332,7 @@ <h3>Navigation</h3>
329332
<li class="toctree-l1"><a class="reference internal" href="../../cli.html">Command-Line Interface</a></li>
330333
<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Reference</a></li>
331334
<li class="toctree-l1"><a class="reference internal" href="../../api.html#indices-and-tables">Indices and tables</a></li>
335+
<li class="toctree-l1"><a class="reference internal" href="../../citation.html">Citation</a></li>
332336
</ul>
333337

334338
<div class="relations">
@@ -341,17 +345,31 @@ <h3>Related Topics</h3>
341345
</ul>
342346
</div>
343347
<div id="searchbox" style="display: none" role="search">
344-
<h3>Quick search</h3>
348+
<h3 id="searchlabel">Quick search</h3>
345349
<div class="searchformwrapper">
346350
<form class="search" action="../../search.html" method="get">
347-
<input type="text" name="q" />
351+
<input type="text" name="q" aria-labelledby="searchlabel" />
348352
<input type="submit" value="Go" />
349-
<input type="hidden" name="check_keywords" value="yes" />
350-
<input type="hidden" name="area" value="default" />
351353
</form>
352354
</div>
353355
</div>
354356
<script type="text/javascript">$('#searchbox').show(0);</script>
357+
358+
359+
<h3 class="donation">Donate/support</h3>
360+
361+
362+
363+
<p>
364+
<a class="badge" href="https://www.patreon.com/bePatron?u=25576909">
365+
<img src="https://img.shields.io/badge/donate-%E2%9D%A4%C2%A0-ff69b4.svg?style=flat" alt="Donate">
366+
</a>
367+
</p>
368+
369+
370+
371+
372+
355373
</div>
356374
</div>
357375
<div class="clearer"></div>
@@ -360,8 +378,8 @@ <h3>Quick search</h3>
360378
&copy;2016, John Volk and Matthew Turner.
361379

362380
|
363-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.6</a>
364-
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
381+
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
382+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
365383

366384
</div>
367385

‎docs/build/html/_modules/prms_python/optimizer.html‎

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11

2-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<!DOCTYPE html>
43

54
<html xmlns="http://www.w3.org/1999/xhtml">
65
<head>
7-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<meta charset="utf-8" />
97
<title>prms_python.optimizer &#8212; PRMS-Python v1.0.0</title>
108
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
119
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
10+
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
1211
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
1312
<script type="text/javascript" src="../../_static/jquery.js"></script>
1413
<script type="text/javascript" src="../../_static/underscore.js"></script>
1514
<script type="text/javascript" src="../../_static/doctools.js"></script>
16-
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
15+
<script type="text/javascript" src="../../_static/language_data.js"></script>
16+
<script type="text/javascript" src="../../_static/copybutton.js"></script>
17+
<script type="text/javascript" src="../../_static/custom.js"></script>
18+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/clipboard@1/dist/clipboard.min.js"></script>
19+
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
1720
<link rel="shortcut icon" href="../../_static/prms-python-32x.png"/>
1821
<link rel="index" title="Index" href="../../genindex.html" />
1922
<link rel="search" title="Search" href="../../search.html" />
@@ -939,7 +942,7 @@ <h1>Source code for prms_python.optimizer</h1><div class="highlight"><pre>
939942

940943

941944
<p>
942-
<iframe src="https://ghbtns.com/github-btn.html?user=PRMS-Python&repo=docs&type=watch&count=true&size=large&v=2"
945+
<iframe src="https://ghbtns.com/github-btn.html?user=PRMS-Python&repo=PRMS-Python&type=watch&count=true&size=large&v=2"
943946
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
944947
</p>
945948

@@ -954,6 +957,7 @@ <h3>Navigation</h3>
954957
<li class="toctree-l1"><a class="reference internal" href="../../cli.html">Command-Line Interface</a></li>
955958
<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Reference</a></li>
956959
<li class="toctree-l1"><a class="reference internal" href="../../api.html#indices-and-tables">Indices and tables</a></li>
960+
<li class="toctree-l1"><a class="reference internal" href="../../citation.html">Citation</a></li>
957961
</ul>
958962

959963
<div class="relations">
@@ -966,17 +970,31 @@ <h3>Related Topics</h3>
966970
</ul>
967971
</div>
968972
<div id="searchbox" style="display: none" role="search">
969-
<h3>Quick search</h3>
973+
<h3 id="searchlabel">Quick search</h3>
970974
<div class="searchformwrapper">
971975
<form class="search" action="../../search.html" method="get">
972-
<input type="text" name="q" />
976+
<input type="text" name="q" aria-labelledby="searchlabel" />
973977
<input type="submit" value="Go" />
974-
<input type="hidden" name="check_keywords" value="yes" />
975-
<input type="hidden" name="area" value="default" />
976978
</form>
977979
</div>
978980
</div>
979981
<script type="text/javascript">$('#searchbox').show(0);</script>
982+
983+
984+
<h3 class="donation">Donate/support</h3>
985+
986+
987+
988+
<p>
989+
<a class="badge" href="https://www.patreon.com/bePatron?u=25576909">
990+
<img src="https://img.shields.io/badge/donate-%E2%9D%A4%C2%A0-ff69b4.svg?style=flat" alt="Donate">
991+
</a>
992+
</p>
993+
994+
995+
996+
997+
980998
</div>
981999
</div>
9821000
<div class="clearer"></div>
@@ -985,8 +1003,8 @@ <h3>Quick search</h3>
9851003
&copy;2016, John Volk and Matthew Turner.
9861004

9871005
|
988-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.6</a>
989-
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
1006+
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
1007+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
9901008

9911009
</div>
9921010

0 commit comments

Comments
 (0)