https://github.com/drvinceknight/pfm

Python for Mathematics: A book aimed at undergraduate mathematicians learning python
https://github.com/drvinceknight/pfm

mathematics python

Last synced: about 1 month ago
JSON representation

Python for Mathematics: A book aimed at undergraduate mathematicians learning python

• Host: GitHub
• URL: https://github.com/drvinceknight/pfm
• Owner: drvinceknight
• License: mit
• Created: 2020-09-21T15:10:46.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-17T08:40:25.000Z (7 months ago)
• Last Synced: 2024-06-20T00:44:32.524Z (6 months ago)
• Topics: mathematics, python
• Language: TeX
• Homepage: https://vknight.org/pfm
• Size: 104 MB
• Stars: 14
• Watchers: 3
• Forks: 7
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![deploy-book](https://github.com/drvinceknight/pfm/workflows/deploy-book/badge.svg)

# Python for mathematics

## Development

The book is written in files found in `book/` in the [MySt markdown

format](https://myst-nb.readthedocs.io/en/latest/).

To install development dependencies:

    pip install -r requirements-dev.txt

Note that as of the time of writing this: python version needs to be <=3.10.

To check the format of the python code in the markdown files:

    inv stylecheck

To check the spelling:

    inv spellcheck

To check the prose:

    inv prosecheck

To generate back up `ipynb` versions of the notebooks:

    inv backupbook

To test the notebooks:

    inv testnbs

The main purpose of backing up to `ipynb` and then testing is so that the CI can

confirm the results written in the book are what would be obtained when using

updated libraries.

To generate the book to the `book` directory:

    inv build