These steps set up Python and the qmcpy environment so you can run the course notebooks.

1. Clone this repository

git clone https://github.com/QMCSoftware/MATH565Fall2025.git
cd MATH565Fall2025

2. Create and activate a Conda environment

conda create -n qmcpy python=3.12 -y
conda activate qmcpy

(You can use mamba instead of conda if you prefer.)

3. Install QMCSoftware (editable)

pip install -e "qmcsoftware[dev]"

This installs qmcpy plus its development extras (JupyterLab, matplotlib, pandas, etc.).

4. Install course-specific extras

We keep our extras in a single file, requirements-course.txt.

pip install -r requirements-course.txt

5. Register the Jupyter kernel

python -m ipykernel install --user --name qmcpy --display-name "Python (qmcpy)"

Now, when you open Jupyter, choose Python (qmcpy) as the kernel for the notebooks.

6. Updating later

When the repo or QMCSoftware changes:

git pull

conda activate qmcpy
pip install -e "qmcsoftware[dev]" --upgrade
pip install -r requirements-course.txt --upgrade

7. Verify installation

Run this to check that qmcpy is installed and working:

python -c "import qmcpy; print('QMCSoftware version:', qmcpy.__version__)"

You should see output like:

QMCSoftware version: 2.0

Troubleshooting

  • Apple Silicon (M1/M2/M3): Prefer miniforge and mamba.
  • Windows users: If pip tries to compile something and fails, you may need Microsoft C++ Build Tools.

  • Starting fresh: If your environment breaks:

    conda env remove -n qmcpy
conda create -n qmcpy python=3.12 -y
conda activate qmcpy
pip install -e "qmcsoftware[dev]"
pip install -r requirements-course.txt

🎉 You’re ready to run the notebooks!

⬅️ Back to Notebooks