From 6939c93d059e6ad4723217e8e5fce55e7ad2fb1b Mon Sep 17 00:00:00 2001
From: Americo Cunha <36556019+americocunhajr@users.noreply.github.com>
Date: Wed, 17 Jul 2024 16:16:49 -0300
Subject: [PATCH] Update README.md
---
README.md | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index d4a8fbe..eda8ee9 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,36 @@
-
+## Sobol' Indices for Biological Systems
**SoBioS: Sobol' Indices for Biological Systems** is an easy-to-use Matlab code designed for Sobol' indices-based global sensitivity analysis of biological systems. Developed with an educational approach, **SoBioS** is intuitive and user-friendly, making it an excellent tool for researchers and students in the field of systems biology.
-## Table of Contents
+### Table of Contents
- [Overview](#overview)
- [Features](#features)
-- [UQLab Dependency](#uqlab-dependency)
+- [UQLab dependency](#uqlab-dependency)
- [Usage](#usage)
- [Documentation](#documentation)
- [Authors](#authors)
- [Citing SoBioS](#citing-sobios)
- [License](#license)
-- [Institutional Support](#institutional-support)
+- [Institutional support](#institutional-support)
- [Funding](#funding)
-## Overview
+### Overview
**SoBioS** was developed as a pedagogical tool to teach the basics of global sensitivity analysis of biological systems via Sobol' indices. A tutorial explaining the theory and practical aspects behind the **SoBioS** package is provided in the following book chapter:
-- **M. Tosin, A.M.A. Côrtes, A. Cunha Jr**, *A Tutorial on Sobol’ Global Sensitivity Analysis Applied to Biological Models*, in Networks in Systems Biology: Applications for Disease Modeling, Computational Biology, vol. 32, Springer, Cham, 2020. [DOI](https://doi.org/10.1007/978-3-030-51862-2_6)
+- **M. Tosin, A.M.A. Côrtes, A. Cunha Jr**, *A Tutorial on Sobol’ Global Sensitivity Analysis Applied to Biological Models*, in Networks in Systems Biology: Applications for Disease Modeling, Computational Biology, vol. 32, Springer, Cham, 2020. DOI.
-## Features
+### Features
- Global sensitivity analysis using Sobol' indices
- Easy-to-run Matlab implementation
- Educational style code for easy understanding
- Includes example cases and detailed comments
-## UQLab dependency
+### UQLab dependency
In order to use the **SoBioS** code, it is necessary to have UQLab package installed:
-https://www.uqlab.com
+https://www.uqlab.com.
This external package is free for academic use.
-## Usage
+### Usage
This package includes the following modules:
- SoBioS_CaseName.m - main file for the simulation (use servaral resourses from UQLab package);
- QoI_CaseName.m - function to compute the Quantity of Interest (QoI).
@@ -48,15 +48,15 @@ To get started with **SoBioS**, follow these steps:
```bash
SoBioS_CaseName
```
-## Documentation
+### Documentation
The routines in SoBioS are well-commented to explain their functionality. Each routine includes a description of its purpose, as well as inputs and outputs. Detailed documentation can be found within the code comments and the provided tutorial.
-## Authors
+### Authors
- Michel Tosin
- Adriano Côrtes
- Americo Cunha
-## Citing SoBioS
+### Citing SoBioS
If you use **SoBioS** in your research, please cite the following publication:
- *Tosin M., Côrtes A.M.A., Cunha A. (2020) A Tutorial on Sobol’ Global Sensitivity Analysis Applied to Biological Models. In: da Silva F.A.B., Carels N., Trindade dos Santos M., Lopes F.J.P. (eds) Networks in Systems Biology: Applications for Disease Modeling. Computational Biology, vol 32. Springer, Cham https://doi.org/10.1007/978-3-030-51862-2_6*
@@ -74,16 +74,16 @@ If you use **SoBioS** in your research, please cite the following publication:
}
```
-## License
+### License
**SoBioS** is released under the MIT license. See the LICENSE file for details. All new contributions must be made under the MIT license.
-## Institutional support
+### Institutional support
-## Funding
+### Funding
