Skip to content

Commit

Permalink
doc fixed (#751)
Browse files Browse the repository at this point in the history
* update some docs
  • Loading branch information
mkstoyanov authored Nov 23, 2024
1 parent ff95111 commit 44dd116
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 15 deletions.
30 changes: 21 additions & 9 deletions doxygen/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ CMake uses out-of-source build, clone the repo and build in a subfolder

On a OSX system, users have reported instabilities with the homebrew provided HDF5,
especially on Apple M chips.
ASGarD provides an option to download and install HDF5 automatically
that can work around potential problems.
Also, OpenMP has limited benefits, due to what appears to be kernel scheduling overhead.
The BLAS/LAPACK acceleration needs a flag to enable the most recent mode.
```
Expand All @@ -86,10 +88,26 @@ However, the currently available equations and all tools can be used directly fr
build folder.

It is recommended to use a dedicated `CMAKE_INSTALL_PREFIX` as opposed to common
locations such as `~/.local` or `/opt/`, which will make it easier to uninstall.
locations such as `~/.local/` or `/opt/`, which will make it easier to uninstall.

For specific platform build instructions, [see this wiki page.](https://github.com/project-asgard/asgard/wiki/platforms)

### Python pip install

ASGarD has a pip installer called [ornl-asgard](https://pypi.org/project/ornl-asgard/) to avoid conflicts with existing project name.

Both venv and user-space installs are supported, e.g.,
```
python3 -m pip install onrl-asgard==0.7.0a2 --user
```
The `--user` tag is not needed for a venv install
```
python3 -m pip install onrl-asgard==0.7.0a2
```

The installer is still experimental and the version will be changing often,
check the PyPIP project page and please report potential issues.

### Basic usage

List of all ASGarD flags is given by the executable
Expand All @@ -106,13 +124,7 @@ Setting up the enronment paths can be done with
```
source <CMAKE_INSTALL_PREFIX>/share/asgard/asgard-env.sh
```
The prefix used by the pip-installer is either the root of the venv envitonment
or `.local` subfolder for the user home folder.

For more details, see the [Basic Usage Section.](basic_usage.md)

### (deprecated) ScaLAPACK Integration

The ASGARD\_USE\_SCALAPACK build option adds the "scalapack" solver option to ASGarD. In the implicit timestep method, this option
distributes the matrix solve across multiple processes and nodes and enables larger problems that are too large for a single computer.

This build option is only available when ASGARD\_USE\_MPI=ON. Unfortunately, setting ASGARD\_USE\_SCALAPACK alone is not sufficient
and doesn't change the ASGARD\_USE\_MPI setting.
4 changes: 0 additions & 4 deletions doxygen/plotting.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,3 @@ file high-level meta data to the console:
python3 -m asgard -s outfile.h5
```
The `-s` switch can be replaced with either `-stats` or `-summary`.




4 changes: 2 additions & 2 deletions python/pipinstall/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from skbuild.cmaker import get_cmake_version
from skbuild import setup # This line replaces 'from setuptools import setup'

asg_ver = '0.7.0a2'
asg_ver = '0.7.0a3'

# Add CMake as a build requirement if cmake is not installed or too old
setup_requires = []
Expand All @@ -22,7 +22,7 @@
readme_file = fh.readlines()

long_description = ""
for line in readme_file[3:]:
for line in readme_file[1:]:
if line.rstrip() == "## Contact Us":
break
else:
Expand Down

0 comments on commit 44dd116

Please sign in to comment.