Homec4science
Diffusion tamaas (features/materials) Browse

tamaas/python/setup.py.in
cfd58ff41a02features/materials

Last Change
Raw File

setup.py.in
View Options

# -*- mode:python; coding: utf-8 -*-
import setuptools
import shutil
import sysconfig
import os
long_description = """
# Tamaas - A high-performance library for periodic rough surface contact
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3479236.svg)](https://doi.org/10.5281/zenodo.3479236)
[![status](https://joss.theoj.org/papers/86903c51f3c66964eef7776d8aeaf17d/status.svg)](https://joss.theoj.org/papers/86903c51f3c66964eef7776d8aeaf17d)
[![Documentation Status](https://readthedocs.org/projects/tamaas/badge/?version=latest)](https://tamaas.readthedocs.io/en/latest/?badge=latest)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gl/tamaas%2Ftutorials/HEAD)
Tamaas (from تماس meaning “contact” in Arabic and Farsi) is a high-performance
rough-surface periodic contact code based on boundary and volume integral
equations. The clever mathematical formulation of the underlying numerical
methods allows the use of the fast-Fourier Transform, a great help in achieving
peak performance: Tamaas is consistently two orders of magnitude faster (and
lighter) than traditional FEM! Tamaas is aimed at researchers and practitioners
wishing to compute realistic contact solutions for the study of interface
phenomena.
## Disclaimer
This package is intended for ease of installation for Linux platforms, but comes
with NO WARRANTY of compatibility (although it is manylinux2010_x86_64
compliant). If you experience any issue, please install Tamaas from
[source](https://gitlab.com/tamaas/tamaas). We provide a Docker image for
non-Linux systems. Note that the version of Tamaas provided by this package is
not parallel.
This version of Tamaas is statically linked to [FFTW3](http://fftw.org/)
developed by Matteo Frigo and Steven G. Johnson, released under the terms of the
GPL public license ([source code](https://github.com/FFTW/fftw3)).
Tamaas is the result of a science research project. To give proper credit to
Tamaas and the researchers who have developed the numerical methods that it
implements, please cite the [JOSS
paper](https://joss.theoj.org/papers/86903c51f3c66964eef7776d8aeaf17d) and the
appropriate references therein.
## Dependencies
Essentials:
- Numpy
Optional:
- Scipy (for non-linear solvers)
- UVW (for dumpers)
- h5py (for dumpers)
- netCDF4 (for dumpers)
To install with all dependencies, run ``pip install tamaas[all]``.
## Documentation
Documentation can be found on
[tamaas.readthedocs.io](https://tamaas.readthedocs.io/en/latest/).
## Changelog
The changelog can be consulted
[here](https://gitlab.com/tamaas/tamaas/-/blob/master/CHANGELOG.md).
"""
try:
shutil.copyfile('../../README.md', 'README.md')
except FileNotFoundError:
pass
setuptools.setup(
name="tamaas",
version="@version@",
packages=setuptools.find_packages(),
include_package_data=True,
author=', '.join(@authors@),
author_email="@email@",
description='@description@',
long_description=long_description,
long_description_content_type="text/markdown",
url="https://gitlab.com/tamaas",
project_urls={
"Bug Tracker": "https://gitlab.com/tamaas/tamaas/-/issues",
"Documentation": "https://tamaas.readthedocs.io/en/latest/",
"Source Code": "https://gitlab.com/tamaas/tamaas",
},
platforms=['Linux'],
install_requires=['numpy'],
entry_points={
"console_scripts": ['tamaas = tamaas.__main__:main'],
},
extras_require={
"all": ['uvw', 'h5py', 'netCDF4', 'scipy', 'mpi4py'],
"dumpers": ['uvw', 'h5py', 'netCDF4'],
"solvers": ['scipy'],
"mpi": ['mpi4py'],
},
classifiers=[
"Intended Audience :: Science/Research",
"License :: OSI Approved :: GNU Affero General Public License v3",
"Programming Language :: C++",
"Programming Language :: Python :: 3",
"Topic :: Scientific/Engineering",
"Intended Audience :: Science/Research",
"Operating System :: POSIX :: Linux",
]
)
c4science · Help