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 update to documentation formatting #320

Merged
Changes from all commits
Commits
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
37 changes: 16 additions & 21 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,31 +193,26 @@ requirements.txt file which are necessary for NMMA:

There is an issue pip installing ``pyfftw`` on arm64 Mac systems; see the dedicated section below for a solution. If any package appeared to have an issue installing, you can first check by attempting to install it again using pip:

``$ pip install importlib_resources``

``$ pip install extinction``

``$ pip install dill``

``$ pip install multiprocess``

``$ pip install lalsuite``

``$ pip install python-ligo-lw``

``$ pip install sncosmo``

``$ pip install scikit-learn``

``$ pip install joblib``

``$ conda install -c conda-forge p-tqdm``
.. code::

pip install importlib_resources
pip install extinction
pip install dill
pip install multiprocess
pip install lalsuite
pip install python-ligo-lw
pip install sncosmo
pip install scikit-learn
pip install joblib
conda install -c conda-forge p-tqdm

.. note::

If everything has gone smoothly, all of these above mentioned "pip install something" commands will show that the requirements have already been satisfied. Otherwise, these will cover the dependencies if not covered by ``pip install .``. Also, if running ``pip install .`` shows something on the lines of "cannot cythonize without cython", do:

``conda install -c anaconda cython==0.29.24`` and redo ``pip install .``.
.. code::
conda install -c anaconda cython==0.29.24
pip install

.. _arm64mac:

Expand Down Expand Up @@ -355,7 +350,7 @@ If you want to install a custom lalsuite version (e.g. with a certain GW templat

.. code::

conda create -c conda-forge --prefix=YOUR_PREFIX python=3.8
conda create -c conda-forge --prefix=YOUR_PREFIX python=3.9
conda activate YOUR_PREFIX

and then installing mpi4py first before installing the required packages for the build process (here the second line):
Expand Down
Loading