diff --git a/.travis.yml b/.travis.yml index f9b473a..fc44214 100644 --- a/.travis.yml +++ b/.travis.yml @@ -70,3 +70,13 @@ script: - python mat_eqn.py - python mdf.py - ls +- cd .. + +deploy: + provider: pypi + user: "__token__" + password: "$PYPI_TOKEN" + distributions: "sdist bdist_wheel" + on: + tags: true + skip_existing: true \ No newline at end of file diff --git a/README.md b/README.md index bb7bd58..113b69b 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,17 @@ A python library for generating publication quality PDF XDSM diagrams. This library is a thin wrapper that uses the TikZ library and LaTeX to build the PDFs. # Installation -Clone this repo or download the zip and unzip it. +This package can be installed using - cd pyxdsm - pip install . +```bash +pip install pyxdsm +``` + +Alternatively, clone this repo or download the zip and unzip it. +```bash +cd pyxdsm +pip install . +``` ![XDSM of MDF](https://github.com/mdolab/pyXDSM/blob/master/images_for_readme/mdf.png) diff --git a/pyxdsm/__init__.py b/pyxdsm/__init__.py index afced14..a33997d 100644 --- a/pyxdsm/__init__.py +++ b/pyxdsm/__init__.py @@ -1 +1 @@ -__version__ = '2.0.0' +__version__ = '2.1.0' diff --git a/setup.py b/setup.py index 80aac97..cef52b1 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,4 @@ -from distutils.core import setup +from setuptools import setup import re __version__ = re.findall( @@ -9,15 +9,31 @@ setup(name='pyXDSM', version=__version__, description="Python script to generate PDF XDSM diagrams using TikZ and LaTeX", - long_description="""\ + long_description="""A python library for generating publication quality PDF XDSM diagrams. + This library is a thin wrapper that uses the TikZ library and LaTeX to build the PDFs. + + ## What is XDSM? + The eXtended Design Struture Matrix (XDSM) is a graphical language for describing the movement of data and the execution sequence for a multidisciplinary optimization problem. + You can read the [paper by Lambe and Martins](http://mdolab.engin.umich.edu/content/extensions-design-structure-matrix) for all the details. + If you would like a citation for XDSM, here is the bibtex for that paper: + + @article {Lambe2012, + title = {Extensions to the Design Structure Matrix for the Description of Multidisciplinary Design, Analysis, and Optimization Processes}, + journal = {Structural and Multidisciplinary Optimization}, + volume = {46}, + year = {2012}, + pages = {273-284}, + doi = {10.1007/s00158-012-0763-y}, + author = {Andrew B. Lambe and Joaquim R. R. A. Martins} + } + """, - classifiers=[ - ], + long_description_content_type="text/markdown", keywords='optimization multidisciplinary multi-disciplinary analysis n2 xdsm', author='', author_email='', - url='http://mdolab.engin.umich.edu/', - license='Apache License, Version 2.0', + url='https://github.com/mdolab/pyXDSM', + license='Apache License Version 2.0', packages=[ 'pyxdsm', ], @@ -26,4 +42,9 @@ }, install_requires=[ 'numpy>=1.9.2' - ]) + ], + classifiers=[ + "Operating System :: OS Independent", + "Programming Language :: Python"] + ) +