Metadata-Version: 2.1
Name: dtumathtools
Version: 0.9.2
Summary: A plotting package for the 01005 Mathematics 1 course at the Technical University of Denmark
Author-email: Christian Mikkelstrup <s194345@student.dtu.dk>, Hans Henrik Hermansen <s194042@student.dtu.dk>
License: BSD License (BSD)
Project-URL: Homepage, https://github.com/Chrillebon/DTUMathTools
Project-URL: Mathematics 1 homepage, https://01005.compute.dtu.dk/
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# DTUMathTools

## Description
This package is a collection of easy-to-use commands for plotting using SymPy. It is designed to fit the requirements of *01005 - Advanced Mathematics in Engineering 1* course at the Technical University of Denmark, found [here](https://01005.compute.dtu.dk/). This includes, but is not limited to:

- Plotting of vector fields and vectors
- 2D plotting of SymPy functions
- 3D plotting of SymPy functions
- Scatterplots in 2D and 3D

The plotting functions are an extension of *sympy-plot-backends*, and so documentation and examples of plots (for all functions but *dtuplot.scatter()* and *dtuplot.quiver()*) can be found at [sympy-plot-backends.readthedocs.io/](https://sympy-plot-backends.readthedocs.io/en/latest/). Additional functionality and usage is given through course material.

## Installation
To install dtumathtools using PyPi, run the following command

``$ pip install dtumathtools``

Then one can import all the utility by writing

``from dtumathtools import *``

All plotting functionality can be found using *dtuplot.xxx* (including all spb plotting functions).

## Usage
Use is designed for the *01005 - Advanced Mathematics in Engineering 1* course at the Technical University of Denmark. Any use-case outside this scope is thus not considered, but very welcome!

## Contributing
You are very welcome to contribute in the way that makes sense to you! The development team will consider all pull requests at the repo [here](https://github.com/Chrillebon/DTUMathTools), as well as mails directly to the developers ``s194345@student.dtu.dk`` or ``s194042@student.dtu.dk``. For changes to plotting functionality outside *scatter* and *quiver*, direct queries to [spb](https://github.com/Davide-sd/sympy-plot-backends).

## Authors and acknowledgment
The project would have never gotten off the ground without Jakob Lemvig and his engagement with SymPy in Mathematics 1. Thank you to Ulrik Engelund Pedersen for trusting us with this task. Finally, a huge thanks to the professors of the course for making great and engaging education: Micheal Pedersen and Karsten Schmidt.

## License
Open-source under the BSD license. This means that you are free to use it whatever you like, be it academic, commercial, creating forks or derivatives, as long as you copy the BSD statement if you redistribute it (see the LICENSE file for details).

## Project status
This package is in beta. It is deemed good enough for it to be used in the course material from February 2023, and is expected to be refined after feedback from the students that end up using it.
