Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR for only record #949

Closed
wants to merge 82 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
82 commits
Select commit Hold shift + click to select a range
8ae2c3f
test
lee1043 Nov 4, 2020
c2653b3
initial commit
acordonez Nov 4, 2020
19f1c2c
add .nojekyll
acordonez Nov 4, 2020
35c84e2
add rtd theme and other configs
acordonez Nov 4, 2020
3624fed
first pass at text
acordonez Nov 4, 2020
c75dcd0
move doc folder to docs
acordonez Nov 4, 2020
9cc98ba
add build
acordonez Nov 4, 2020
9ace150
move html to docs
acordonez Nov 4, 2020
8a9224d
stop tracking build
acordonez Nov 4, 2020
fc8358f
move html and doctrees
acordonez Nov 4, 2020
989844a
move .nojekyll
acordonez Nov 4, 2020
90b47de
add index
acordonez Nov 5, 2020
c22d749
remove this index
acordonez Nov 5, 2020
4524273
try moving html files to docs
acordonez Nov 5, 2020
a3a684d
remove doc folder
acordonez Nov 9, 2020
d01430a
move .nojekyll
acordonez Nov 9, 2020
9d2282b
Merge branch '648_jwl_documentation' of https://github.com/PCMDI/pcmd…
acordonez Nov 9, 2020
f2464f1
Merge branch '653_ao_newdocs' of https://github.com/acordonez/pcmdi_m…
acordonez Nov 10, 2020
4ca2af7
remove index.md
acordonez Nov 10, 2020
bd96e5a
simple change
gleckler1 Nov 12, 2020
5682adf
folder cleanup and add make github
acordonez Nov 12, 2020
2017754
Merge pull request #655 from acordonez/653_ao_docscleanup
gleckler1 Nov 12, 2020
5e3f7e6
add back obs_info_dictionary file for circleci
acordonez Nov 16, 2020
3379c3f
fix symbolic link
acordonez Nov 16, 2020
8e65f4f
fix symbolic link again
acordonez Nov 16, 2020
610fd98
replace /doc with /docs
acordonez Nov 16, 2020
08ded5a
Merge pull request #656 from PCMDI/653_ao_docs_obs
gleckler1 Nov 17, 2020
327a7ec
Merge pull request #654 from gleckler1/doc_test2_pjg
Nov 18, 2020
b8fd5fb
Add documentation instructions to readme
Nov 20, 2020
dcac299
Small formatting edits
Nov 20, 2020
56d56ab
a few more tests
gleckler1 Nov 24, 2020
c2b6e42
Merge pull request #657 from PCMDI/doc_test2_pjg
gleckler1 Nov 24, 2020
05003c1
still testing
gleckler1 Nov 24, 2020
f3c5b3e
Merge pull request #658 from PCMDI/doc_test2_pjg
gleckler1 Nov 24, 2020
af6857c
tech file added
gleckler1 Nov 24, 2020
7e2c875
Merge pull request #659 from PCMDI/doc_test2_pjg
gleckler1 Nov 24, 2020
0638c54
still learning
gleckler1 Nov 24, 2020
c04f560
still trying
gleckler1 Nov 24, 2020
a6818c3
Merge pull request #660 from PCMDI/doc_test2_pjg
gleckler1 Nov 24, 2020
4932aa0
starting tech intro
gleckler1 Nov 25, 2020
dfd6cac
Merge pull request #661 from PCMDI/doc_test2_pjg
gleckler1 Nov 25, 2020
086692d
only one install page now
gleckler1 Dec 1, 2020
68d20fd
adding new rst files
gleckler1 Dec 1, 2020
066ceae
Merge pull request #662 from PCMDI/doc_test2_pjg
gleckler1 Dec 1, 2020
4cd7db2
updating
gleckler1 Dec 24, 2020
488ece6
retesting
gleckler1 Dec 24, 2020
c5262b3
Merge pull request #666 from PCMDI/doc_test2_pjg
gleckler1 Dec 24, 2020
8e19d0e
back at it
gleckler1 Jan 14, 2021
5cc847f
Merge pull request #672 from PCMDI/doc_test2_pjg
gleckler1 Jan 14, 2021
318036c
minor index changes
gleckler1 Jan 15, 2021
c819c09
Merge pull request #673 from PCMDI/doc_test2_pjg
gleckler1 Jan 15, 2021
05cd461
another test
gleckler1 Jan 16, 2021
d091417
Merge pull request #674 from PCMDI/doc_test2_pjg
gleckler1 Jan 16, 2021
fe3d8f9
adding more bits
gleckler1 Jan 19, 2021
0db6ee0
Merge pull request #675 from PCMDI/doc_test2_pjg
gleckler1 Jan 19, 2021
e267bd6
added new htmls
gleckler1 Jan 19, 2021
bb26ee2
adding again1
gleckler1 Jan 19, 2021
de08f6b
adding again2
gleckler1 Jan 19, 2021
1c70565
updating index
gleckler1 Jan 20, 2021
8015e9e
Merge pull request #676 from PCMDI/doc_test2_pjg
gleckler1 Jan 20, 2021
adc9a41
minor doc updates
gleckler1 Jan 28, 2021
c280ccb
added old install
gleckler1 Jan 28, 2021
a73676e
working on downloads
gleckler1 Jan 29, 2021
0f06b19
updates on downloading data
gleckler1 Feb 1, 2021
e221764
Merge pull request #684 from PCMDI/doc_test2_pjg
gleckler1 Feb 1, 2021
1c49f1c
starting to work on mean climate
gleckler1 Feb 2, 2021
d30a8a2
Merge pull request #685 from PCMDI/doc_test2_pjg
gleckler1 Feb 2, 2021
9154e5a
added mean clim reqd params
gleckler1 Feb 2, 2021
49d62e6
Merge pull request #686 from PCMDI/doc_test2_pjg
gleckler1 Feb 2, 2021
54c325b
minor mean climate edits
gleckler1 Feb 4, 2021
fe608e8
disc of mean options
gleckler1 Feb 4, 2021
58e4de0
Get up-to-date master
gleckler1 Feb 9, 2021
763494d
intro to subdaily precip
gleckler1 Feb 11, 2021
aea1f25
Merge pull request #690 from PCMDI/doc_test2_pjg
gleckler1 Feb 11, 2021
fd2d5f3
mjo and monsoons
gleckler1 Mar 2, 2021
20345fa
Merge pull request #702 from PCMDI/doc_test2_pjg
gleckler1 Mar 2, 2021
fd75abb
fixing mjo
gleckler1 Mar 2, 2021
5e01f5e
Merge pull request #703 from PCMDI/doc_test2_pjg
gleckler1 Mar 2, 2021
484c8e2
pjg testing
Jan 26, 2022
68f5bd8
updating installation on doc pages
Jan 26, 2022
0ff8c48
install info improved
Jan 26, 2022
193e111
update to include mamba install and xcdat
lee1043 Apr 4, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
working on downloads
  • Loading branch information
gleckler1 committed Jan 29, 2021
commit a73676eb9b6d35f6684f3527fc25e7ef574fd012
22 changes: 10 additions & 12 deletions docs/Supporting-data.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Documentation and Demos" href="metrics-overview.html" />
<link rel="next" title="Documentation and Demos" href="metrics-overview.html" />
<link rel="prev" title="Technical Overview" href="Technical-overview.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -84,10 +85,7 @@
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Technical-overview.html">Technical Overview</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Retrieving data for demos and use of the PMP</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#overview">Overview</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Retrieving data for demos and use of the PMP</a></li>
<li class="toctree-l1"><a class="reference internal" href="metrics-overview.html">Documentation and Demos</a></li>
<li class="toctree-l1"><a class="reference internal" href="pmpparser.html">Miscellaneous</a></li>
</ul>
Expand Down Expand Up @@ -157,27 +155,25 @@

<div class="section" id="retrieving-data-for-demos-and-use-of-the-pmp">
<span id="using-the-package"></span><h1>Retrieving data for demos and use of the PMP<a class="headerlink" href="#retrieving-data-for-demos-and-use-of-the-pmp" title="Permalink to this headline">¶</a></h1>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>Sample model and observational data are provided via a <a class="reference external" href="https://github.com/acordonez/pcmdi_metrics/blob/645_notebooks/doc/jupyter/Demo/Demo_0_download_data.ipynb">jupyter notebook demo</a>.</p>
<p>For users that are unfamiliar with Jupyter notebooks, a little python code for retrieving the demo data is repeated below.</p>
<p>For users that are unfamiliar with Jupyter notebooks or just want to download the sample data, without interactively running the demo, you can download the data by launching python from a PMP environment created from conda.</p>
<p>you can then enter the following</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">requests</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;https://pcmdiweb.llnl.gov/pss/pmpdata/cmec_tutorial_files.txt&quot;</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">&quot;data_files.txt&quot;</span><span class="p">,</span><span class="s2">&quot;wb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">content</span><span class="p">)</span>
</pre></div>
</div>
<p>To retrieve these sample files locally, one first sets the location where they want the demo data to be stored locally.</p>
<p>You can then specify where you want to store the demo data locally:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">demo_data_directory</span> <span class="o">=</span> <span class="s1">&#39;MyDemoPath&#39;</span>
</pre></div>
</div>
<p>The last line sets the demo_output directories. After that, data is downloaded as follows:</p>
<p>After you have set the location for the demo_output you can downloaded it by entering the following:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">cdat_info</span>
<span class="n">cdat_info</span><span class="o">.</span><span class="n">download_sample_data_files</span><span class="p">(</span><span class="s2">&quot;data_files.txt&quot;</span><span class="p">,</span> <span class="n">demo_data_directory</span><span class="p">)</span>
</pre></div>
</div>
<p>First, make sure you are in a functioning PMP environemnt (see <a class="reference internal" href="install.html#install"><span class="std std-ref">Install using Anaconda</span></a>).</p>
</div>
<p>The PMP demo data is used for multiple demos. It is ~300MB. The best way to run these demos is via Jupyter notebooks.</p>
</div>


Expand All @@ -191,6 +187,8 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
<a href="metrics-overview.html" class="btn btn-neutral float-right" title="Documentation and Demos" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="Technical-overview.html" class="btn btn-neutral float-left" title="Technical Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>


Expand Down
5 changes: 2 additions & 3 deletions docs/Technical-overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Install using Anaconda" href="install-using-anaconda.html" />
<link rel="next" title="Retrieving data for demos and use of the PMP" href="Supporting-data.html" />
<link rel="prev" title="PCMDI Metrics Package (PMP)" href="index.html" />
</head>

Expand Down Expand Up @@ -93,7 +93,6 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install-using-anaconda.html">Install using Anaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="Supporting-data.html">Retrieving data for demos and use of the PMP</a></li>
<li class="toctree-l1"><a class="reference internal" href="metrics-overview.html">Documentation and Demos</a></li>
<li class="toctree-l1"><a class="reference internal" href="pmpparser.html">Miscellaneous</a></li>
Expand Down Expand Up @@ -206,7 +205,7 @@ <h3>Basic Operation<a class="headerlink" href="#basic-operation" title="Permalin

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="install-using-anaconda.html" class="btn btn-neutral float-right" title="Install using Anaconda" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Supporting-data.html" class="btn btn-neutral float-right" title="Retrieving data for demos and use of the PMP" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="index.html" class="btn btn-neutral float-left" title="PCMDI Metrics Package (PMP)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
Expand Down
14 changes: 7 additions & 7 deletions docs/_sources/Supporting-data.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@
Retrieving data for demos and use of the PMP
*****************

Overview
========

Sample model and observational data are provided via a `jupyter notebook demo <https://github.com/acordonez/pcmdi_metrics/blob/645_notebooks/doc/jupyter/Demo/Demo_0_download_data.ipynb>`_.

For users that are unfamiliar with Jupyter notebooks, a little python code for retrieving the demo data is repeated below. ::
For users that are unfamiliar with Jupyter notebooks or just want to download the sample data, without interactively running the demo, you can download the data by launching python from a PMP environment created from conda.

you can then enter the following ::

import requests
r = requests.get("https://pcmdiweb.llnl.gov/pss/pmpdata/cmec_tutorial_files.txt")
with open("data_files.txt","wb") as f:
f.write(r.content)


To retrieve these sample files locally, one first sets the location where they want the demo data to be stored locally. ::
You can then specify where you want to store the demo data locally: ::

demo_data_directory = 'MyDemoPath'


The last line sets the demo_output directories. After that, data is downloaded as follows: ::
After you have set the location for the demo_output you can downloaded it by entering the following: ::

import cdat_info
cdat_info.download_sample_data_files("data_files.txt", demo_data_directory)

The PMP demo data is used for multiple demos. It is ~300MB. The best way to run these demos is via Jupyter notebooks.


First, make sure you are in a functioning PMP environemnt (see :ref:`install`).

15 changes: 15 additions & 0 deletions docs/_sources/install-old.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _install:

*******
Installation
*******

The supported method for installing the PMP within a local environment is via `Anaconda <https://conda.io/en/latest/>`.
The source code is also available to developers via the PMP Github repository.

Anaconda installation (recommended)
===================================

* :ref:`install-anaconda` - Installation instructions for Anaconda users

A primary advantage of the Anaconda install path is that it is user-centric. This allows users on super computing systems with limited permissions to fully configure their local PMP install
7 changes: 3 additions & 4 deletions docs/clivar-enso-metrics.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="PMPParser" href="pmpparser.html" />
<link rel="next" title="Miscellaneous" href="pmpparser.html" />
<link rel="prev" title="Extra-tropical modes of variability" href="extrop-mov.html" />
</head>

Expand Down Expand Up @@ -85,7 +85,6 @@
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Technical-overview.html">Technical Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="install-using-anaconda.html">Install using Anaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="Supporting-data.html">Retrieving data for demos and use of the PMP</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="metrics-overview.html">Documentation and Demos</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="metrics-overview.html#overview">Overview</a><ul class="current">
Expand All @@ -99,7 +98,7 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pmpparser.html">PMPParser</a></li>
<li class="toctree-l1"><a class="reference internal" href="pmpparser.html">Miscellaneous</a></li>
</ul>


Expand Down Expand Up @@ -183,7 +182,7 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="pmpparser.html" class="btn btn-neutral float-right" title="PMPParser" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="pmpparser.html" class="btn btn-neutral float-right" title="Miscellaneous" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="extrop-mov.html" class="btn btn-neutral float-left" title="Extra-tropical modes of variability" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
Expand Down
3 changes: 1 addition & 2 deletions docs/extrop-mov.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Technical-overview.html">Technical Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="install-using-anaconda.html">Install using Anaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="Supporting-data.html">Retrieving data for demos and use of the PMP</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="metrics-overview.html">Documentation and Demos</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="metrics-overview.html#overview">Overview</a><ul class="current">
Expand All @@ -99,7 +98,7 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pmpparser.html">PMPParser</a></li>
<li class="toctree-l1"><a class="reference internal" href="pmpparser.html">Miscellaneous</a></li>
</ul>


Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ <h1>PCMDI Metrics Package (PMP)<a class="headerlink" href="#pcmdi-metrics-packag
</div>
<div class="section" id="getting-started">
<h2>GETTING STARTED<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
<p>Installation requirements and instructions are available on the <a class="reference internal" href="install.html#install"><span class="std std-ref">Install using Anaconda</span></a> page</p>
<p>Installation requirements and instructions are available on the <a class="reference internal" href="install-old.html#install"><span class="std std-ref">Installation</span></a> page</p>
<p>An overview for using the package and template scripts are detailed on the <span class="xref std std-ref">metrics-overview</span> page</p>
<p>Some installation support for CMIP participating modeling groups is available: <a class="reference external" href="mailto:pcmdi-metrics&#37;&#52;&#48;llnl&#46;gov">pcmdi-metrics<span>&#64;</span>llnl<span>&#46;</span>gov</a></p>
</div>
Expand Down
Loading