Skip to content

Commit

Permalink
Merge pull request #45 from N3PDF/remove_for_pub
Browse files Browse the repository at this point in the history
Remove benchmark files and a bunch of stuff to make the code ready for being public
  • Loading branch information
scarrazza authored Feb 28, 2020
2 parents b429742 + 3cc0bbd commit 410b7b8
Show file tree
Hide file tree
Showing 19 changed files with 64 additions and 2,095 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,50 @@
[![Documentation Status](https://readthedocs.org/projects/vegasflow/badge/?version=latest)](https://vegasflow.readthedocs.io/en/latest/?badge=latest)

# VegasFlow
Monte Carlo integration using TensorFlow

VegasFlow is a Monte Carlo integration library written in Python and based on the [TensorFlow](https://www.tensorflow.org/) framework. It is developed with a focus on speed and efficiency, enabling researchers to perform very expensive calculation as quick and easy as possible.

Some of the key features of VegasFlow are:
- Integrates efficiently high dimensional functions on single (multi-threading) and multi CPU, single and multi GPU, many GPUs or clusters.

- Compatible with Python, C, C++ or Fortran.

- Implementation of different Monte Carlo algorithms.



## Documentation

[https://vegasflow.readthedocs.io/en/latest](https://vegasflow.readthedocs.io/en/latest)


## Installation

The package can be installed with pip:
```
python3 -m pip install vegasflow
```

as well as with `conda`, from the `conda-forge` channel:
```
conda install vegasflow -c conda-forge
```

If you prefer a manual installation just use:
```
pip install vegasflow
```
or if you are planning to extend or develop code just use:
```
python setup.py develop
```

## Examples

Look in `examples` folder.
There are some examples in the `examples/` folder.

## Citation policy

If you use the theta package please cite the following paper and zenodo references:
- Zenodo
- arXiv:
46 changes: 0 additions & 46 deletions benchmark/asian_options_tf.py

This file was deleted.

Loading

0 comments on commit 410b7b8

Please sign in to comment.