Educational code illustrating fundamentals of vibration for mechanical engineers.
Project description
============================================
The Engineering Vibration Toolbox for Python
============================================
.. include:: <isonum.txt>
.. image:: https://badge.fury.io/py/vibration_toolbox.png/
:target: http://badge.fury.io/py/vibration_toolbox
Joseph C. Slater and Raphael Timbó
Welcome to `Engineering Vibration Toolbox <https://vibrationtoolbox.github.io>`_,
originally written for `Matlab <http://www.mathworks.com>`_\®, but with extra features only for
`Python <http://python.org>`_. This is an *educational* set of codes intended for
demonstration of concepts. You may find them useful for application, but that
isn't the intent. If you have professional level needs, please `contact the authors <mailto:joseph.c.slater@gmail.com>`_.
For more information, please see the `documentation for the Python version <http://vibrationtoolbox.github.io/vibration_toolbox/>`_ but please excuse that it is still under development. Such documentation has never existed for the other ports of the toolbox so this is taking some time. We don't need feedback at this time, but we will take assistance in improving documentation and code.
Installation
------------
Installation is made easy with ``pip``, with releases as we have time while we try
to create a full first release. Much of it works already, but we certainly need
issue reports (on `github <http://github.com/vibrationtoolbox/vibration_toolbox>`_).
To install::
pip install --user vibration_toolbox
where ``--user`` isn't necessary if you are using a locally installed version of Python such as `Anaconda <https://www.continuum.io/downloads>`_.
To run, I recommend you open a `jupyter <https://jupyter.org>`_ notebook and type::
import vibration_toolbox as vtb
For examples, see the `JupyterNotebooks folder <https://github.com/vibrationtoolbox/vibration_toolbox/tree/master/JupyterNotebooks>`_. Some of these have interactive capabilities that are only apparent when you run them yourself instead of just looking at them on github.
Installation of current code
____________________________
The usage documentation is far behind the current code, while the reference is way ahead of the released code due to the `autodoc <http://www.sphinx-doc.org/en/stable/ext/autodoc.html>`_ capability of `Sphinx <http://www.sphinx-doc.org/en/stable/>`_. Especially as of early 2017, the code is in rapid development. So is the documentation. Releases to `pypi <https://pypi.python.org/pypi>`_ are far behind current status as stopping to deploy would cost more time that it is worth. We have the objective of releasing a first non-beta version at the end of May, but even this cannot be promised.
If you wish to install the current version of the software, download the newest ``wheel`` file from
``https://github.com/vibrationtoolbox/vibration_toolbox/tree/master/dist``. This should be easy to understand, outside of what a ``wheel file`` is. Don't fret that. It's the full package as it currently stands (at lease the last time someone made a `wheel`).
Then, type:: python
pip install --force-reinstall --upgrade --user dist/vibration_toolbox-0.5b9-py3-none-any.whl
Where you see ``0.5.b9`` above, you will likely need to insert the correct version. We don't increment versions for each minor edit, so you may have to force upgrade.
That should be it. Please note issues on the `issues tab <https://github.com/vibrationtoolbox/vibration_toolbox>`_ on github.
The Engineering Vibration Toolbox for Python
============================================
.. include:: <isonum.txt>
.. image:: https://badge.fury.io/py/vibration_toolbox.png/
:target: http://badge.fury.io/py/vibration_toolbox
Joseph C. Slater and Raphael Timbó
Welcome to `Engineering Vibration Toolbox <https://vibrationtoolbox.github.io>`_,
originally written for `Matlab <http://www.mathworks.com>`_\®, but with extra features only for
`Python <http://python.org>`_. This is an *educational* set of codes intended for
demonstration of concepts. You may find them useful for application, but that
isn't the intent. If you have professional level needs, please `contact the authors <mailto:joseph.c.slater@gmail.com>`_.
For more information, please see the `documentation for the Python version <http://vibrationtoolbox.github.io/vibration_toolbox/>`_ but please excuse that it is still under development. Such documentation has never existed for the other ports of the toolbox so this is taking some time. We don't need feedback at this time, but we will take assistance in improving documentation and code.
Installation
------------
Installation is made easy with ``pip``, with releases as we have time while we try
to create a full first release. Much of it works already, but we certainly need
issue reports (on `github <http://github.com/vibrationtoolbox/vibration_toolbox>`_).
To install::
pip install --user vibration_toolbox
where ``--user`` isn't necessary if you are using a locally installed version of Python such as `Anaconda <https://www.continuum.io/downloads>`_.
To run, I recommend you open a `jupyter <https://jupyter.org>`_ notebook and type::
import vibration_toolbox as vtb
For examples, see the `JupyterNotebooks folder <https://github.com/vibrationtoolbox/vibration_toolbox/tree/master/JupyterNotebooks>`_. Some of these have interactive capabilities that are only apparent when you run them yourself instead of just looking at them on github.
Installation of current code
____________________________
The usage documentation is far behind the current code, while the reference is way ahead of the released code due to the `autodoc <http://www.sphinx-doc.org/en/stable/ext/autodoc.html>`_ capability of `Sphinx <http://www.sphinx-doc.org/en/stable/>`_. Especially as of early 2017, the code is in rapid development. So is the documentation. Releases to `pypi <https://pypi.python.org/pypi>`_ are far behind current status as stopping to deploy would cost more time that it is worth. We have the objective of releasing a first non-beta version at the end of May, but even this cannot be promised.
If you wish to install the current version of the software, download the newest ``wheel`` file from
``https://github.com/vibrationtoolbox/vibration_toolbox/tree/master/dist``. This should be easy to understand, outside of what a ``wheel file`` is. Don't fret that. It's the full package as it currently stands (at lease the last time someone made a `wheel`).
Then, type:: python
pip install --force-reinstall --upgrade --user dist/vibration_toolbox-0.5b9-py3-none-any.whl
Where you see ``0.5.b9`` above, you will likely need to insert the correct version. We don't increment versions for each minor edit, so you may have to force upgrade.
That should be it. Please note issues on the `issues tab <https://github.com/vibrationtoolbox/vibration_toolbox>`_ on github.
