Skip to content

Commit 2d5625c

Browse files
Merge pull request #2 from PeerHerholz/jupyter-book
initial test and draft of Jupyter book
2 parents 564e085 + 5b067cd commit 2d5625c

File tree

18 files changed

+349
-36
lines changed

18 files changed

+349
-36
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: build-course-page
2+
3+
# Only run this when the master branch changes
4+
on:
5+
push:
6+
branches:
7+
- main
8+
# If your git repository has the Jupyter Book within some-subfolder next to
9+
# unrelated files, you can make this run only if a file within that specific
10+
# folder has been modified.
11+
#
12+
# paths:
13+
# - content/**
14+
15+
# This job installs dependencies, build the book, and pushes it to `gh-pages`
16+
jobs:
17+
deploy-book:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v2
21+
22+
# Install dependencies
23+
- name: Set up Python 3.11.11
24+
uses: actions/setup-python@v1
25+
with:
26+
python-version: 3.11.11
27+
28+
- name: Install dependencies
29+
run: |
30+
pip install -r requirements.txt
31+
# Build the page
32+
- name: Build the course page
33+
run: |
34+
jupyter-book build cmm_course/
35+
# Push the book's HTML to github-pages
36+
- name: GitHub Pages action
37+
uses: peaceiris/actions-gh-pages@v3.6.1
38+
with:
39+
github_token: ${{ secrets.GITHUB_TOKEN }}
40+
publish_dir: ./cmm_course/_build/html

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# JB builds
2+
cmm_course/_build/*
3+
14
# Byte-compiled / optimized / DLL files
25
__pycache__/
36
*.py[cod]

cmm_course/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Models of Memory
2+
3+
Welcome! This repository contains course materials for the Dartmouth graduate course on computational models of learning and memory. The syllabus may be found [here](https://github.com/ContextLab/memory-models-course/blob/main/admin/syllabus.pdf). Feel free to follow along with the course materials (whether you are officially enrolled in the course or just visiting!), submit comments and suggestions, etc. An outline of the course materials, including links to lecture and discussion topics and assignments may be found [here](https://github.com/ContextLab/memory-models-course/blob/main/slides/README.md).
4+
5+
<p align="center">
6+
<img src="https://raw.githubusercontent.com/ContextLab/memory-models-course/main/admin/readme_robot.png" alt="robot" width="400"/>
7+
</p>
8+
9+
## A note about this Open Course
10+
This course is taught as an *Open Course*, meaning that the course is designed from the ground up to be shareable and freely accessible to anyone. All code for this course is written in [Python](https://www.python.org/) and most of the material is organized in [Jupyter notebooks](http://jupyter.org/).
11+
12+
Feel free to follow along with this course, do the assignments, post questions and/or issues to this repository or Discord, suggest changes, etc. However, I won't formally evaluate your submitted work unless you are a Dartmouth student who is currently enrolled.
13+
14+
If you are a course instructor teaching overlapping material, feel free to borrow any materials used in this course! If you directly copy (or "draw heavy inspiration from") the materials, I would appreciate a citation (e.g., a pointer to this repository). I'd also love to hear from you about how you're using this resource!
15+
16+
This course is a continually evolving work in progress. I plan to update the material to keep the syllabus fresh and relevant. By the same token, although my goal is 100% accuracy and currency, it's unlikely that I'll achieve that goal. You should participate with the understanding that this material will likely have occasional mistakes, omissions, errors, etc. Given this fact, one way to approach the course is to maintain an open yet critical view of the material. If you think there's a mistake, I encourage you to bring it to my attention!
17+

cmm_course/_config.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Book settings
2+
# Learn more at https://jupyterbook.org/customize/config.html
3+
4+
title: Computational memory Models
5+
author: Jeremy Manning
6+
copyright: 2025 -
7+
logo: https://raw.githubusercontent.com/ContextLab/memory-models-course/main/admin/readme_robot.png
8+
9+
# Force re-execution of notebooks on each build.
10+
# See https://jupyterbook.org/content/execute.html
11+
execute:
12+
execute_notebooks: false
13+
14+
# Define the name of the latex output file for PDF builds
15+
latex:
16+
latex_documents:
17+
targetname: book.tex
18+
19+
# Add a bibtex file so that we can create citations
20+
bibtex_bibfiles:
21+
- references.bib
22+
23+
sphinx:
24+
config:
25+
bibtex_reference_style: author_year
26+
27+
# Information about where the book exists on the web
28+
repository:
29+
url: https://github.com/ContextLab/memory-models-course # Online location of your book
30+
path_to_book: ccm_course # Optional path to your book, relative to the repository root
31+
branch: main # Which branch of the repository should be used when creating links (optional)
32+
33+
# Add GitHub buttons to your book
34+
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
35+
html:
36+
use_issues_button: true
37+
use_repository_button: true
38+

cmm_course/_toc.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
format: jb-book
2+
root: README
3+
chapters:
4+
- file: instructions
5+
- file: admin/syllabus
6+
- file: slides/README
7+
- file: assignments/README
8+
sections:
9+
- file: assignments/Assignment_1:Hopfield_Networks/README
10+
- file: assignments/Assignment_2:Search_of_Associative_Memory_Model/README
11+
- file: assignments/Assignment_3:Context_Maintenance_and_Retrieval_Model/README
12+
- file: assignments/Assignment_4:_Laplace_Temporal_Context_Model/README
13+
- file: assignments/Final_Project/README
File renamed without changes.

admin/syllabus.md renamed to cmm_course/admin/syllabus.md

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,11 @@
1-
---
2-
title: "PSYC 133: Models of Memory"
3-
geometry: margin=1in
4-
header-includes:
5-
- \usepackage{fontspec}
6-
- \usepackage{booktabs}
7-
- \setmainfont{Berkeley Mono}
8-
output: pdf
9-
---
10-
11-
\setlength{\arrayrulewidth}{0.5mm}
12-
\vspace{-0.75in}
13-
\begin{center}
14-
\begin{tabular}{|p{1.25in}|p{2in}|}
15-
\hline
16-
\textbf{Meeting times} & TBD \\
17-
\hline
18-
\textbf{Classroom} & TBD \\
19-
\hline
20-
\textbf{Instructor} & Dr. Jeremy R. Manning \\
21-
\hline
22-
\textbf{Email} & \href{mailto:jeremy@dartmouth.edu}{jeremy@dartmouth.edu} \\
23-
\hline
24-
\textbf{Office location} & 349 Moore Hall \\
25-
\hline
26-
\textbf{Office hours} & By appointment \\
27-
\hline
28-
\end{tabular}
29-
\end{center}
1+
| **Field** | **Details** |
2+
|----------------------|-----------------------------------------------------------------------------|
3+
| **Meeting times** | TBD |
4+
| **Classroom** | TBD |
5+
| **Instructor** | Dr. Jeremy R. Manning |
6+
| **Email** | [jeremy@dartmouth.edu](mailto:jeremy@dartmouth.edu) |
7+
| **Office location** | 349 Moore Hall |
8+
| **Office hours** | By appointment |
309

3110
## Course Description
3211
Knowing how our brains organize and spontaneously retrieve memories is at the heart of understanding the basis of the ongoing internal dialog of our conscious thoughts. Put simply, our memories make us _who we are_. In this course, we will use readings, discussions, and hands-on demonstrations to explore historical approaches, current approaches, and hints about the "next generation" of computational (mathematical) models of learning and memory.

0 commit comments

Comments
 (0)