Skip to content

Commit

Permalink
Merge pull request #6 from Argonne-National-Laboratory/mac_compile
Browse files Browse the repository at this point in the history
Added mac installation instructions
  • Loading branch information
reverendbedford authored Jan 20, 2021
2 parents a7e3502 + 9fa8cc4 commit f48da01
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
2 changes: 1 addition & 1 deletion doc/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = 'Argonne National Laboratory'

# The full version, including alpha/beta/rc tags
release = '1.0.2'
release = '1.0.3'


# -- General configuration ---------------------------------------------------
Expand Down
21 changes: 17 additions & 4 deletions doc/sphinx/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,27 @@ Install using the pip package manager

The easiest way to install the package is to use the `pip` package manager, installing srlife from pypi automatically. However, the neml source package requires compiling the module from source, which still has a few system-level dependencies.

Ubuntu Linux
""""""""""""
Ubuntu Linux 18.04
""""""""""""""""""

.. code-block:: console
sudo apt install build-essential cmake libblas-dev liblapack-dev python3-dev python3-setuptools python3-pip python3-wheel
pip3 install --user srlife
MacOS Sierra 10.14 Mojave
"""""""""""""""""""""""""

Go to `brew.sh <https://brew.sh/>`_ and follow the directions to install homebrew.

Open up a terminal and run:

.. code-block:: console
brew install cmake openblas superlu python vtk
pip3 install --user srlife
`srlife` will then be available as a package through the homebrew version of python (often available as `python3` instead of `python`).

Install from the github repository directly
-------------------------------------------
Expand All @@ -31,8 +44,8 @@ to also obtain the tutorial, example, and test files you can install the
package directly from `github <https://github.com/Argonne-National-Laboratory/srlife>`_. In addition to the, cmake, BLAS, and LAPACK requirements you will
need git and, optionally, the nose package to automatically run the tests.

Ubuntu Linux
""""""""""""
Ubuntu Linux 18.04
""""""""""""""""""

The following installs the prerequisites, downloads srlife, sets up the python package, and runs the automated test suite.

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# Name of the project
name = 'srlife',
# Version
version = '1.0.2',
version = '1.0.3',
# One line-description
description = "Evaluate the structural life of a solar receiver",
# README
Expand Down Expand Up @@ -49,7 +49,7 @@
'numpy==1.18',
'scipy',
'h5py',
'vtk',
'vtk ; platform_system!="Darwin"',
'nose',
'matplotlib',
'pylint',
Expand Down

0 comments on commit f48da01

Please sign in to comment.