Skip to content

Some grammar correction on the readme and a double quote in the main script #1

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

Open
Iximiel wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Some grammar correction on the readme and a double quote in the main script #1

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
a8f4087
grammar fix
Iximiel Dec 16, 2024
d9d8268
disables few shellcheck intentional warnings
Iximiel Dec 16, 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
34 changes: 17 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ An action to install plumed in your workflow.
![Test](https://github.com/Iximiel/install-plumed/actions/workflows/test.yaml/badge.svg?branch=main&event=push)
</div>

*Iximiel/install-plumed* installs plumed in your workflow in a standardize fashion.
*Iximiel/install-plumed* installs plumed in your workflow in a standardized fashion.

This action synergise with using [ccache](https://ccache.dev/) and [actions/cache](https://github.com/actions/cache).
This action synergize with using [ccache](https://ccache.dev/) and [actions/cache](https://github.com/actions/cache).

An example of calling this action in your workflow is:

Expand Down Expand Up @@ -41,18 +41,18 @@ This action outputs two parameters:
- **plumed_prefix** the path where plumed has installed into
- **dependency_file** the full path of the dependency file created if `dependency_path` is specified (see [below](#dependency_path)).

In the previous example you can access to them within the job with: `${{ steps.plumed.outputs.plumed_prefix }}` and `${{ steps.plumed.outputs.dependency_file }}`
In the previous example you can access to them within the job with: `${{ steps.plumed.outputs.plumed_prefix }}` and `${{ steps.plumed.outputs.dependency_file }}`
## Options

You are not required to use any option, with everithing set to default plumed will be configured with:
You are not required to use any option, with everything set to default plumed will be configured with:

```bash
CC="gcc" CXX="g++" ./configure --enable-boost_serialization --enable-fftw --enable-libtorch --disable-basic-warnings --prefix=~/opt --enable-modules=all LDFLAGS=-Wl,-rpath,${LD_LIBRARY_PATH}
```

Plumed will be cloned from `https://github.com/plumed/plumed2.git` and the script will automatically install the latest stable version.

And by default the intenral module dependencies will not be compiled.
And by default the internal module dependencies will not be compiled.

- Options
- [repository](#repository)
Expand Down Expand Up @@ -108,13 +108,13 @@ This options will change the `--suffix=""` option in the configuration phase. Us
#### prefix
*default*: `'~/opt'`

This option will set up the installation prefixThe installation prefix
This option will set up the installation prefix.

#### extra_options
*default*: `'--enable-boost_serialization --enable-fftw --enable-libtorch --disable-basic-warnings'`

Extra options for installing plumed.
The options will override the default ones, so if you want to add a extra option you will need to specify the whole string
The options will override the default ones, so if you want to add an extra option you will need to specify the whole string
```yaml
- name: Install plumed master
uses: Iximiel/install-plumed@v1
Expand All @@ -128,8 +128,8 @@ Fora a complete installation with no parallelism.
#### modules
*default*: `'all'`

A `:` separated list of modules to install, or , will change the `--enable-modules=""` in the configure phase.
Or alternatively you can use the special keyworks `all`, `none` and `reset`.
A `:` separated list of modules to install, or, will change the `--enable-modules=""` in the configure phase.
Or alternatively you can use the special keywords `all`, `none` and `reset`.

```yaml
- name: Install plumed master
Expand All @@ -138,7 +138,7 @@ Or alternatively you can use the special keyworks `all`, `none` and `reset`.
version: 'master'
modules: 'reset'
```
Since the action is set up to default install everithing, using `reset` will make possible installing only the default modules
Since the action is set up to default install everything, using `reset` will make possible installing only the default modules

#### CC
*default*: `'gcc'`
Expand Down Expand Up @@ -166,12 +166,12 @@ CC=compiler_chosen CXX=compiler_chosen++ ./configure **options**
CC: 'ccache mpicc'
CXX: 'ccache mpic++'
```
Here plumed will be be installed using mpi and by prepending ccache you will use ccache to store some compilation artifact and speed up [new workflows](#caching-stratiegies)
Here plumed will be installed using mpi and by prepending ccache you will use ccache to store some compilation artifact and speed up [new workflows](#caching-stratiegies)

#### dependency_path
*default*: `''`

If specified a file `extradeps$version.json` will be create in the specified path with the internal module dependencies.
If specified a file `extradeps$version.json` will be created in the specified path with the internal module dependencies.

If the variable is present, the step will also produce an output with the full path of that file.

Expand All @@ -186,15 +186,15 @@ If the variable is present, the step will also produce an output with the full p
```
In this case the module will be in your GH workspace

## Caching stratiegies
There are two caching strategies avaiable with this action
## Caching strategies
There are two caching strategies available with this action

- **[ccache](https://ccache.dev/) and [actions/cache](https://github.com/actions/cache)** by storing the `~/.ccache` directory
- **[actions/cache](https://github.com/actions/cache)** by storing the installation directory

### ccache and actions/cache

Using ccache will store the compilation artifacs and speed up new runs
Using ccache will store the compilation artifacts and speed up new runs

```yaml
name: Test
Expand Down Expand Up @@ -318,7 +318,7 @@ jobs:
plumed info --version
```

*Iximiel/install-plumed* after compiling plumed will store an extra file that will contain the hash of the commit used to compile plumed in the installation directory (`${prefix}/plumed${suffix}/${hash}`), if *Iximiel/install-plumed* finds that file during the set up, it will assume that that version of plumed is already present and will completely skip the compilation.
*Iximiel/install-plumed* after compiling plumed will store an extra file that contains the hash of the commit used to compile plumed in the installation directory (`${prefix}/plumed${suffix}/${hash}`), if *Iximiel/install-plumed* finds that file during the setup, it will assume that that version of plumed is already present and will completely skip the compilation.

The default installation path is `~/opt`, so

Expand All @@ -331,7 +331,7 @@ The default installation path is `~/opt`, so
```
will do the trick for you.

You can also combine the two approaches, expecially if you use the [`version`](#version) keyword to checkout to a branch instead of a tag.
You can also combine the two approaches, especially if you use the [`version`](#version) keyword to check out to a branch instead of a tag.
```yaml
- uses: actions/cache@v4
with:
Expand Down
8 changes: 5 additions & 3 deletions install-plumed.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#! /bin/bash

# To me: the enviromental variable I am using as input are in CAPS,
# if I modify a variable is in lower case
# if I want to modify a variable I copy it in a lower case one

cd "$(mktemp -dt plumed.XXXXXX)" || {
echo "Failed to create tempdir"
Expand All @@ -19,6 +19,7 @@ else
exit 1
fi

#shellcheck disable=SC2153
version=$VERSION

if [[ -n "$version" ]]; then
Expand Down Expand Up @@ -53,7 +54,7 @@ fi
git checkout --quiet "$version"

if [[ -n $DEPPATH ]]; then
mypath=$(realpath $DEPPATH)
mypath=$(realpath "$DEPPATH")
mkdir -pv "$mypath"
dependencies_file="${mypath}/extradeps${version}.json"
echo "Creating a dependencies file at $dependencies_file"
Expand Down Expand Up @@ -99,13 +100,14 @@ else
rm -fr "${prefix:?}/lib/$program_name"
rm -fr "${prefix:?}/bin/$program_name"
rm -fr "${prefix:?}/include/$program_name"
rm -fr "${prefix:?}"/lib/lib$program_name.so*
rm -fr "${prefix:?}"/lib/lib"$program_name".so*
#{var:?} makes the shell fail to avoid unwanted "explosive" deletions in /lib and /bin

#${LD_LIBRARY_PATH+,${LD_LIBRARY_PATH}} wil print "," then the content of LD_LIBRARY_PATH, if it is not empty
set -e
(
set -x
#shellcheck disable=SC2086
./configure $plumed_options ${LD_LIBRARY_PATH+LDFLAGS=-Wl,-rpath,\"${LD_LIBRARY_PATH}\"}
)

Expand Down
Loading