Progress checklists

# package imports (SHIFT + ENTER to run)
import sys
import os

# Add the Modules directory to the Python path
GUIDE_BASE_DIR = os.path.abspath(os.path.join(os.getcwd(), '..'))
sys.path.append(os.path.join(GUIDE_BASE_DIR, 'Modules'))

# Import the Checklist module
from Checklist import Checklist # type: ignore

---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
Cell In[1], line 10
      7 sys.path.append(os.path.join(GUIDE_BASE_DIR, 'Modules'))
      9 # Import the Checklist module
---> 10 from Checklist import Checklist # type: ignore

ModuleNotFoundError: No module named 'Checklist'

Progress checklists#

This notebook creates interactive checklist, for you to track you progress through each learning notebook and The Guide, as a whole.

Using the Checklist module#

  1. Chose a notebook from the list of notebooks.

  2. Replace the 'notebook' variable with your chosen notebook string (e.g., "Introduction").

  3. Run the cell (Shift + Enter)

notebook = "Introduction"
Checklist.create_checklist_from_notebook(notebook)

Introduction checklist

You can track your progress through other notebooks by changing the 'notebook' variable and rerunning the above cell or by adding another 'create_checklist_from_notebook' call in a new cell (e.g., see below). Your progress through each notebook is being saved in a .json file in the Progress folder, even if you replace the checklist you are using, in this notebook.

notebook = "Eras"
Checklist.create_checklist_from_notebook(notebook)

Eras checklist

Tracking exercises#

You can track your progress though the exercises in each notebook in a similar fashion.

notebook = "BinarySource"
Checklist.create_exercise_checklist_from_notebook(notebook)

BinarySource exercises checklist

List of notebooks#

The following function lists all of the available notebooks and your progress though them.

Checklist.list_notebooks() # type: ignore

Available notebooks:
--------------------
Introduction                                  ( 23% complete)
SingleLens                                    (  0% complete)
AstrometricMicrolensing                       (  0% complete)
Eras                                          (  0% complete)
Photometry                                    (  0% complete)
BinaryLens                                    (  0% complete)
RemnantsAndDarkMatter                         (  0% complete)
BinarySource                                  (  0% complete)
GalacticModel                                 (  0% complete)
Modelling                                     (  0% complete)
MultipleLens                                  (  0% complete)
GULLS                                         (  0% complete)
NGRST                                         (  0% complete)
NGRSTContemperanousObservers                  (  0% complete)
LensFluxAnalysis                              (  0% complete)
PlanetsAndBrownDwarfs                         (  0% complete)
Contents