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

Minor documentation updates for installation on MacOS #446

Merged
merged 60 commits into from
May 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
7888f1a
add docs
gspetro Feb 11, 2022
055cab8
reformat intro to make reusable
gspetro Feb 11, 2022
b038f39
fixed ref link
gspetro Feb 11, 2022
9002252
deleted extraneous files
gspetro Feb 15, 2022
8b63ba4
updates to intro & pared down README.md
gspetro Feb 16, 2022
b2e87e1
Merge branch 'NOAA-EMC:develop' into develop
gspetro-NOAA Feb 16, 2022
248bf25
edit conf.py
gspetro Feb 17, 2022
a723bd2
add sphinx_rst_theme to extensions in conf.py
gspetro Feb 17, 2022
da39f1c
more edits to conf.py
gspetro Feb 17, 2022
3d99f1c
edits to conf.py
gspetro Feb 17, 2022
50da53b
edits for rtd theme issue
gspetro Feb 17, 2022
c16a69e
edits for rtd theme issue
gspetro Feb 17, 2022
559e3b0
fixed ReadTheDocs css issue
gspetro Feb 17, 2022
485e7c6
fix another ReadTheDocs css issue
gspetro Feb 17, 2022
52d227f
intro & install edits to remove SRW references
gspetro Feb 17, 2022
174286c
hpc-stack-specific intro contained in one file
gspetro Feb 17, 2022
e89dad9
fix numbering in hpc-install
gspetro Feb 18, 2022
362435a
Natalie's edits and prereqs outline
gspetro Feb 18, 2022
d1b8815
fix table & hyperlink issues
gspetro Feb 18, 2022
bf2320b
parameters update
gspetro Feb 22, 2022
5784e7b
update container install
gspetro Feb 22, 2022
f8b3216
update to hpc module location
gspetro Feb 23, 2022
e35bc5b
added MPI definition, odds & ends
gspetro Feb 28, 2022
41f27f0
fix typos
gspetro Feb 28, 2022
98ba6d1
fix typos
gspetro Feb 28, 2022
e986b20
fix typos
gspetro Feb 28, 2022
d789753
fix formatting throughout
gspetro Feb 28, 2022
6505ea6
fix typos/formatting
gspetro Feb 28, 2022
26d0672
fix typos/formatting
gspetro Feb 28, 2022
66d3cd6
moved disclaimer from Additional Notes to Intro
gspetro Feb 28, 2022
5e73fc4
Merge branch 'develop' into develop
kgerheiser Feb 28, 2022
ec4e502
fix readme
gspetro Mar 1, 2022
b48602e
Merge Kyle's remote changes into local
gspetro Mar 1, 2022
7495c03
Merge branch 'develop' into develop
kgerheiser Mar 1, 2022
7db4e1e
Merge branch 'develop' into develop
kgerheiser Mar 2, 2022
be44c41
Merge branch 'develop' into develop
kgerheiser Mar 2, 2022
6827b6e
added installation guidelines for MacOS
gspetro Apr 6, 2022
81943a0
added installation guidelines for MacOS
gspetro Apr 6, 2022
1a07e8a
minor formatting
gspetro Apr 6, 2022
b380d43
minor edits
gspetro Apr 8, 2022
6214f26
minor edits
gspetro Apr 8, 2022
8c4ad13
Merge branch 'NOAA-EMC:develop' into develop
gspetro-NOAA Apr 11, 2022
4abc0d1
Merge branch 'develop' into textonly/macinstall
gspetro Apr 11, 2022
015a759
remove $
gspetro Apr 11, 2022
537fb2e
remove {}
gspetro Apr 11, 2022
730a690
minor edits
gspetro Apr 11, 2022
3ff1174
minor edits
gspetro Apr 11, 2022
2bd3282
minor edits
gspetro Apr 11, 2022
d590694
change commands to work for older bash/Macs
gspetro Apr 12, 2022
4e3e196
Merge branch 'NOAA-EMC:develop' into develop
gspetro-NOAA Apr 12, 2022
3f42fc2
Merge remote-tracking branch 'origin' into textonly/macinstall
gspetro Apr 12, 2022
215b8b4
change commands to work for older bash/Macs
gspetro Apr 12, 2022
f19a858
change Sphinx formatting for SRW submodule inclusion
gspetro Apr 13, 2022
879329d
Merge branch 'NOAA-EMC:develop' into textonly/macinstall
gspetro-NOAA Apr 13, 2022
0309f57
Merge branch 'develop' into textonly/macinstall
kgerheiser Apr 18, 2022
5cb0b3e
Merge branch 'NOAA-EMC:develop' into textonly/macinstall
gspetro-NOAA Apr 29, 2022
45cb5ab
typos
gspetro May 6, 2022
ae309fa
add openssl@3 installation
gspetro May 6, 2022
8da326a
details
gspetro May 9, 2022
3a63dd8
Switch ssh clone to https clone
gspetro May 10, 2022
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
2 changes: 1 addition & 1 deletion docs/source/hpc-components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The HPC-Stack packages are built in :numref:`Step %s <NonConHPCBuild>` using the
* `NCEPLIBS-ncio <https://github.com/noaa-emc/nceplibs-ncio.git>`__
* `NCEPLIBS-wrf_io <https://github.com/noaa-emc/nceplibs-wrf_io.git>`__
* `EMC_crtm <https://github.com/noaa-emc/EMC_crtm.git>`__
* `EMC_post <https://github.com/noaa-emc/EMC_post.git>`__
* `UPP <https://github.com/NOAA-EMC/UPP>`__


* **JEDI Dependencies**
Expand Down
41 changes: 34 additions & 7 deletions docs/source/mac-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,36 @@ To upgrade the make utility via homebrew:
brew upgrade make


.. _InstallOpenssl:

Install Openssl@3
^^^^^^^^^^^^^^^^^^^^^
To install the openssl@3 package, run:

.. code-block:: console

brew install openssl@3

Note the messages at the end of the installation. Depending on what they say, users may need to add the location of the openssl@3 binaries to the environment variable ``$PATH``. To add it to the ``PATH``, run:

.. code-block:: console

echo 'export PATH="/opt/homebrew/opt/openssl@3/bin:$PATH"' >> ~/.bashrc

Users may also need to set certain flags so that the compilers can find the openssl@3 package:

.. code-block:: console

export LDFLAGS="-L/opt/homebrew/opt/openssl@3/lib"
export CPPFLAGS="-I/opt/homebrew/opt/openssl@3/include"


.. _InstallLmod:

Install Lmod
^^^^^^^^^^^^^^^^

Install Lmod, the module management environment:
Install Lmod, which is the module management environment, run:

.. code-block:: console

Expand All @@ -117,13 +140,15 @@ For the Option 1 installation, add:

.. code-block:: console

source /opt/homebrew/opt/lmod/init/profile
export BASH_ENV="/opt/homebrew/opt/lmod/init/bash"
source $BASH_ENV

For the Option 2 installation, add:

.. code-block:: console

source /usr/local/opt/lmod/init/profile
export BASH_ENV="/usr/local/opt/lmod/init/bash"
source $BASH_ENV

.. _InstallLibpng:

Expand Down Expand Up @@ -160,7 +185,7 @@ First, verify that Python3 is installed, and check the current version:

The first command should return ``/usr/bin/python3`` and the second should return ``Python 3.8.2`` or similar (the exact version is unimportant).

If necessary, download an updated version of Python3 for MacOS from https://www.python.org/downloads. The version 3.9.11 64-bit universal2 installer package is recommended (i.e., ``python-3.9.11-macosc10.9.pkg``). Double-click on the installer package, and accept the license terms. An administrative level password will be requested for the installation. At the end of the installation, run ``Install Certificates.command`` by double-clicking on the shell script in Finder.app that opens and runs it.
If necessary, download an updated version of Python3 for MacOS from https://www.python.org/downloads. The version 3.9.11 64-bit universal2 installer package is recommended (i.e., ``python-3.9.11-macos11.pkg``). Double-click on the installer package, and accept the license terms. An administrative level password will be requested for the installation. At the end of the installation, run ``Install Certificates.command`` by double-clicking on the shell script in Finder.app that opens and runs it.

Start a new bash session (type ``bash`` in the existing terminal), and verify the installed version:

Expand Down Expand Up @@ -191,7 +216,7 @@ Download HPC-Stack code from `GitHub <github.com>`__:

.. code-block:: console

git clone git@github.com:NOAA-EMC/hpc-stack.git
git clone https://github.com/NOAA-EMC/hpc-stack.git
cd hpc-stack

The configuration files are ``./config/config_<machine>.sh``. For Option 1, ``<machine>`` is ``mac_m1_gnu`` and for Option 2, ``<machine>`` is ``mac_gnu``.
Expand All @@ -207,13 +232,15 @@ For Option 1:

.. code-block:: console

source /opt/homebrew/opt/lmod/init/profile
export BASH_ENV="/opt/homebrew/opt/lmod/init/profile"
source $BASH_ENV

For Option 2:

.. code-block:: console

source /usr/local/opt/lmod/init/profile
export BASH_ENV="/usr/local/opt/lmod/init/profile"
source $BASH_ENV
kgerheiser marked this conversation as resolved.
Show resolved Hide resolved


Specify Compiler, Python, and MPI
Expand Down