Skip to content

Commit

Permalink
Documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
montyvesselinov committed Feb 22, 2017
1 parent 84cbe0b commit 5656779
Showing 1 changed file with 57 additions and 20 deletions.
77 changes: 57 additions & 20 deletions README.md
@@ -1,23 +1,30 @@
Anasol (Analytical solutions for groundwater contaminant transport)
Anasol
=======================================

[![Anasol](http://pkg.julialang.org/badges/Anasol_0.4.svg)](http://pkg.julialang.org/?pkg=Anasol&ver=0.4)

[![Build Status](https://travis-ci.org/madsjulia/Anasol.jl.svg?branch=master)](https://travis-ci.org/madsjulia/Anasol.jl)

[![Coverage Status](https://coveralls.io/repos/madsjulia/Anasol.jl/badge.svg?branch=master)](https://coveralls.io/r/madsjulia/Anasol.jl?branch=master)

Anasol is a module of MADS. MADS (Model Analysis & Decision Support) is an open-source [Julia](http://julialang.org) code designed as an integrated high-performance computational framework performing a wide range of model-based analyses:
(Analytical solutions for groundwater contaminant transport.
Anasol is a module of [MADS](http://madsjulia.github.io/Mads.jl).

MADS
====

[MADS](http://madsjulia.github.io/Mads.jl) (Model Analysis & Decision Support) is an integrated open-source high-performance computational (HPC) framework in [Julia](http://julialang.org).
MADS can execute a wide range of data- and model-based analyses:

* Sensitivity Analysis
* Parameter Estimation
* Model Inversion and Calibration
* Uncertainty Quantification
* Model Selection and Averaging
* Decision Support
* Model Selection and Model Averaging
* Model Reduction and Surrogate Modeling
* Machine Learning and Blind Source Separation
* Decision Analysis and Support

MADS utilizes adaptive rules and techniques which allows the analyses to be performed with minimum user input.
The code provides a series of alternative algorithms to perform each type of model analyses.
MADS has been tested to perform HPC simulations on a wide-range multi-processor clusters and parallel enviromentls (Moab, Slurm, etc.).
MADS utilizes adaptive rules and techniques which allows the analyses to be performed with a minimum user input.
The code provides a series of alternative algorithms to execute each type of data- and model-based analyses.

Documentation
=============
Expand All @@ -27,45 +34,75 @@ All the available MADS modules and functions are described at [madsjulia.github.
Installation
============

After starting Julia, execute:

```
Pkg.add("Anasol")
```julia
Pkg.add("Mads")
```

Installation behind a firewall
------------------------------

Julia uses git for package management. Add in the `.gitconfig` file in your home directory:
Julia uses git for the package management.
To install Julia packages behind a firewall, add the following lines in the `.gitconfig` file in your home directory:

```
```git
[url "https://"]
insteadOf = git://
```

or execute:

```
```bash
git config --global url."https://".insteadOf git://
```

Set proxies:

```
```bash
export ftp_proxy=http://proxyout.<your_site>:8080
export rsync_proxy=http://proxyout.<your_site>:8080
export http_proxy=http://proxyout.<your_site>:8080
export https_proxy=http://proxyout.<your_site>:8080
export no_proxy=.<your_site>
```

For example, if you are doing this at LANL, you will need to execute the
For example, if you are doing this at LANL, you will need to execute the
following lines in your bash command-line environment:

```
```bash
export ftp_proxy=http://proxyout.lanl.gov:8080
export rsync_proxy=http://proxyout.lanl.gov:8080
export http_proxy=http://proxyout.lanl.gov:8080
export https_proxy=http://proxyout.lanl.gov:8080
export no_proxy=.lanl.gov
```
```

MADS examples
=============

In Julia REPL, do the following commands:

```julia
import Mads
```

To explore getting-started instructions, execute:

```julia
Mads.help()
```

There are various examples located in the `examples` directory of the `Mads` repository.

For example, execute

```julia
include(Mads.madsdir * "/../examples/contamination/contamination.jl")
```

to perform various example analyses related to groundwater contaminant transport, or execute

```julia
include(Mads.madsdir * "/../examples/bigdt/bigdt.jl")
```

to perform Bayesian Information Gap Decision Theory (BIG-DT) analysis.

0 comments on commit 5656779

Please sign in to comment.