=================
DynamicistToolKit
=================
.. list-table::
* - PyPi
- .. image:: https://img.shields.io/pypi/v/DynamicistToolKit.svg
:target: https://pypi.org/project/DynamicistToolKit
.. image:: https://pepy.tech/badge/DynamicistToolKit
:target: https://pypi.org/project/DynamicistToolKit
* - Anaconda
- .. image:: https://anaconda.org/conda-forge/dynamicisttoolkit/badges/version.svg
:target: https://anaconda.org/conda-forge/dynamicisttoolkit
.. image:: https://anaconda.org/conda-forge/dynamicisttoolkit/badges/downloads.svg
:target: https://anaconda.org/conda-forge/dynamicisttoolkit
* - Documentation
- .. image:: https://readthedocs.org/projects/dynamicisttoolkit/badge/?version=stable
:target: http://dynamicisttoolkit.readthedocs.io
* - Continous Integration
- .. image:: https://github.com/moorepants/DynamicistToolKit/actions/workflows/test.yml/badge.svg
Introduction
============
This is a collection of Python modules which contain tools that are helpful for
a dynamics. We use it at the TU Delft Bicycle Lab as an initial shared location
to house reusable tools for the group. These tools may eventually graduate to
packages of their own or be incorporated into other existing specialized
packages.
Modules
=======
**bicycle**
Generic tools for basic bicycle dynamics analysis.
**control**
Functions helpful in control systems analysis.
**inertia**
Various functions for calculating and manipulating inertial quantities.
**process**
Various tools for common signal processing tasks.
Installation
============
You can install DynamicistToolKit with conda::
$ conda install -c conda-forge dynamicisttoolkit
or pip::
$ python -m pip install DynamicistToolKit
Or download the source with your preferred method and install manually.
Using Git::
$ git clone git@github.com:moorepants/DynamicistToolKit.git
$ cd DynamicistToolKit
Or wget::
$ wget https://github.com/moorepants/DynamicistToolKit/archive/master.zip
$ unzip master.zip
$ cd DynamicistToolKit-master
Then for basic installation::
$ python setup.py install
Or install for development purposes::
$ python setup.py develop
Tests
=====
Run the unit tests with pytest::
$ pytest dtk
and doctests with::
$ pytest --doctest-modules dtk
Documentation
=============
The documentation is hosted at ReadTheDocs:
http://dynamicisttoolkit.readthedocs.org
You can build the documentation if you have Sphinx and numpydoc::
$ cd docs
$ make html
$ firefox _build/html/index.html
To locally build on Windows, open an Anaconda prompt (the base environment has
sphinx and numpydoc installed), navigate to the DynamicistToolKit directory and
execute::
$ cd docs
$ make.bat html
$ start "" ".\_build\html\index.html"
Raw data
{
"_id": null,
"home_page": "http://github.com/moorepants/DynamicistToolKit",
"name": "DynamicistToolKit",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Jason K. Moore",
"author_email": "moorepants@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/20/ef/0ffa52c678a5691c0b3e204a1b6a9e7ce0aa924354ea598850aeb96a9119/dynamicisttoolkit-0.6.1.tar.gz",
"platform": null,
"description": "=================\nDynamicistToolKit\n=================\n\n.. list-table::\n\n * - PyPi\n - .. image:: https://img.shields.io/pypi/v/DynamicistToolKit.svg\n :target: https://pypi.org/project/DynamicistToolKit\n .. image:: https://pepy.tech/badge/DynamicistToolKit\n :target: https://pypi.org/project/DynamicistToolKit\n * - Anaconda\n - .. image:: https://anaconda.org/conda-forge/dynamicisttoolkit/badges/version.svg\n :target: https://anaconda.org/conda-forge/dynamicisttoolkit\n .. image:: https://anaconda.org/conda-forge/dynamicisttoolkit/badges/downloads.svg\n :target: https://anaconda.org/conda-forge/dynamicisttoolkit\n * - Documentation\n - .. image:: https://readthedocs.org/projects/dynamicisttoolkit/badge/?version=stable\n :target: http://dynamicisttoolkit.readthedocs.io\n * - Continous Integration\n - .. image:: https://github.com/moorepants/DynamicistToolKit/actions/workflows/test.yml/badge.svg\n\nIntroduction\n============\n\nThis is a collection of Python modules which contain tools that are helpful for\na dynamics. We use it at the TU Delft Bicycle Lab as an initial shared location\nto house reusable tools for the group. These tools may eventually graduate to\npackages of their own or be incorporated into other existing specialized\npackages.\n\nModules\n=======\n\n**bicycle**\n Generic tools for basic bicycle dynamics analysis.\n**control**\n Functions helpful in control systems analysis.\n**inertia**\n Various functions for calculating and manipulating inertial quantities.\n**process**\n Various tools for common signal processing tasks.\n\nInstallation\n============\n\nYou can install DynamicistToolKit with conda::\n\n $ conda install -c conda-forge dynamicisttoolkit\n\nor pip::\n\n $ python -m pip install DynamicistToolKit\n\nOr download the source with your preferred method and install manually.\n\nUsing Git::\n\n $ git clone git@github.com:moorepants/DynamicistToolKit.git\n $ cd DynamicistToolKit\n\nOr wget::\n\n $ wget https://github.com/moorepants/DynamicistToolKit/archive/master.zip\n $ unzip master.zip\n $ cd DynamicistToolKit-master\n\nThen for basic installation::\n\n $ python setup.py install\n\nOr install for development purposes::\n\n $ python setup.py develop\n\nTests\n=====\n\nRun the unit tests with pytest::\n\n $ pytest dtk\n\nand doctests with::\n\n $ pytest --doctest-modules dtk\n\nDocumentation\n=============\n\nThe documentation is hosted at ReadTheDocs:\n\nhttp://dynamicisttoolkit.readthedocs.org\n\nYou can build the documentation if you have Sphinx and numpydoc::\n\n $ cd docs\n $ make html\n $ firefox _build/html/index.html\n\nTo locally build on Windows, open an Anaconda prompt (the base environment has\nsphinx and numpydoc installed), navigate to the DynamicistToolKit directory and\nexecute::\n\n $ cd docs\n $ make.bat html\n $ start \"\" \".\\_build\\html\\index.html\"\n",
"bugtrack_url": null,
"license": "UNLICENSE.txt",
"summary": "Various tools for theoretical and experimental dynamics.",
"version": "0.6.1",
"project_urls": {
"Homepage": "http://github.com/moorepants/DynamicistToolKit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20ef0ffa52c678a5691c0b3e204a1b6a9e7ce0aa924354ea598850aeb96a9119",
"md5": "5197cc6f8b8a3eac1c0f405f1e13add8",
"sha256": "5a64af2e2e7e514e1383f54ed0695325f1d8520c9cc8d0fda1dacd170aacf901"
},
"downloads": -1,
"filename": "dynamicisttoolkit-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "5197cc6f8b8a3eac1c0f405f1e13add8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 104357,
"upload_time": "2024-06-21T19:51:37",
"upload_time_iso_8601": "2024-06-21T19:51:37.578582Z",
"url": "https://files.pythonhosted.org/packages/20/ef/0ffa52c678a5691c0b3e204a1b6a9e7ce0aa924354ea598850aeb96a9119/dynamicisttoolkit-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-21 19:51:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "moorepants",
"github_project": "DynamicistToolKit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dynamicisttoolkit"
}
JSON
