Skip to content

jose-perales/math-devcontainer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

math-devcontainer

A devcontainer to build a grad school math course workspace. Opioninated for Python and Latex.

How to use the devcontainer

I generally use this workspace in one of two ways.

How I structure coursework

I assume that the course is structured in weekly modules and that course work involves some problem set from a textbook and some software assignment.

First, I create a directory called module-{x} where x is that week's module number.

Then, I create a text file like assignment-example.md. See the example assignment for more details.

The devcontainer includes a full LaTeX toolchain (TeX Live) plus ChkTeX for linting LaTeX source.

To lint a LaTeX file you can run:

chktex assignment-example.tex

For any part of the assignment that uses Python, I change directory to the module and then use I use uv which is already installed on the devcontainer to set up Python for each module.

  1. cd module-example
  2. uv init
  3. uv add numpy matplotlib or whatever dependencies you need.
  4. uv run software_assignment.py
  5. [Optional for linting] uv add ruff
  6. [Optional for linting] uv run -m ruff format

I then copy the Python code into the assignment and link any images created from a library like matplotlib. See the example assignment for more details.

About

A devcontainer to build a grad school math course workspace. Opinionated for Latex and Python.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors