https://github.com/ekiim/odeanimate

A naive numerical analysis module.
https://github.com/ekiim/odeanimate

numerical-methods python

Last synced: 4 months ago
JSON representation

A naive numerical analysis module.

• Host: GitHub
• URL: https://github.com/ekiim/odeanimate
• Owner: ekiim
• License: gpl-2.0
• Created: 2022-07-21T03:09:10.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-04-21T18:46:40.000Z (about 2 years ago)
• Last Synced: 2025-02-01T17:47:23.208Z (4 months ago)
• Topics: numerical-methods, python
• Language: Python
• Homepage: https://odeanimate.ekiim.xyz
• Size: 875 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# ODE Animate

[![PyPI version](https://badge.fury.io/py/odeanimate.svg)](https://pypi.org/project/odeanimate/)

This project aims to be a set of tools for solving, plotting, and animating curves and fields.

> The rational for this is, _trying to use pure-python_ to do numerical analysis.

Most techniques here are going to be without the use of any external modules.

The only external modules that are used _directly_ by this project are:

 - `matplotlib`, which is used to configure the _figures_ for plotting.

## Features

> Most of this features are _W.I.P._ (work in progress)

 - [x] Vector objects with _basic_ operations.

 - [x] Vector objects with _basic_ operations.

 - [x] Function utilities for _real valued_ functions.

 - [x] Automatic plotting for _real valued_ functions.

 - [ ] Generic _ODE_ integrators.

 - [X] Utilities for curves.

 - [ ] Utilities for surfaces.

 - [ ] Animation Loop and widgets

## Development

> This project uses [`pipenv`](https://pipenv.pypa.io/) for local development and testing.

If you are intending to:

- Add examples or documentation,

- develop further this module

- use and test in an isolated enviroment

you should have `pipenv` installed.

One you cloned the repository, you should be able to execute `pipenv install --dev` and everything should be working.

Most of what you would need is configured in the `pyproject.toml` file, so if you are using the tools specified in

the `scripts` section of the `Pipfile` you should be fine.

## Contribute

If you wish to contribute you can contact me directly, or open an issue in the github repository.

The main development for this module is done in a private repository, but for visibility and public

interaction I'll host this in github too.

## License

This project is under the [GPL2 License](/LICENSE.txt).