7e5f20aa2d
The venv cannot be named recode, since a student might be working through multiple exemplars which would lead to name conflicts for the venvs. I named the conda venv mcmc for Monte Carlo Markov Chain.
🎲 ⛓️ 👉 🧪 Markov Chain Monte Carlo for fun and profit
Using random numbers to do all the things.
This is an exemplar project designed to showcase best practices in developing scientific software as part of the ReCoDE Project at Imperial College London.
You do not need to know or care about Markov Chain Monte Carlo for this to be useful to you.
Rather this project is primarily designed to showcase the tools and practices available to you when developing scientific software projects. Maybe you are a PhD student just starting, or a researcher just about to embark on a larger scale software project - there should be something interesting here for you.
Table of contents
- Introduction
- Packaging It Up
- Writing a Markov Chain Monte Carlo Sampler
- Testing
- Adding Functionality
- Speeding It Up
- Producing Research Outputs
- Doing Reproducible Science
- Adding Documentation
How to use this repository
Take a look at the table of contents below and see if there are any topics that might be useful to you. The actual code lives in src and the documentation in docs/learning in the form of Jupyter notebooks.
When you're ready to dive in you have three options:
1. Launch them in Binder (easiest but a bit slow)
2. Clone the repo and run the Jupyter notebooks locally. (Faster but requires you have python/jupyter installed)
git clone https://github.com/ImperialCollegeLondon/ReCoDE_MCMCFF mcmc
cd mcmc
pip install .[dev]
jupyter lab
3. View them non-interactively in GitHub via the links in the table of contents
The map
.
├── CITATION.cff # This file describes how to cite the work contained in this repository.
├── LICENSE # Outlines what legal rights you have to use this software.
├── README.md # You are here!
├── docs
│ ├── ... #Files to do with making the documentation
│ └── learning
│ └── #The Jupyter notebooks that form the main body of this project
│
├── pyproject.toml # Machine readable information about the MCFF package
├── readthedocs.yaml # Tells readthedocs.com how to build the documentation
├── requirements.txt # What packages MCFF requires
├── setup.cfg # Machine readable information about the MCFF package
├── src
│ └── MCFF # The actual code!
│
└── tests # automated tests for the code
External Resources
- The Turing Way has tons of great resources on the topics discussed here.
- Intermediate Research Software Development in Python