About
=====

Installation
------------

1) Downloading
..............

The source code repository can be downloaded from
`GitHub <https://github.com/compmech/compmech/archive/master.zip>`_
or cloned using `Git <http://git-scm.com/downloads>`_::

    $ git clone https://github.com/compmech/compmech.git

You can also:

`- Visit the source code page <https://github.com/compmech/compmech>`_

`- Click here to start downloading the source code for the latest commit
<https://github.com/compmech/compmech/archive/master.zip>`_

`- Check the released versions
<https://github.com/compmech/compmech/releases>`_


2) Installing
.............

After you have downloaded the selected version or the latest commit from
GitHub, run the setup::

   >>> python setup.py install

.. Note:: You need Cython and a C compiler for this step.

On Windows 64 bit you should use the free Microsoft SDK compiler,
as explained `in this Cython Github thread <https://github.com/cython/cython/wiki/64BitCythonExtensionsOnWindows>`_.


3) Testing
..........

TODO, you might be able to use the libraries
`as explained here
<file:///C:/clones/compmech/doc/build/html/modules/index.html>`_.


Requirements
------------
- NumPy
- SciPy
- MatPlotLib
- (for building only) Cython and a C compiler

Licensing
---------

The new BSD License covers all files in the compmech repository
unless otherwise stated:

.. literalinclude:: ../../LICENSE