Skip to content
Snippets Groups Projects
Commit b21f14de authored by Nando Farchmin's avatar Nando Farchmin
Browse files

Update README

parent 0abf214a
No related branches found
No related tags found
No related merge requests found
...@@ -7,6 +7,14 @@ To achieve this, we cover some of the basic settings (Bayesian inverse problems, ...@@ -7,6 +7,14 @@ To achieve this, we cover some of the basic settings (Bayesian inverse problems,
No prior knowledge about the topics discussed is required, it is helpful though if you are familiar with a typical parameter reconstruction task. No prior knowledge about the topics discussed is required, it is helpful though if you are familiar with a typical parameter reconstruction task.
If you want to participate in the interactive session, you need a laptop with a python environment (preferably Anaconda). If you want to participate in the interactive session, you need a laptop with a python environment (preferably Anaconda).
## Information
| What | Where |
| --- | --- |
| PyThia repository | [https://gitlab.com/pythia-uq/pythia](https://gitlab.com/pythia-uq/pythia) |
| PyThia doc | [https://www.pythia-uq.com](https://www.pythia-uq.com) |
| emcee doc | [https://emcee.readthedocs.io/en/stable/](https://emcee.readthedocs.io/en/stable/) |
## Setup ## Setup
After cloning the repository, you need to ensure all required python packages are installed. After cloning the repository, you need to ensure all required python packages are installed.
A specification of all requirements and their respective versions are listed in the `environment.yml` file. A specification of all requirements and their respective versions are listed in the `environment.yml` file.
...@@ -18,7 +26,20 @@ conda env create -f environment.yml ...@@ -18,7 +26,20 @@ conda env create -f environment.yml
Then start the environment using `conda activate qunom`. Then start the environment using `conda activate qunom`.
## How to use this repository ## How to use this repository
**TODO:** describe which scripts to run and how.
###### Presentation
The tex file for the slides is in the `slides/` directory.
You can run `pdflatex` or use the `Makefile` to generate the pdf.
###### Scripts
The notebooks in the `app/` directory are the main files you can run.
They are divided in three different types:
| Name | Description |
| --- | --- |
| Tutorial x | These scripts explain basic usage of theoretical concepts and the PyThia library. |
| Exercise x | These scripts are meant as exercises for you. You can always use the tutorial scripts for help. |
| Solution x | These scripts are the solutions to the respective exercise. Look into them, if you want to check your own approach to the exercises. |
## Authors and acknowledgment ## Authors and acknowledgment
This repository has been created and is maintained by N. Hegemann, PTB Group 8.43. This repository has been created and is maintained by N. Hegemann, PTB Group 8.43.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment