Merge pull request #36 from el7addad/master

Updating Readme for version 1.1.0

README.md

@@ -40,7 +40,9 @@ In this framework for regional simulation, the JSON format is adopted for all th
 
   * **LLNL-SW4**: This application will read the building location from the BIM model and will output ground motion for simulating building response. The application uses a set of pre-computed ground motions for SF Bay Area earthquake event (Magnitude 7.0 earthquake at the Hayward fault) simulated using [SW4](https://geodynamics.org/cig/software/sw4/).
 
-  * **SHA-GM** [Experimental]: This application combines seismic hazard analysis (SHA) and ground motion record selection/scaling to provide ground motions for structural analysis based on a user-defined earthquake scenarios.
+  * **SHA-GM.py** [Experimental]: This application combines seismic hazard analysis (SHA) and ground motion record selection/scaling to provide ground motions for structural analysis based on a user-defined earthquake scenarios.
+
+* **NNGM.py** : This application assumes a set of recorded ground motion is provided and uses nearest-neighbor search to set the hazard input for each building using the nearest recorded ground motion.
 
 * **createSAM**:  This directory contains applications to create structural analysis model (SAM) given BIM and Event data
 
@@ -75,9 +77,7 @@ Other directories included in this repository are:
 
 ## Dependencies
 
-* **Jansson Library**: Many of the provided applications require the [Jansson library](http://www.digip.org/jansson/) to be installed. Jansson is a free native C library for encoding, decoding and manipulating JSON data. It is licensed under the MIT license. For Unix systems, it is assumed to be installed in /usr/local/jansson as seen in the included Makefiles.
-
-* **C++11 compliant compiler**: Some applications in the createLOSS and performUQ folders use C++11 features, consequently they may need a newer C++11 compliant compiler.
+* **C++11 compliant compiler**: many of the workflow applications included use C++11 features, consequently they may need a newer C++11 compliant compiler.
 
 * **OpenSees**: The workflow applications require an installation of [OpenSees](http://opensees.berkeley.edu/) to carry out structural analysis using the finite element method.
 
@@ -87,20 +87,35 @@ Other directories included in this repository are:
 
 * **Perl**: The workflow makes use of a modified version of the `DPrePro` preprocessor Perl script distributed with DAKOTA, and thus requires Perl. Later releases may switch to the newer python version of the script as the Perl script is deprecated as of DAKOTA 6.8.
 
-*	**nanoflann**: A C++11 library that performs nearest neighbor search using k-dimensional trees. nanoflann is a header-only library and is included with the source of the workflow. It is currently being used by LLNL_SW4 createEVENT application.
-
-* **Simcenter-EQSS**: the ground motion tools developed at the SimCenter are needed, if using SHA-GM.py as a createEVENT application. To obtain and build these applications please refer to [SimCenter-EQSS](https://github.com/el7addad/Simcenter-EQSS) repository for documentation.
+* **Conan package manager**: This repository uses [Conan](https://conan.io/) for dependency management. Conan is a python library and can be installed using the following [instructions](https://docs.conan.io/en/latest/installation.html)
 
 ## Building the source code on Unix-like systems
 
 Before building the workflow, the following dependencies will need to be installed:
 
 1. [GNU Compiler Collection](https://gcc.gnu.org/) (gcc & g++ ) version 4.8.1 or newer.
 2. [GNU Make](https://www.gnu.org/software/make/).
-3. [Jansson Library](http://www.digip.org/jansson/).
+3. [CMake](https://cmake.org/)
+
+This repository uses CMake for the build process. The general instructions for building the workflow application is as follows:
+
+1. Install the dependencies using Conan
+
+```shell
+conan install ..
+```
+
+2. Use CMake to generate the make files
+```shell
+cmake ..
+```
+
+3. Build the applications using the generated make files
+
+```shell
+make
+```
 
-The repository uses Makefiles to build the applications.
-To build all the workflow applications, use ```make``` or ```make all``` in the root directory. To build for debugging use ```make debug```  and to clean, use ```make clean```.
 
 ## Building the source code on Ubuntu Linux
 
@@ -111,12 +126,25 @@ sudo apt-get update
 sudo apt-get install gcc g++ python perl
 ```
 
-After installing the dependencies, building the workflow applications can then be done similar to other unix systems, using `make all`. Running the workflow applications will require installing other dependencies like OpenSees and DAKOTA. Instructions to building these software applications from their source code on Ubuntu Linux are available on their respective websites.
+After installing the dependencies, building the workflow applications can then be done similar to other unix systems, using the instructions above for unix systems. Running the workflow applications will require installing other dependencies like OpenSees and DAKOTA. Instructions to building these software applications from their source code on Ubuntu Linux are available on their respective websites.
 
 ## Building the source code on Windows
 
 Visual studio projects is under development. Currently the workflow can be built and run in Windows using the Windows subsystem for Linux and building using the same commands for Linux systems.
 
+1. Install the dependencies using Conan
+
+```shell
+conan install ..
+```
+
+2. Use CMake to generate the make files
+```shell
+cmake ..
+```
+
+3. Open the generated Visual Studio project (Project.sln) and build all the workflow applications.
+
 ## Data
 
 Some data files required to run the workflow are not included in this repository, and are distributed using the [SimCenter Box account](https://berkeley.box.com/s/7es601ve766fprph88n67khfip7fqupd). If you cannot access the data, please contact the SimCenter using [Slack](https://designsafe-ci.slack.com/messages/C92HT3GG4) or by [email]([email protected]).