Skip to content

Commit

Permalink
Merge pull request #131 from NWChemEx/doc_madness_clean
Browse files Browse the repository at this point in the history
Doc madness clean
  • Loading branch information
yzhang-23 authored Jan 26, 2024
2 parents d312e39 + aa395f1 commit f3350da
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 22 deletions.
14 changes: 1 addition & 13 deletions docs/source/developer/design/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,19 +52,7 @@ sections are ordered such that they work their way up the software stack.
Dependencies
************

ParallelZone presently has two major dependencies: MADNESS and Cereal.

MADNESS
=======

MADNESS is at the moment a dependency primarily because Tiled Array uses it.
ParallelZone doesn't actually leverage any of the MADNESS features.

.. todo::

The decision to put MADNESS under ParallelZone, as opposed to straight MPI,
should be revisited. If no MADNESS features will be used in ParallelZone it
should be dropped.
ParallelZone presently has one dependency: Cereal.

Cereal
======
Expand Down
12 changes: 5 additions & 7 deletions docs/source/developer/design/compp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,11 @@ discuss the design of the ``CommPP`` class.
Why Do We Need CommPP?
**********************

ParallelZone needs access to MPI. MADNESS exposes MPI, but not in an
object-oriented way (AFAIK it just assumes you're working with types like
``double``, ``int``, etc.). ParallelZone is object-oriented and needs something
to bridge the gap between objects and types recognized by MPI. At a high-level
this leads to serialization, but naive application of serializaiton in an MPI
context can lead to inefficiencies. CommPP should automate the conversion from
objects to MPI data types in the most efficient manner possible.
ParallelZone needs access to MPI. ParallelZone is object-oriented and needs
something to bridge the gap between objects and types recognized by MPI. At a
high-level this leads to serialization, but naive application of serializaiton
in an MPI context can lead to inefficiencies. CommPP should automate the
conversion from objects to MPI data types in the most efficient manner possible.

*********************
Design Considerations
Expand Down
3 changes: 1 addition & 2 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,7 @@ compiler you want to use.
MPI
===

ParallelZone's heaviest dependency is MADNESS which implicitly brings in
:ref:`mpi`. Users must have an MPI distribution installed prior to building
Users must have an MPI distribution installed prior to building
ParallelZone. MPI distributions exist in most major OS-level package managers,
so check your package manager before installing MPI from source.

Expand Down

0 comments on commit f3350da

Please sign in to comment.