Commit d48cdf05 authored by Edward Fauchon-Jones's avatar Edward Fauchon-Jones

Fix list indents GitLab requires 4 for paragraphs

parent 5e1cb51c
......@@ -4,27 +4,27 @@
## Installation
1. **Install the package locally**
1. **Install the package locally**
The package can be installed directly from
[git.ligo.org](https://git.ligo.org/) using the following snippet. Use your
LIGO username `albert.einstein` and password when asked for
authorisation
The package can be installed directly from
[git.ligo.org](https://git.ligo.org/) using the following snippet. Use your
LIGO username `albert.einstein` and password when asked for
authorisation
```bash
$ pip install git+https://git.ligo.org/edward.fauchon-jones/lvcnrpy.git#egg=lvcnrpy
```
```bash
$ pip install git+https://git.ligo.org/edward.fauchon-jones/lvcnrpy.git#egg=lvcnrpy
```
2. **Define LVC-NR Waveform Repository environment variable**
2. **Define LVC-NR Waveform Repository environment variable**
Define the environment variable `LVCNR_DATADIR` as the path to your local
clone of the LVC-NR Waveform Repository. If you are using a virtual
environment this can be defined in your activation script. For a bash shell
this could be done with
Define the environment variable `LVCNR_DATADIR` as the path to your local
clone of the LVC-NR Waveform Repository. If you are using a virtual
environment this can be defined in your activation script. For a bash shell
this could be done with
```bash
export LVCNR_DATADIR=<path-to-lvc-nr-repo>
```
```bash
export LVCNR_DATADIR=<path-to-lvc-nr-repo>
```
## Usage
......@@ -37,44 +37,44 @@ To check a HDF5 NR file against one of the format levels use the included
program `lvcnrcheck`. It is installed as a global program when this package is
installed.
- **`lvcnrcheck` usage**
- **`lvcnrcheck` usage**
```bash
lvcnrcheck [-h] [-c] [-f {1,2,3}] file
```bash
lvcnrcheck [-h] [-c] [-f {1,2,3}] file
Check hdf5 NR data meet LVCNR format specifications
Check hdf5 NR data meet LVCNR format specifications
positional arguments:
file name of file to check
positional arguments:
file name of file to check
optional arguments:
-h, --help show this help message and exit
-c, --col use coloured output (default: False)
-f {1,2,3}, --format {1,2,3}
format level to use (default: 1)
```
optional arguments:
-h, --help show this help message and exit
-c, --col use coloured output (default: False)
-f {1,2,3}, --format {1,2,3}
format level to use (default: 1)
```
- **`lvcnrcheck` example**
- **`lvcnrcheck` example**
For basic usage simple pass the file name to `lvcnrcheck`
For basic usage simple pass the file name to `lvcnrcheck`
```bash
$ cd <path-to-lvc-nr-repo>
$ lvcnrcheck ./Cardiff-UIB/h5/q1.2_base_96.h5
```
```bash
$ cd <path-to-lvc-nr-repo>
$ lvcnrcheck ./Cardiff-UIB/h5/q1.2_base_96.h5
```
To check against a specific format level use the `-f` option
To check against a specific format level use the `-f` option
```bash
$ cd <path-to-lvc-nr-repo>
$ lvcnrcheck -f 2 ./Cardiff-UIB/h5/q1.2_base_96.h5
```
```bash
$ cd <path-to-lvc-nr-repo>
$ lvcnrcheck -f 2 ./Cardiff-UIB/h5/q1.2_base_96.h5
```
To add a coloured output use the `-c` flag
To add a coloured output use the `-c` flag
To check against a specific format level use the `-f` option
To check against a specific format level use the `-f` option
```bash
$ cd <path-to-lvc-nr-repo>
$ lvcnrcheck -c ./Cardiff-UIB/h5/q1.2_base_96.h5
```
```bash
$ cd <path-to-lvc-nr-repo>
$ lvcnrcheck -c ./Cardiff-UIB/h5/q1.2_base_96.h5
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment