Skip to content

Commit 197b24d

Browse files
authored
Update README.md
Readme updates
1 parent c681b3d commit 197b24d

1 file changed

Lines changed: 15 additions & 24 deletions

File tree

README.md

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ The two external dependancies not included are:
1717
[gnuplot](http://www.gnuplot.info/download.html), gnuplot is required to run the executable and should be installed and the gnuplot executable available in the system path.
1818

1919
And [HDF5](https://support.hdfgroup.org/ftp/HDF5/current/src/), this should be installed and the HDF5_ROOT environment variable defined.
20-
2120
### HDF5
2221
#### Windows
2322
HDF5 can be installed for windows 10 64bit windows using a precompiled installer available [here](https://support.hdfgroup.org/ftp/HDF5/releases/hdf5-1.12/hdf5-1.12.1/bin/windows/hdf5-1.12.1-Std-win10_64-vs14.zip)
@@ -27,19 +26,16 @@ Or by compiling it using the [source code](https://www.hdfgroup.org/downloads/hd
2726
The HDF5_ROOT should then be set to the installation directory eg.:`C:\Program Files (x86)\HDF_Group\HDF5\1.12.1`
2827

2928
** Note: The architecture of your compiler should match the installation of HDF5.
30-
3129
#### Linux
3230
HDF5 can be install on linux through APT:
3331
```
34-
sudo apt=get install libhdf5-dev
32+
sudo apt-get install libhdf5-dev
3533
```
36-
3734
#### Mac OS
3835
HDF5 can be installed on mac using homebrew:
3936
```
4037
brew install hdf5
4138
```
42-
4339
### gnuplot
4440
gnuplot can be installed using the following commands:
4541

@@ -48,27 +44,22 @@ gnuplot can be installed on windows using chocolatey:
4844
```
4945
choco install gnuplot
5046
```
51-
5247
#### Linux
5348
gnuplot can be installed on linux using apt:
5449
```
5550
sudo apt-get install gnuplot
5651
```
57-
5852
#### Mac OS
5953
gnuplot can be installed on mac using homebrew:
6054
```
6155
brew install gnuplot
6256
```
63-
6457
## Compiling
6558
Compile the executable by running:
66-
6759
```
6860
$ cmake -Bbuild
6961
$ cmake --build build
7062
```
71-
7263
**Important** For multi-config compilers such as Visual Studio xcode or ninja the config type needs to be set to `Release` otherwise the API will not build for example:
7364
```
7465
$ cmake -Bbuild
@@ -77,35 +68,35 @@ $ cmake --build build --config=Release
7768

7869
## Usage
7970
The executable is located in the `build/bin[/release]` directory
80-
8171
The executable is designed to be run independently using the `--local` flag and taking one parameter:
82-
83-
## on Unix
72+
### on Unix
8473
```
8574
build/bin/cppSimpleModel --local data/static_params_SEIRS.csv
8675
```
87-
## or on windows:
76+
### or on windows:
8877
```
8978
build/bin/release/cppSimpleModel.exe --local data\static_params_SEIRS.csv"
9079
```
9180

92-
Or conjuction with the [fair cli](#Fair CLI) like so:
93-
(From a fair cli poetry shell within the repo)
94-
## Unix
81+
### or conjuction with the [fair cli](#Fair-CLI):
82+
83+
(From a virtual environment within the repo directory)
84+
85+
#### Fair CLI
86+
The [FAIR commandline interface]("https://github.com/FAIRDataPipeline/FAIR-CLI") is available to install using pip:
87+
```
88+
pip install fair-cli
89+
```
90+
Once installed the model can be run using the following:
91+
### Unix
9592
```
9693
fair init --ci
9794
fair pull data/seirs_config.yaml
9895
fair run data/seirs_config.yaml
9996
```
100-
## Windows
97+
### Windows
10198
```
10299
fair init --ci
103100
fair pull data/seirs_config_windows.yaml
104101
fair run data/seirs_config_windows.yaml
105102
```
106-
107-
## Fair CLI
108-
The [FAIR commandline interface]("https://github.com/FAIRDataPipeline/FAIR-CLI") is available to install using pip:
109-
```
110-
pip install fair-cli
111-
```

0 commit comments

Comments
 (0)