Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rmodrak committed Oct 25, 2023
1 parent 6ac15d9 commit 27322a3
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 12 deletions.
19 changes: 14 additions & 5 deletions docs/install/arm64.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@

Installation on ARM64 systems, including Apple M1 and Apple M2
==============================================================
Installation on ARM64 systems
=============================

First create a conda virtual environment:
To install MTUQ on ARM64 systems, create a conda virtual environment:

.. code::
conda config --prepend channels conda-forge
conda create -n mtuq python=3
Expand Down Expand Up @@ -52,4 +51,14 @@ Finally, install PyGMT:
.. note::

Once linux-aarch64 and osx-arm64 builds are contributed to the Instaseis `conda-forge <https://anaconda.org/conda-forge/instaseis>`_ channel, the above workaround should be unnecessary.
Users may receive the following Instaseis warning message:

`UserWarning: Please don't install from a tarball. Use the proper pypi release or install from git.`

Now that Instaseis PyPI releases are no longer maintained, the above message can be ignored.


.. note::

If `linux-aarch64` or `osx-arm64` builds are ever added to the Instaseis `conda-forge channel <https://anaconda.org/conda-forge/instaseis>`_, the above workaround may become unnecessary.

7 changes: 3 additions & 4 deletions docs/install/index.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
Installation
============

We recommend installing MTUQ under Anaconda or Miniconda, which, if not already present, can be obtained following these `instructions <https://conda.io/projects/conda/en/latest/user-guide/install/index.html>`_.
We recommend installing MTUQ under Anaconda or Miniconda, which, if not already present, can be obtained following `these instructions <https://conda.io/projects/conda/en/latest/user-guide/install/index.html>`_.


To install MTUQ, first create a conda virtual environment:
To install MTUQ, create a conda virtual environment:

.. code::
conda config --prepend channels conda-forge
conda create -n mtuq python=3
Expand Down Expand Up @@ -49,6 +48,6 @@ Finally, install PyGMT:

**Troubleshooting**

For a discussion of common issues, please see our `troubleshooting page <https://uafgeotools.github.io/mtuq/install/issues.html>`_.
For troubleshooting common installation issues, please `see here <https://uafgeotools.github.io/mtuq/install/issues.html>`_.


12 changes: 9 additions & 3 deletions docs/install/issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,23 @@
Installation on Apple M1 and Apple M2 Macs
------------------------------------------

A modified installation procedure may be necessary on Apple M1 and Apple M2 Macs.
Newer Mac computers use proprietary Apple processors based on the ARM64 architecture. On these and other ARM64 systems, a modified `conda env` command is necessary

.. code::
conda env update --file env_arm64.yaml
but otherwise users can follow the normal installation procedure.

For more information, please see:

`MTUQ installation on Apple M1 and Apple M2 Macs <https://uafgeotools.github.io/mtuq/install/arm64.html>`_
`MTUQ installation on ARM64 systems <https://uafgeotools.github.io/mtuq/install/arm64.html>`_


Installation under virutalenv
-----------------------------

For most users, we recommend installing MTUQ under conda. In rare cases, however, it seems that MTUQ can be more easily installed under virtualenv.
For most users, we recommend installing MTUQ under conda. However, in rare cases it seems that MTUQ can be more easily installed under virtualenv.

For more information, please see:

Expand Down

0 comments on commit 27322a3

Please sign in to comment.