Skip to content

Commit aa6a1a5

Browse files
author
Niraj Bajpai
committed
feat: Add GEMINI.md for project context
1 parent 771cf9f commit aa6a1a5

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

GEMINI.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Project Overview
2+
3+
This directory contains the source files for the "Jupyter Guide to Linear Algebra," an interactive book created with Jupyter Book. The guide is designed for introductory-level students and covers core linear algebra topics using Python, NumPy, SciPy, and Matplotlib. It emphasizes practical computation and application over formal proofs and theorems.
4+
5+
The content is structured as a series of Jupyter notebooks (`.ipynb` files) that cover topics such as linear systems, vector spaces, linear transformations, inner products, and eigenvalues. The guide also includes introductions to Python, NumPy, and Jupyter itself.
6+
7+
A custom Python module, `laguide.py`, provides a set of functions for performing linear algebra operations like row reduction, QR factorization, and solving systems of equations. This module is used throughout the notebooks.
8+
9+
## Building and Running
10+
11+
This is a Jupyter Book project. To build the book locally, you need to have Python and the dependencies listed in `requirements.txt` installed.
12+
13+
1. **Install dependencies:**
14+
15+
```bash
16+
pip install -r requirements.txt
17+
```
18+
19+
2. **Build the book:**
20+
21+
```bash
22+
jupyter-book build .
23+
```
24+
25+
This will generate a `_build/html` directory containing the static HTML files for the book. You can open `_build/html/index.html` in a web browser to view the book.
26+
27+
## Development Conventions
28+
29+
The project is organized as a Jupyter Book.
30+
31+
* **Configuration:** The book's configuration is in `_config.yml`, which includes the title, author, and other settings.
32+
* **Table of Contents:** The structure of the book is defined in `_toc.yml`. This file determines the order of the chapters and sections.
33+
* **Content:** The main content is in the Jupyter notebooks (`.ipynb` files). Each notebook corresponds to a chapter or section of the book.
34+
* **Custom Module:** The `laguide.py` file contains custom functions used in the notebooks. Any new, reusable code should be added to this module.
35+
* **Images:** Images are stored in the `img/` directory.
36+
* **Solutions:** Solutions to exercises are provided in separate notebooks, such as `Linear_Systems_Solutions.ipynb`.

0 commit comments

Comments
 (0)