Skip to content

Commit

Permalink
readme file added
Browse files Browse the repository at this point in the history
  • Loading branch information
Katrina Petroske committed Aug 16, 2018
1 parent 990fa7d commit 58b9a4d
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions examples/basic_examples/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
README

The examples in this folder are meant to be an introduction to the use a features of libEsemble.

Some of the examples require the use of external software:

1. MUQ2 - http://muq.mit.edu/
For more detailed installation instructions visit http://muq.mit.edu/master-docs/muqinstall.html
Installation:
1. Create a folder to install MUQ2 in
2. In termianl go to directory where you want to download to then
git clone https://bitbucket.org/mituq/muq2.git
cd muq2
cmake -DCMAKE_INSTALL_PREFIX=/my/install/path -DMUQ_USE_PYTHON=ON
make -j4
make install

-j4 is an option specifying that make can use 4 threads for parallel compilation.
Depending on what versions of python you have it may be nessecary to add
-DPYTHON_EXECUTABLE:FILEPATH=/path/to/python3
to the cmake line

3. Add MUQ2 to the python path by adding following line to bashrc
export PYTHONPATH="${PYTHONPATH}:/my/install/path/lib"

2. Pandas (optional for plotting) - https://pandas.pydata.org
Installation:
1. From terminal
pip3 install pandas or pip3 install pandas --user

0 comments on commit 58b9a4d

Please sign in to comment.