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

Update README.md, format shell commands #79

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update README.md, format shell commands #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 17 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@ Larch can be built utilizing a Singularity container or a Conda environment.

To build Singularity image, use the definition provided:

`singularity build larch-singularity.sif larch-singularity.def`
`singularity shell larch-singularity.sif --net`
```shell
singularity build larch-singularity.sif larch-singularity.def
singularity shell larch-singularity.sif --net
```

To setup a conda environment capable of building Larch, use:

`conda create -n larch`
`conda activate larch`
`conda create -n larch` \
`conda activate larch` \
`conda install --channel "conda-forge" --update-deps --override-channels cmake make cxx-compiler openmpi openmpi-mpicc openmpi-mpicxx boost-cpp automake autoconf libtool yasm ucx zlib`

To setup a conda environment capable of building Larch including development tools, create `larch-dev` using the environment
Expand All @@ -41,11 +43,13 @@ file provided:
Building
--------

`git submodule update --init --recursive`
`mkdir build`
`cd build`
`cmake -DCMAKE_BUILD_TYPE=Debug ..`
`make -j16`
```shell
git submodule update --init --recursive
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Debug ..
make -j16
```

Cmake build options:
- add `-DCMAKE_CXX_CLANG_TIDY="clang-tidy"` to enable clang-tidy.
Expand All @@ -56,8 +60,10 @@ Running

From the build directory:

`ln -s ../data`
`./larch-test`
```shell
ln -s ../data
./larch-test
```

Passing *nocatch* to the tests executable will allow exceptions to escape, which is useful for debugging. A gdb session can be started with `gdb --args build/larch-test nocatch`.

Expand Down