Skip to content

Commit

Permalink
release
Browse files Browse the repository at this point in the history
  • Loading branch information
@michaelaye
michaelaye committed Feb 9, 2022
1 parent 94d36f7 commit eb8f4f4
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 53 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

<!-- do not remove -->

## 0.21.1


### Bugs Squashed

- User functions not exported to library ([#8](https://github.com/michaelaye/nbplanetary/issues/8))
- I forgot the #export line in the cells with the user functions.



## 0.21.0

Expand Down
27 changes: 21 additions & 6 deletions docs/ctx.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@



<div id="b0d920e2-4d0f-4e02-b150-ce437d4ca64e"></div>
<div id="510f4906-de2e-4b80-a21e-ca654155ba61"></div>
<div class="output_subarea output_javascript ">
<script type="text/javascript">
var element = $('#b0d920e2-4d0f-4e02-b150-ce437d4ca64e');
var element = $('#510f4906-de2e-4b80-a21e-ca654155ba61');

(function(root) {
function now() {
Expand Down Expand Up @@ -1687,10 +1687,10 @@



<div id="c218227f-3dc5-4bec-9482-365adf21842d"></div>
<div id="939af6e4-17c6-4e1e-a42e-3a120f8c661e"></div>
<div class="output_subarea output_javascript ">
<script type="text/javascript">
var element = $('#c218227f-3dc5-4bec-9482-365adf21842d');
var element = $('#939af6e4-17c6-4e1e-a42e-3a120f8c661e');

if ((window.PyViz === undefined) || (window.PyViz instanceof HTMLElement)) {
window.PyViz = {comms: {}, comm_status:{}, kernels:{}, receivers: {}, plot_index: []}
Expand Down Expand Up @@ -2190,6 +2190,10 @@
<div class="output_markdown rendered_html output_subarea ">
<h4 id="catch_isis_error" class="doc_header"><code>catch_isis_error</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/ctx.py#L40" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>catch_isis_error</code>(<strong><code>func</code></strong>)</p>
</blockquote>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>func</code></strong> : <em><code>&lt;class 'inspect._empty'&gt;</code></em></li>
</ul>

</div>

Expand Down Expand Up @@ -2221,6 +2225,10 @@ <h4 id="catch_isis_error" class="doc_header"><code>catch_isis_error</code><a hre
<div class="output_markdown rendered_html output_subarea ">
<h3 id="CTXEDR" class="doc_header"><code>class</code> <code>CTXEDR</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/ctx.py#L53" class="source_link" style="float:right">[source]</a></h3><blockquote><p><code>CTXEDR</code>(<strong><code>id_</code></strong>)</p>
</blockquote>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>id_</code></strong> : <em><code>&lt;class 'inspect._empty'&gt;</code></em></li>
</ul>

</div>

Expand Down Expand Up @@ -2586,6 +2594,10 @@ <h3 id="CTXEDR" class="doc_header"><code>class</code> <code>CTXEDR</code><a href
<div class="output_markdown rendered_html output_subarea ">
<h4 id="CTXEDR.calib_pipeline" class="doc_header"><code>CTXEDR.calib_pipeline</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/ctx.py#L137" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>CTXEDR.calib_pipeline</code>(<strong><code>overwrite</code></strong>=<em><code>False</code></em>)</p>
</blockquote>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>overwrite</code></strong> : <em><code>&lt;class 'bool'&gt;</code></em>, <em>optional</em></li>
</ul>

</div>

Expand Down Expand Up @@ -3161,8 +3173,11 @@ <h4 id="CTXEDR.calib_pipeline" class="doc_header"><code>CTXEDR.calib_pipeline</c
<div class="output_markdown rendered_html output_subarea ">
<h3 id="CTXEDRCollection" class="doc_header"><code>class</code> <code>CTXEDRCollection</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/ctx.py#L187" class="source_link" style="float:right">[source]</a></h3><blockquote><p><code>CTXEDRCollection</code>(<strong><code>product_ids</code></strong>)</p>
</blockquote>

<pre><code>Class to deal with a set of CTX products.</code></pre>
<p>Class to deal with a set of CTX products.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>product_ids</code></strong> : <em><code>&lt;class 'inspect._empty'&gt;</code></em></li>
</ul>

</div>

Expand Down
75 changes: 40 additions & 35 deletions docs/hirise.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@



<div id="5964b5a4-57eb-4696-8fc9-45c2b5ee70f2"></div>
<div id="f37b0e0f-e6a0-42c8-926c-78d055cb8b4c"></div>
<div class="output_subarea output_javascript ">
<script type="text/javascript">
var element = $('#5964b5a4-57eb-4696-8fc9-45c2b5ee70f2');
var element = $('#f37b0e0f-e6a0-42c8-926c-78d055cb8b4c');

(function(root) {
function now() {
Expand Down Expand Up @@ -1687,10 +1687,10 @@



<div id="894070bc-77bc-4b48-836b-9e70e5e2a278"></div>
<div id="dbe4f3c5-32b8-401b-90cc-198569eefd22"></div>
<div class="output_subarea output_javascript ">
<script type="text/javascript">
var element = $('#894070bc-77bc-4b48-836b-9e70e5e2a278');
var element = $('#dbe4f3c5-32b8-401b-90cc-198569eefd22');

if ((window.PyViz === undefined) || (window.PyViz instanceof HTMLElement)) {
window.PyViz = {comms: {}, comm_status:{}, kernels:{}, receivers: {}, plot_index: []}
Expand Down Expand Up @@ -2000,18 +2000,16 @@
<div class="output_markdown rendered_html output_subarea ">
<h2 id="OBSERVATION_ID" class="doc_header"><code>class</code> <code>OBSERVATION_ID</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/hirise.py#L30" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>OBSERVATION_ID</code>(<strong><code>obsid</code></strong>=<em><code>None</code></em>)</p>
</blockquote>

<pre><code>Manage HiRISE observation ids.

For example PSP_003092_0985.

`phase` is set to PSP for orbits &lt; 11000, no setting required.

Parameters
----------
obsid : str, optional
<p>Manage HiRISE observation ids.</p>
<p>For example PSP_003092_0985.</p>
<p><code>phase</code> is set to PSP for orbits &lt; 11000, no setting required.</p>
<h2 id="Parameters">Parameters<a class="anchor-link" href="#Parameters"> </a></h2><p>obsid : str, optional
One can optionally also create an 'empty' OBSERVATION_ID object and set the
properties accordingly to create a new obsid.</code></pre>
properties accordingly to create a new obsid.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>obsid</code></strong> : <em><code>&lt;class 'NoneType'&gt;</code></em>, <em>optional</em></li>
</ul>

</div>

Expand Down Expand Up @@ -2161,6 +2159,10 @@ <h2 id="OBSERVATION_ID" class="doc_header"><code>class</code> <code>OBSERVATION_
<div class="output_markdown rendered_html output_subarea ">
<h4 id="check_url_exists" class="doc_header"><code>check_url_exists</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/hirise.py#L106" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>check_url_exists</code>(<strong><code>url</code></strong>)</p>
</blockquote>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>url</code></strong> : <em><code>&lt;class 'inspect._empty'&gt;</code></em></li>
</ul>

</div>

Expand Down Expand Up @@ -2190,23 +2192,19 @@ <h4 id="check_url_exists" class="doc_header"><code>check_url_exists</code><a hre


<div class="output_markdown rendered_html output_subarea ">
<h2 id="PRODUCT_ID" class="doc_header"><code>class</code> <code>PRODUCT_ID</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/hirise.py#L114" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>PRODUCT_ID</code>(<strong><code>initstr</code></strong>=<em><code>None</code></em>)</p>
<h2 id="ProductPathfinder" class="doc_header"><code>class</code> <code>ProductPathfinder</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/hirise.py#L114" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>ProductPathfinder</code>(<strong><code>initstr</code></strong>=<em><code>None</code></em>)</p>
</blockquote>

<pre><code>Manage storage paths for HiRISE RDR products (also EXTRAS.)

Attributes `jp2_path` and `label_path` get you the official RDR product,
with `kind` steering if you get the COLOR or the RED product.
All other properties go to the RDR/EXTRAS folder.

Parameters
----------
initstr : str, optional
PRODUCT_ID string like PSP_003902_0985_RED

Note
----
The "PDS" part of the path is handled in the OBSERVATION_ID class.</code></pre>
<p>Determine paths and URLs for HiRISE RDR products (also EXTRAS.)</p>
<p>Attributes <code>jp2_path</code> and <code>label_path</code> get you the official RDR mosaic product,
with <code>kind</code> steering if you get the COLOR or the RED product.
All other properties go to the RDR/EXTRAS folder.</p>
<h2 id="Parameters">Parameters<a class="anchor-link" href="#Parameters"> </a></h2><p>initstr : str, optional
PRODUCT_ID string like PSP_003902_0985_RED</p>
<h2 id="Note">Note<a class="anchor-link" href="#Note"> </a></h2><p>The "PDS" part of the path is handled in the OBSERVATION_ID class.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>initstr</code></strong> : <em><code>&lt;class 'NoneType'&gt;</code></em>, <em>optional</em></li>
</ul>

</div>

Expand Down Expand Up @@ -2614,8 +2612,12 @@ <h3 id="Paths-and-URLS">Paths and URLS<a class="anchor-link" href="#Paths-and-UR


<div class="output_markdown rendered_html output_subarea ">
<h2 id="RGB_NOMAP" class="doc_header"><code>class</code> <code>RGB_NOMAP</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/hirise.py#L276" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>RGB_NOMAP</code>(<strong><code>obsid</code></strong>)</p>
<h2 id="RGB_NOMAP" class="doc_header"><code>class</code> <code>RGB_NOMAP</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/hirise.py#L278" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>RGB_NOMAP</code>(<strong><code>obsid</code></strong>)</p>
</blockquote>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>obsid</code></strong> : <em><code>&lt;class 'inspect._empty'&gt;</code></em></li>
</ul>

</div>

Expand Down Expand Up @@ -4105,10 +4107,13 @@ <h2 id="RGB_NOMAP" class="doc_header"><code>class</code> <code>RGB_NOMAP</code><


<div class="output_markdown rendered_html output_subarea ">
<h2 id="RGB_NOMAPCollection" class="doc_header"><code>class</code> <code>RGB_NOMAPCollection</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/hirise.py#L348" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>RGB_NOMAPCollection</code>(<strong><code>obsids</code></strong>)</p>
<h2 id="RGB_NOMAPCollection" class="doc_header"><code>class</code> <code>RGB_NOMAPCollection</code><a href="https://github.com/michaelaye/nbplanetary/tree/master/planetarypy/hirise.py#L350" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>RGB_NOMAPCollection</code>(<strong><code>obsids</code></strong>)</p>
</blockquote>

<pre><code>Class to deal with a set of RGB_NOMAP products.</code></pre>
<p>Class to deal with a set of RGB_NOMAP products.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>obsids</code></strong> : <em><code>&lt;class 'inspect._empty'&gt;</code></em></li>
</ul>

</div>

Expand Down
2 changes: 1 addition & 1 deletion notebooks/03_ctx.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1407,7 +1407,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python [conda env:py38] *",
"display_name": "Python [conda env:py38]",
"language": "python",
"name": "conda-env-py38-py"
}
Expand Down
24 changes: 13 additions & 11 deletions notebooks/04_hirise.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -259,10 +259,10 @@
"outputs": [],
"source": [
"# export\n",
"class PRODUCT_ID:\n",
" \"\"\"Manage storage paths for HiRISE RDR products (also EXTRAS.)\n",
"class ProductPathfinder:\n",
" \"\"\"Determine paths and URLs for HiRISE RDR products (also EXTRAS.)\n",
"\n",
" Attributes `jp2_path` and `label_path` get you the official RDR product,\n",
" Attributes `jp2_path` and `label_path` get you the official RDR mosaic product,\n",
" with `kind` steering if you get the COLOR or the RED product.\n",
" All other properties go to the RDR/EXTRAS folder.\n",
"\n",
Expand Down Expand Up @@ -348,7 +348,7 @@
" if tokens[-1] == \"url\":\n",
" return self._make_url(\"_\".join(tokens[:-1]))\n",
" except IndexError:\n",
" raise ValueError(f\"No attribute named '{item}' found.\")\n",
" raise AttributeError(f\"No attribute named '{item}' found.\")\n",
"\n",
" @property\n",
" def jp2_fname(self):\n",
Expand All @@ -369,36 +369,36 @@
" if self.kind in [\"RED\", \"IRB\", \"RGB\"]:\n",
" return f\"EXTRAS/RDR/{self.storage_stem}.NOMAP.JP2\"\n",
" else:\n",
" raise AttributeError(f\"No NOMAP exists for {self.kind}.\")\n",
" raise ValueError(f\"No NOMAP exists for {self.kind}.\")\n",
"\n",
" @property\n",
" def quicklook_path(self):\n",
" if self.kind in [\"COLOR\", \"RED\"]:\n",
" return Path(\"EXTRAS/RDR/\") / (self.storage_stem + \".QLOOK.JP2\")\n",
" else:\n",
" raise AttributeError(f\"No quicklook exists for {self.kind} products.\")\n",
" raise ValueError(f\"No quicklook exists for {self.kind} products.\")\n",
"\n",
" @property\n",
" def abrowse_path(self):\n",
" if self.kind in [\"COLOR\", \"MIRB\", \"MRGB\", \"RED\"]:\n",
" return Path(\"EXTRAS/RDR/\") / (self.storage_stem + \".abrowse.jpg\")\n",
" else:\n",
" raise AttributeError(f\"No abrowse exists for {self.kind}\")\n",
" raise ValueError(f\"No abrowse exists for {self.kind}\")\n",
"\n",
" @property\n",
" def browse_path(self):\n",
" inset = \"\"\n",
" if self.kind in [\"IRB\", \"RGB\"]:\n",
" inset = \".NOMAP\"\n",
" if self.kind not in [\"COLOR\", \"MIRB\", \"MRGB\", \"RED\", \"IRB\", \"RGB\"]:\n",
" raise AttributeError(f\"No browse exists for {self.kind}\")\n",
" raise ValueError(f\"No browse exists for {self.kind}\")\n",
" else:\n",
" return Path(\"EXTRAS/RDR/\") / (self.storage_stem + inset + \".browse.jpg\")\n",
"\n",
" @property\n",
" def thumbnail_path(self):\n",
" if self.kind in [\"BG\", \"IR\"]:\n",
" raise AttributeError(f\"No thumbnail exists for {self.kind}\")\n",
" raise ValueError(f\"No thumbnail exists for {self.kind}\")\n",
" inset = \"\"\n",
" if self.kind in [\"IRB\", \"RGB\"]:\n",
" inset = \".NOMAP\"\n",
Expand All @@ -409,12 +409,14 @@
" if self.kind in [\"RED\", \"IRB\", \"RGB\"]:\n",
" return Path(\"EXTRAS/RDR\") / (self.storage_stem + \".NOMAP.thumb.jpg\")\n",
" else:\n",
" raise AttributeError(f\"No NOMAP thumbnail exists for {self.kind}\")\n",
" raise ValueError(f\"No NOMAP thumbnail exists for {self.kind} images.\")\n",
"\n",
" @property\n",
" def nomap_browse_path(self):\n",
" if self.kind in [\"RED\", \"IRB\", \"RGB\"]:\n",
" return Path(\"EXTRAS/RDR\") / (self.storage_stem + \".NOMAP.browse.jpg\")\n",
" else:\n",
" raise ValueError(f\"No NOMAP browse exists for {self.kind} images.\")\n",
"\n",
" @property\n",
" def edr_storage_stem(self):\n",
Expand Down Expand Up @@ -2177,7 +2179,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python [conda env:py38] *",
"display_name": "Python [conda env:py38]",
"language": "python",
"name": "conda-env-py38-py"
}
Expand Down

0 comments on commit eb8f4f4

Please sign in to comment.