Skip to content

Commit

Permalink
Updates for version 0.3.1
Browse files Browse the repository at this point in the history
- Created a documentation page instead of the examples page.
- Removed the old installation guides.
- Made a blog post about the 0.3.1 release.
- Updated the download instructions.
- Linked to true latest release.
- Other random edits.
  • Loading branch information
moorepants committed Jan 10, 2016
1 parent 04e2270 commit 30c898e
Show file tree
Hide file tree
Showing 13 changed files with 79 additions and 115 deletions.
4 changes: 2 additions & 2 deletions source/_theme/pydy/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<div class="logo">
<img class="image"src="{{ pathto('_static/logo.svg', 1) }}">
</div>
</div>
</div>
</div>
<div class="splash">
<div class="container">
Expand All @@ -57,7 +57,7 @@
<div class="nav-download">
<h3>Download</a></h3>
<p>
<a href="https://github.com/pydy/pydy/archive/v0.2.1.zip">
<a href="https://github.com/pydy/pydy/archive/v0.3.1.zip">
Latest Version</a>
</p>
<p>
Expand Down
3 changes: 1 addition & 2 deletions source/_theme/pydy/navbar.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
<ul>
<li id="pydy"><a href="{{ pathto('index') }}">PyDy</a></li>
<li><a href="{{ pathto('download') }}">Download</a></li>
<li><a href="http://pydy.readthedocs.org">Documentation</a></li>
<li><a href="{{ pathto('examples/examples') }}">Examples</a></li>
<li><a href="{{ pathto('documentation') }}">Documentation</a></li>
</ul>
</div>
</header>
Expand Down
2 changes: 1 addition & 1 deletion source/blog/2016/0-3-1-release-announcement.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Today marks the release of PyDy 0.3.1. The release includes 115 commits since
0.3.0 with a number of bug fixes. The `full release notes`_ provide the details
of the changes, all of which are fully backwards compatible with 0.3.0.

.. _full release notes: https://github.com/pydy/pydy#030
.. _full release notes: https://github.com/pydy/pydy#031

Five people contributed code to this release:

Expand Down
45 changes: 45 additions & 0 deletions source/documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
Documentation
=============

General
-------

If you are familiar with `scientific computing <http://scipy.org/>`_ and
`symbolic manipulation <http://sympy.org>`_ with Python you should start with
the SymPy vector/mechanics documentation and the PyDy documentation:

- :doc:`Commands </examples/commands>`
- `Symbolic Vectors [SymPy Docs] <http://docs.sympy.org/latest/modules/physics/vector/index.html>`_
- `Symbolic Dynamics [SymPy Docs] <http://docs.sympy.org/latest/modules/physics/mechanics/index.html>`_
- `PyDy Documentation <http://pydy.readthedocs.org>`_

If you aren't familiar with scientific computing with Python there are many
sources to learn. You can start with the Python programming language itself,
with the canonical source being the `Python Documentation
<https://docs.python.org>`_. The `SciPy Lectures
<http://www.scipy-lectures.org/>`_ are a great intro to scientific computing
with Python. Finally, to learn about how to do symbolic manipulation with
SymPy, check out the `SymPy Documentation <http://docs.sympy.org>`_, especially
the tutorial.

Tutorials
---------

We have a couple of tutorials. The human standing tutorial takes you through an
entire workflow for a dynamics and control problem and is a good place to
start.

- :doc:`Beginner's Tutorial </examples/beginners_tutorial>`
- `Human Balance Tutorial <https://github.com/pydy/pydy-tutorial-human-standing>`_

Examples
--------

There are additionally a variety of examples which can be found here:

- :doc:`Double Pendulum </examples/double_pendulum>`
- :doc:`Chaos Pendulum </examples/chaos_pendulum>`
- `Symbolic Dynamics Examples <http://docs.sympy.org/latest/modules/physics/mechanics/examples.html>`_
- `The PyDy Example Repository <https://github.com/pydy/pydy/tree/master/examples>`_
- `N Link Pendulum <http://www.moorepants.info/blog/npendulum.html>`_ (also in the PyDy example repo)
- `A bicycle model <https://github.com/hazelnusse/bicycle.model>`_
35 changes: 20 additions & 15 deletions source/download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@ https://github.com/pydy/pydy/releases
Extract the archive, on unix systems (Linux, BSD, Mac OS X, Cygwin, etc.) can
be done with the command:

.. code-block:: python
.. code-block:: bash
$ tar xzf pydy-*.tar.gz
or

.. code-block:: python
.. code-block:: bash
$ unzip xzf pydy-*.zip
It can be installed after extracting by running the following command in the
source directory:

.. code-block:: python
.. code-block:: bash
$ python setup.py install
Expand All @@ -33,16 +33,16 @@ in the project's root directory. (You might have to use "sudo" for system wide i
Previous releases
-----------------

You can access all the previous releases from the [[release's
page|https://github.com/pydy/pydy/releases]]. This is useful if the latest
release does not work for you for some reason.
You can access all the previous releases from the `release's page
<https://github.com/pydy/pydy/releases>`_. This is useful if the latest release
does not work for you for some reason.

Development Version
-------------------

To get the git repository, use:

.. code-block:: python
.. code-block:: bash
$ git clone git://github.com/pydy/pydy.git
Expand All @@ -62,31 +62,36 @@ https://pypi.python.org/pypi/pydy

If you have ``pip`` installed, you can install by:

.. code-block:: python
.. code-block:: bash
$ pip install pydy
or, you can manually get the package from PyPi by:

.. code-block:: python
.. code-block:: bash
$ wget https://pypi.python.org/packages/source/p/pydy/pydy-X.X.X.tar.gz
extract and install by:

.. code-block:: python
.. code-block:: bash
$ tar -zxvf pydy-X.X.X.tar.gz
$ cd pydy-0.2.1
$ cd pydy-X.X.X
$ python setup.py install
Binstar
*******
Anaconda
********

Binary packages are hosted at Binstar:
Binary packages are hosted at:

https://binstar.org/pydy/pydy
https://anaconda.org/pydy/pydy

These can be installed with conda::

$ conda install -c pydy pydy

To get all of the dependencies for running the PyDy examples you can install
this metapackage::

$ conda install -c pydy pydy-examples
26 changes: 0 additions & 26 deletions source/examples/examples.rst

This file was deleted.

2 changes: 1 addition & 1 deletion source/gsoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Google Summer of Code
=====================

PyDy exists because of support provided by multiple Google Summers of Code. We
still apply for student positions annual, both as an independent organization
still apply for student positions annually, both as an independent organization
and through other orgs (e.g., SymPy, Python Software Foundation). We maintain a
separate `Wiki on GitHub <https://github.com/pydy/pydy/wiki>`_ for all GSoC
related documents.
Expand Down
12 changes: 6 additions & 6 deletions source/history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ dynamics course at UC Davis (MAE 223, taught by `Dr. Mont Hubbard
<http://mae.ucdavis.edu/faculty/hubbard/hubbard.html>`_ and `Dr. Fedelis Eke
<http://mae.ucdavis.edu/faculty/eke/eke.html>`_). This course teaches Kane's
method for deriving equations of motion, and at that time they also taught
`Autolev <http://www.autolev.com/>`_ (now defunct) in the course. Autolev is
`Autolev <http://www.autolev.com/>`_ (now defunct) in the course. Autolev is
very powerful at symbolic dynamics but lacks important functionality and they
both found themselves wanting a richer set of tools for studying bicycles,
rolling discs, rattlebacks, and other systems that are well described by
Expand All @@ -22,22 +22,22 @@ In Spring of 2007, Dale took `Dr. Jim Crutchfield's
dynamics and chaos, in which all homework was required to be done using Python.
This was a tall order for a single class! This was Dale's favorite course in
graduate school and his first introduction to chaos and to Python (and some of
the chaos of Python). About a year and a half later (December 2008), Dale was
the chaos of Python). About a year and a half later (December 2008), Dale was
tinkering with Python and trying to replicate some of the kinematic
functionality that made Autolev so convenient to use. He got some basic classes
created and contacted `Ondřej Čertík <http://ondrejcertik.com/>`, the creator
of the SymPy project to see if he was interested in helping him get started. He
made a trip up to his apartment one weekend in January of 2009, and before he
knew it, he had a good chunk of the functionality he was looking for. Whcih was
really exciting! Ondřej encouraged Dale to apply to a Google Summer of Code,
knew it, he had a good chunk of the functionality he was looking for. Which was
really exciting! Ondřej encouraged Dale to apply to a Google Summer of Code,
so he did, and he spent the summer of 2009 working on a GSoC project that was a
separate project from SymPy. This was a big learning experience, and one of
separate project from SymPy. This was a big learning experience, and one of
the things that was learned by the end of the summer was that the software
should have been part of the SymPy project, rather than its own standalone
project. This led to Gilbert Gede (another UC Davis graduate student) taking on
a second GSoC project in which he ported the `original PyDy code
<http://code.google.com/p/pydy/>`_ into SymPy as a sub-package
''sympy.physics.mechanics''. This is what is currently is in the SymPy
``sympy.physics.mechanics``. This is what is currently is in the SymPy
repository. The software was introduced to the UC Davis multibody dynamics
course at the beginning of 2012, to replace the aging Autolev. A third GoSC
grant allowed Angadh Nanjangud to add Lagrangian dynamics and many other
Expand Down
5 changes: 3 additions & 2 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ PyDy: Multibody Dynamics with Python

Introduction
------------

Welcome to the PyDy project website. PyDy, short for Python Dynamics, is a both
a *workflow* that utlizes an array of scientific tools written in the Python
programming language to study multibody dynamics and a set of software packages
Expand Down Expand Up @@ -32,7 +33,7 @@ Site Overview
.. toctree::
:titlesonly:

installation/installation_general
examples/examples
download
documentation
history
gsoc
6 changes: 0 additions & 6 deletions source/installation/gnulinuxinstallation.rst

This file was deleted.

36 changes: 0 additions & 36 deletions source/installation/installation_general.rst

This file was deleted.

9 changes: 0 additions & 9 deletions source/installation/macosxinstallation.rst

This file was deleted.

9 changes: 0 additions & 9 deletions source/installation/windowsinstallation.rst

This file was deleted.

0 comments on commit 30c898e

Please sign in to comment.