Metadata-Version: 2.1
Name: easyvvuq
Version: 0.3
Summary: Library to facilitate simple Verification, Validation and Uncertainty Quantification of simulation codes
Home-page: http://ccs.chem.ucl.ac.uk
Author: CCS
License: UNKNOWN
Description: <img align="left" width="75" height="75" src="https://github.com/UCL-CCS/EasyVVUQ/blob/dev/docs/_static/circle-logo-75.png" alt="EassyVVUQ icon">
        
        # EasyVVUQ
        
        [![Build Status](https://travis-ci.org/UCL-CCS/EasyVVUQ.svg?branch=master)](https://travis-ci.org/UCL-CCS/EasyVVUQ)
        [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/UCL-CCS/EasyVVUQ.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/UCL-CCS/EasyVVUQ/context:python)
        [![Documentation Status](https://readthedocs.org/projects/easyvvuq/badge/?version=latest)](https://easyvvuq.readthedocs.io/)
        
        The aim of this library is to facilitate verification, validation and 
        uncertainty quantification (VVUQ) for a wide variety of simulations. This library is currently in an **Alpha** "friendly users" phase of development, with only a core number of UQ elements currently implemented.
        
        Development was funded by the EU Horizon 2020 project [VECMA](http://www.vecma.eu/).
        
        ## Requirements
        
        To use the library you will need Python 3.6+.
        
        ## Installation using pip
        
        If you are unsure of the version of python your default `pip` works for type:
        ```
        pip --version
        ```
        
        If the output ends with `(python 2.7)` you should replace `pip` with `pip3` in the following commands.
        
        The following should fully install the library:
        ```
        pip install easyvvuq
        ```
        
        To upgrade the library use:
        
        ```
        pip install easyvvuq --upgrade
        ```
        
        ## Manual installation from repository
        
        Alternatively, you can manually install EasyVVUQ.
        First clone the repository to your computer:
        ```
        git clone https://github.com/UCL-CCS/EasyVVUQ.git
        ```
        
        We are trying to keep dependencies at a minimum but a few are inevitable, to install them use:
        ```
        cd EasyVVUQ/
        
        pip3 install -r requirements.txt
        ```
        
        Then the library can be installed using:
        ```buildoutcfg
        python3 setup.py install
        ```
        
        To complete the tests you need to compile (requires `g++`) the `cannonsim` code:
        ```
        make -C tests/cannonsim/src/ 
        ```
        
        ## Getting Started
        
        Documentation, including a basic tutorial, is avalable [here](https://easyvvuq.readthedocs.io).
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
