Skip to content

Commit 89e1516

Browse files
Update documentation
1 parent 0f4ef7d commit 89e1516

File tree

6 files changed

+75
-12
lines changed

6 files changed

+75
-12
lines changed

main/.doctrees/environment.pickle

25.5 KB
Binary file not shown.

main/.doctrees/quickstart.doctree

3.05 KB
Binary file not shown.

main/_sources/quickstart.md.txt

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Check your system documentation for how to launch interactive compute sessions
6666
E3SM-Unified is not officially supported on Linux or Mac laptops or
6767
workstations, but users can install it using `miniforge3`.
6868

69-
### Step-by-Step (Linux/macOS):
69+
### Step-by-Step (Linux):
7070

7171
```bash
7272
# Install miniforge3
@@ -79,10 +79,36 @@ conda create -n esm-unified -c conda-forge e3sm-unified
7979
# Activate it
8080
conda activate e3sm-unified
8181
```
82+
**Note**: The above instructions also work for macOS machines with intel hardware.
8283

83-
Note: On macOS with M1/M2 chips, install the x86\_64 version and use Rosetta 2
84-
for compatibility.
84+
### Step-by-Step (macOS with Apple Silicon)
8585

86+
```bash
87+
# starts a shell in "Rosetta" mode
88+
arch -x86_64 /bin/bash --login
89+
90+
# create the conda-environment to install e3sm-unified within
91+
CONDA_SUBDIR=osx-64 conda create -n e3sm-unified python=3.10
92+
93+
# activate the environment and set an environmental variable
94+
conda activate e3sm-unified
95+
conda env config vars set CONDA_SUBDIR=osx-64
96+
97+
# deactivate and re-activate the environment for the above command to propagate
98+
conda deactivate
99+
conda activate e3sm-unified
100+
101+
# now you can actually install e3sm-unified
102+
conda install -c conda-forge e3sm-unified
103+
104+
# exit the "Rosetta" mode shell
105+
exit
106+
```
107+
108+
**Checking if you macOS machine has Apple Silicon**:
109+
1. Click the Apple menu at the top-left of your screen.
110+
2. Select "About This Mac": from the dropdown menu.
111+
- If you see "Chip" followed by M1, M2, M3, or M4, your Mac has Apple silicon.
86112
---
87113

88114
## Related Pages

main/_static/js/versions.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
const themeFlyoutDisplay = "hidden";
2-
const themeVersionSelector = "True";
3-
const themeLanguageSelector = "True";
2+
const themeVersionSelector = true;
3+
const themeLanguageSelector = true;
44

55
if (themeFlyoutDisplay === "attached") {
66
function renderLanguages(config) {
77
if (!config.projects.translations.length) {
88
return "";
99
}
1010

11+
// Insert the current language to the options on the selector
12+
let languages = config.projects.translations.concat(config.projects.current);
13+
languages = languages.sort((a, b) => a.language.name.localeCompare(b.language.name));
14+
1115
const languagesHTML = `
1216
<dl>
1317
<dt>Languages</dt>
14-
${config.projects.translations
18+
${languages
1519
.map(
1620
(translation) => `
1721
<dd ${translation.slug == config.projects.current.slug ? 'class="rtd-current-item"' : ""}>

main/quickstart.html

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@
5454
<li class="toctree-l2"><a class="reference internal" href="#verifying-installation">Verifying Installation</a></li>
5555
<li class="toctree-l2"><a class="reference internal" href="#running-on-compute-nodes-optional-but-recommended">Running on Compute Nodes (Optional but Recommended)</a></li>
5656
<li class="toctree-l2"><a class="reference internal" href="#installing-e3sm-unified-on-an-unsupported-system">Installing E3SM-Unified on an Unsupported System</a><ul>
57-
<li class="toctree-l3"><a class="reference internal" href="#step-by-step-linux-macos">Step-by-Step (Linux/macOS):</a></li>
57+
<li class="toctree-l3"><a class="reference internal" href="#step-by-step-linux">Step-by-Step (Linux):</a></li>
58+
<li class="toctree-l3"><a class="reference internal" href="#step-by-step-macos-with-apple-silicon">Step-by-Step (macOS with Apple Silicon)</a></li>
5859
</ul>
5960
</li>
6061
<li class="toctree-l2"><a class="reference internal" href="#related-pages">Related Pages</a></li>
@@ -155,8 +156,8 @@ <h2>Running on Compute Nodes (Optional but Recommended)<a class="headerlink" hre
155156
<h2>Installing E3SM-Unified on an Unsupported System<a class="headerlink" href="#installing-e3sm-unified-on-an-unsupported-system" title="Link to this heading"></a></h2>
156157
<p>E3SM-Unified is not officially supported on Linux or Mac laptops or
157158
workstations, but users can install it using <code class="docutils literal notranslate"><span class="pre">miniforge3</span></code>.</p>
158-
<section id="step-by-step-linux-macos">
159-
<h3>Step-by-Step (Linux/macOS):<a class="headerlink" href="#step-by-step-linux-macos" title="Link to this heading"></a></h3>
159+
<section id="step-by-step-linux">
160+
<h3>Step-by-Step (Linux):<a class="headerlink" href="#step-by-step-linux" title="Link to this heading"></a></h3>
160161
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install miniforge3</span>
161162
wget<span class="w"> </span><span class="s2">&quot;https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-</span><span class="k">$(</span>uname<span class="k">)</span><span class="s2">-</span><span class="k">$(</span>uname<span class="w"> </span>-m<span class="k">)</span><span class="s2">.sh&quot;</span>
162163
bash<span class="w"> </span><span class="s2">&quot;Miniforge3-</span><span class="k">$(</span>uname<span class="k">)</span><span class="s2">-</span><span class="k">$(</span>uname<span class="w"> </span>-m<span class="k">)</span><span class="s2">.sh&quot;</span>
@@ -168,8 +169,40 @@ <h3>Step-by-Step (Linux/macOS):<a class="headerlink" href="#step-by-step-linux-m
168169
conda<span class="w"> </span>activate<span class="w"> </span>e3sm-unified
169170
</pre></div>
170171
</div>
171-
<p>Note: On macOS with M1/M2 chips, install the x86_64 version and use Rosetta 2
172-
for compatibility.</p>
172+
<p><strong>Note</strong>: The above instructions also work for macOS machines with intel hardware.</p>
173+
</section>
174+
<section id="step-by-step-macos-with-apple-silicon">
175+
<h3>Step-by-Step (macOS with Apple Silicon)<a class="headerlink" href="#step-by-step-macos-with-apple-silicon" title="Link to this heading"></a></h3>
176+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># starts a shell in &quot;Rosetta&quot; mode</span>
177+
arch<span class="w"> </span>-x86_64<span class="w"> </span>/bin/bash<span class="w"> </span>--login
178+
179+
<span class="c1"># create the conda-environment to install e3sm-unified within</span>
180+
<span class="nv">CONDA_SUBDIR</span><span class="o">=</span>osx-64<span class="w"> </span>conda<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span>e3sm-unified<span class="w"> </span><span class="nv">python</span><span class="o">=</span><span class="m">3</span>.10
181+
182+
<span class="c1"># activate the environment and set an environmental variable</span>
183+
conda<span class="w"> </span>activate<span class="w"> </span>e3sm-unified
184+
conda<span class="w"> </span>env<span class="w"> </span>config<span class="w"> </span>vars<span class="w"> </span><span class="nb">set</span><span class="w"> </span><span class="nv">CONDA_SUBDIR</span><span class="o">=</span>osx-64
185+
186+
<span class="c1"># deactivate and re-activate the environment for the above command to propagate</span>
187+
conda<span class="w"> </span>deactivate
188+
conda<span class="w"> </span>activate<span class="w"> </span>e3sm-unified
189+
190+
<span class="c1"># now you can actually install e3sm-unified</span>
191+
conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>e3sm-unified
192+
193+
<span class="c1"># exit the &quot;Rosetta&quot; mode shell</span>
194+
<span class="nb">exit</span>
195+
</pre></div>
196+
</div>
197+
<p><strong>Checking if you macOS machine has Apple Silicon</strong>:</p>
198+
<ol class="arabic simple">
199+
<li><p>Click the Apple menu at the top-left of your screen.</p></li>
200+
<li><p>Select “About This Mac”: from the dropdown menu.</p>
201+
<ul class="simple">
202+
<li><p>If you see “Chip” followed by M1, M2, M3, or M4, your Mac has Apple silicon.</p></li>
203+
</ul>
204+
</li>
205+
</ol>
173206
</section>
174207
</section>
175208
<hr class="docutils" />

main/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)