Skip to content

Commit

Permalink
Prepare for release: CHANGELOG and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CCampJr committed Oct 13, 2022
1 parent 780311d commit 6e63bc1
Show file tree
Hide file tree
Showing 137 changed files with 429 additions and 410 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ This document records all notable changes to
This project adheres to `PEP 440 -- Version Identification
and Dependency Specification <https://www.python.org/dev/peps/pep-0440/>`_.

0.4.4 (22-10-13)
-----------------
- Bug fixes (x- and y-axis vectors failing to generate with imported HDF5 files)
- Minor tweaks and improvements

0.4.3 (22-08-03)
----------------
- Spectrum and Hsi now moved to **data.spectra**. **This could break your fork if you have custom code.**
Expand Down
Binary file modified docs/build/doctrees/crikit.io.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 79acee3da732a2077d4e910c14203444
config: 126e78dc37b63522d8e4d07dce0d2051
tags: 645f666f9bcd5a90fca523b33c5a78b7
11 changes: 5 additions & 6 deletions docs/build/html/_modules/crikit/CRIkitUI.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>crikit.CRIkitUI &#8212; CRIKit2 0.4.3 documentation</title>
<title>crikit.CRIkitUI &#8212; CRIKit2 0.4.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/nature.css" />
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
Expand All @@ -24,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.CRIkitUI</a></li>
</ul>
Expand Down Expand Up @@ -931,9 +931,8 @@ <h1>Source code for crikit.CRIkitUI</h1><div class="highlight"><pre>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ui</span><span class="o">.</span><span class="n">actionUndo_Backup_Enabled</span><span class="o">.</span><span class="n">isChecked</span><span class="p">():</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">_BCPre</span><span class="o">.</span><span class="n">backup_pickle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">hsi</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">bcpre</span><span class="o">.</span><span class="n">id_list</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">_traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">(</span><span class="n">limit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="n">_traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Error in pickle backup (Undo functionality)&#39;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bcpre</span><span class="o">.</span><span class="n">backed_up</span><span class="p">()</span>
Expand Down Expand Up @@ -3908,7 +3907,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.CRIkitUI</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/crikit/cri/algorithms/kk.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>crikit.cri.algorithms.kk &#8212; CRIKit2 0.4.3 documentation</title>
<title>crikit.cri.algorithms.kk &#8212; CRIKit2 0.4.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/nature.css" />
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
Expand All @@ -24,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.algorithms.kk</a></li>
</ul>
Expand Down Expand Up @@ -274,7 +274,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.algorithms.kk</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/crikit/cri/error_correction.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>crikit.cri.error_correction &#8212; CRIKit2 0.4.3 documentation</title>
<title>crikit.cri.error_correction &#8212; CRIKit2 0.4.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/nature.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand All @@ -24,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.error_correction</a></li>
</ul>
Expand Down Expand Up @@ -355,7 +355,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.error_correction</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/crikit/cri/kk.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>crikit.cri.kk &#8212; CRIKit2 0.4.3 documentation</title>
<title>crikit.cri.kk &#8212; CRIKit2 0.4.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/nature.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand All @@ -24,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.kk</a></li>
</ul>
Expand Down Expand Up @@ -363,7 +363,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.kk</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/crikit/cri/merge_nrbs.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>crikit.cri.merge_nrbs &#8212; CRIKit2 0.4.3 documentation</title>
<title>crikit.cri.merge_nrbs &#8212; CRIKit2 0.4.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/nature.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand All @@ -24,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.merge_nrbs</a></li>
</ul>
Expand Down Expand Up @@ -175,7 +175,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.merge_nrbs</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/crikit/cri/tests/test_hilbert.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>crikit.cri.tests.test_hilbert &#8212; CRIKit2 0.4.3 documentation</title>
<title>crikit.cri.tests.test_hilbert &#8212; CRIKit2 0.4.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/nature.css" />
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
Expand All @@ -24,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.tests.test_hilbert</a></li>
</ul>
Expand Down Expand Up @@ -116,7 +116,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.tests.test_hilbert</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/crikit/cri/tests/test_kk.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>crikit.cri.tests.test_kk &#8212; CRIKit2 0.4.3 documentation</title>
<title>crikit.cri.tests.test_kk &#8212; CRIKit2 0.4.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/nature.css" />
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
Expand All @@ -24,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.tests.test_kk</a></li>
</ul>
Expand Down Expand Up @@ -159,7 +159,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.tests.test_kk</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/crikit/cri/tests/test_kk_alg.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>crikit.cri.tests.test_kk_alg &#8212; CRIKit2 0.4.3 documentation</title>
<title>crikit.cri.tests.test_kk_alg &#8212; CRIKit2 0.4.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/nature.css" />
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
Expand All @@ -24,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.tests.test_kk_alg</a></li>
</ul>
Expand Down Expand Up @@ -112,7 +112,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.tests.test_kk_alg</a></li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>crikit.cri.tests.test_merge_nrbs &#8212; CRIKit2 0.4.3 documentation</title>
<title>crikit.cri.tests.test_merge_nrbs &#8212; CRIKit2 0.4.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/nature.css" />
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
Expand All @@ -24,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.tests.test_merge_nrbs</a></li>
</ul>
Expand Down Expand Up @@ -93,7 +93,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">CRIKit2 0.4.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">crikit.cri.tests.test_merge_nrbs</a></li>
</ul>
Expand Down
Loading

0 comments on commit 6e63bc1

Please sign in to comment.