About#

Installation#

1) Downloading#

The source code repository can be downloaded from GitHub or cloned using Git:

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

You can also:

- Visit the source code page

- Click here to start downloading the source code for the latest commit

- Check the released versions

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.

3) Testing#

TODO, you might be able to use the libraries as explained here.

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:

Copyright (c) 2012-2023 Saullo G. P. Castro

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

  a. Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
  b. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.
  c. Neither the name of CompMech nor the names of its contributors
     may be used to endorse or promote products derived from this software
     without specific prior written permission.


THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.