Skip to content
Snippets Groups Projects
Commit 7679bd72 authored by Manuel Marschall's avatar Manuel Marschall
Browse files

documented python and matlab code in readme

parent 4468028e
No related branches found
No related tags found
No related merge requests found
# # License
# copyright Manuel Marschall (PTB) 2021
# copyright Manuel Marschall and Gerd Wübbeler(PTB) 2021
# This software is licensed under the BSD-like license:
......
......@@ -42,6 +42,40 @@ The Python library can be found in the directory `code` and it is written and te
For the examples under `code/Notebooks` a Jupyter Notebook environment is required.
## Install Python with Anaconda
To install and use the Python code we recommend using Anaconda `https://www.anaconda.com/products/individual`. Simply download and install Anaconda and create your Python environment using the terminal command
```
conda create -n GUMS1-RejSampler python=3.9.5 numpy=1.20.2 scipy=1.6.2 matplotlib=3.3.4
```
Then, activate the environment with
```
conda activate GUMS1-RejSampler
```
and install some utility packages that are used for the MCMC reference computation and progression tracking
```
pip install emcee==3.1.0 tqdm==4.62.2
```
## Run the Python scripts
Having a suitable Python environment, the examples can be started by simply calling, e.g.,
```
cd code
python example_resistor.py
```
The script will generate a directory `code/data/resistor/` and the relevant output images.
---
# Prerequisite for Matlab code
The matlab files are generated and tested using MATLAB (R2020b) and require the `statistics toolbox` and the `machine learning toolbox`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment