GETSTARTED.md

Bayesian Noise and Jitter removal algorithm – MCMCNJ

This software is "work in progress" and under active development during the next couple of weeks.

If you have questions get in touch with the developers.

Getting started

To get started with this follow these steps:

1. Get a copy of the code via

   git clone https://github.com/Met4FoF/npl-jitter-noise-removal-mcmc.git

   or update your copy via

   git pull

2. Either use the provided environment.yml to create an appropriate virtual environment with the correct Python version and agentMET4FOF and proceed with step 5. or take the manual installation steps

3. Install Python 3.8

4. Install agentMET4FOF's most current version into your Python environment via

   pip install agentMET4FOF==0.8.1

5. In your terminal run

   python NJ_with_MCMC_agent.py

6. Visit http://127.0.0.1:8050/ in your local browser

7. You should see something like the following