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.

Sign up for GitHub

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 fix for the JOSS Review #58

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Minor fix for the JOSS Review #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62ff729
Fix read me
Nov 6, 2024
639a8d7
Fix install.html, removing superfluos package
Nov 6, 2024
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ If you already have NGSolve (with MPI support) and PETSc installed, you can inst
cd ngsPETSc
pip install .
```
Alternatively, you can also build PETSc, SLEPc, and NGSolve from source following the instructions in the [documentation](https://ngspetsc.readthedocs.io/en/latest/installation.html).
Alternatively, you can also build PETSc, SLEPc, and NGSolve from source following the instructions in the [documentation](https://ngspetsc.readthedocs.io/en/latest/install.html).

## Getting started

To get started with ngsPETSc, check out the [documentation](https://ngspetsc.readthedocs.io/en/latest/).
To test the installation, you can run the tests in the `tests` folder, via the Makefile in the root directory of the repository:
```bash
make test
```
```
14 changes: 7 additions & 7 deletions docs/src/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ We now install PETSc from scratch in a suitable folder, with OpenMPI, HYPRE, Met
::
git clone https://gitlab.com/petsc/petsc.git
cd petsc
python configure --download-chaco \
--download-cmake \
--download-eigen \
python configure --download-cmake \
--download-openmpi \
--download-hypre \
--download-metis \
Expand All @@ -28,13 +26,13 @@ We now install PETSc from scratch in a suitable folder, with OpenMPI, HYPRE, Met
--download-mumps \
--download-scalapack \
--download-superlu_dist \
--download-fblaslapack=1 \
--with-c2html=0 \
--with-cxx-dialect=C++11 \
--with-debugging=0 \
--download-fblaslapack=1 \
--with-fortran-bindings=0 \
--with-shared-libraries=1 \
--with-petsc4py=1 \
--with-petsc4py=1

To build PETSc you need to run the Makefile as suggested at the end of the configuration script.
We now need to set in the ``.bashrc`` (on OSX in ``.bash_profile``) file the ``PETSC_DIR``, ``PETSC_ARCH`` system variables as they appear when we finish build PETSc.
You also need to add to your ``PYTHONPATH`` the ``PYTHONPATH`` that appears when we finished building PETSc.
Expand Down Expand Up @@ -71,9 +69,11 @@ Now we build NGSolve from source.
cmake -DCMAKE_INSTALL_PREFIX=${BASEDIR}/ngsolve-install ${BASEDIR}/ngsolve-src -DUSE_MPI=ON
make
make install

You should add to your ``.bashrc`` the ``BASEDIR`` system variable:
::
echo "export $BASEDIR=${BASEDIR}" >> ~/.bashrc
echo "export $BASEDIR=${BASEDIR}" >> ~/.bashrc

We suggest you add the following lines to your ``.bashrc``:
::
export NETGENDIR="${BASEDIR}/ngsolve-install/bin"
Expand Down