\[\newcommand{\vect}[1]{\vec{\boldsymbol{#1}}} \newcommand{\uvect}[1]{\hat{\boldsymbol{#1}}} \newcommand{\abs}[1]{\lvert#1\rvert} \newcommand{\norm}[1]{\lVert#1\rVert} \newcommand{\I}{\mathrm{i}} \newcommand{\ket}[1]{\left|#1\right\rangle} \newcommand{\bra}[1]{\left\langle#1\right|} \newcommand{\braket}[1]{\langle#1\rangle} \newcommand{\Braket}[1]{\left\langle#1\right\rangle} \newcommand{\op}[1]{\boldsymbol{#1}} \newcommand{\mat}[1]{\underline{\boldsymbol{#1}}} \providecommand{\d}{\mathrm{d}} \renewcommand{\d}{\mathrm{d}} \newcommand{\D}[1]{\mathcal{D}[#1]\;} \newcommand{\pdiff}[3][]{\frac{\partial^{#1}#2}{\partial{#3}^{#1}}} \newcommand{\diff}[3][]{\frac{\d^{#1} #2}{\d{#3}^{#1}}} \newcommand{\ddiff}[3][]{\frac{\delta^{#1} #2}{\delta{#3}^{#1}}} \newcommand{\floor}[1]{\left\lfloor#1\right\rfloor} \newcommand{\ceil}[1]{\left\lceil#1\right\rceil} \DeclareMathOperator{\Tr}{Tr} \DeclareMathOperator{\erf}{erf} \DeclareMathOperator{\erfi}{erfi} \DeclareMathOperator{\sech}{sech} \DeclareMathOperator{\sinc}{sinc} \DeclareMathOperator{\sn}{sn} \DeclareMathOperator{\cn}{cn} \DeclareMathOperator{\dn}{dn} \DeclareMathOperator{\sgn}{sgn} \DeclareMathOperator{\order}{O} \DeclareMathOperator{\diag}{diag} \DeclareMathOperator{\span}{span} \newcommand{\mylabel}[1]{\label{#1}\tag{#1}} \newcommand{\degree}{\circ} % These replace SIunitx. They should not be defined in LaTeX. \newcommand{\SI}[2]{#1\;\mathrm{#2}} \newcommand{\si}[1]{\mathrm{#2}} \newcommand{\squared}{{^{2}}} \newcommand{\cubed}{{^{3}}} \newcommand{\per}{/} \newcommand{\tera}{T} \newcommand{\giga}{G} \newcommand{\mega}{M} \newcommand{\kilo}{k} \newcommand{\milli}{m} \newcommand{\micro}{μ} \newcommand{\nano}{n} \newcommand{\kilogram}{\text{kg}\,} \newcommand{\meter}{\text{m}\,} \newcommand{\second}{\text{s}\,} \newcommand{\ampere}{\text{A}\,} \newcommand{\kelvin}{\text{K}\,} \newcommand{\mol}{\text{mol}\,} \newcommand{\candela}{\text{cd}\,} \newcommand{\newton}{\text{N}\,} \newcommand{\hertz}{\text{Hz}\,} \newcommand{\pascal}{\text{Pa}\,} \newcommand{\volt}{\text{V}\,} \newcommand{\watt}{\text{W}\,} \newcommand{\joule}{\text{J}\,} \newcommand{\henry}{\text{H}\,} \newcommand{\farad}{\text{F}\,} \newcommand{\coulomb}{\text{C}\,} \newcommand{\ohm}{\Omega\,} \newcommand{\weber}{\text{Wb}\,} \newcommand{\tesla}{\text{T}\,} \newcommand{\degree}{\text{deg}\,}\]

PyTimeODE

Contents

PyTimeODE#

Welcome to the main repository for the PyTimeODE project.

TL;DR#

Clone this repository and run

make init

This will generate an environment you can use to work with the project. Once this is done you can make the documentation, tests, etc. with commands like:

make test
make html
make doc-server
...

The latter will host the documentation on https://localhost:8000 and auto-update when you make changes. If you want to manually interact with the environment, then you can run:

make shell

In this shell, you can directly run pytest for example.

Developer Notes#

This file can be included in the documentation by adding the following to Docs/index.md:

```{include} ../README.md
```

See Docs/index.md for more details.

Funding#

Some of the material presented here is based upon work supported by the National Science Foundation under Grant Number 2012190. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.