use setup (#5)

* use setup * bump version numbers * Update index.rst Co-authored-by: Neil Wu <[email protected]>
mdolab · Jun 16, 2020 · c8401b2 · c8401b2
1 parent 3da8608
commit c8401b2
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 0 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -14,6 +14,12 @@ Contents:
 ``multiPointSparse`` is a helper module for doing multipoint
 optimizations. The documentaion ``multiPoint`` is given below.
 
+To install, first clone the repo, then go into the root directory and type::
+
+   pip install .
+
+For stability we recommend cloning or checking out a tagged release.
+
 
 .. toctree::
    :maxdepth: 2

diff --git a/__init__.py → multipoint/__init__.py b/__init__.py → multipoint/__init__.py
@@ -1,3 +1,6 @@
+__version__ = '1.2.0'
+
+
 from .multiPoint import multiPoint
 from .multiPointSparse import multiPointSparse
 from .multiPointSparse import createGroups

diff --git a/multiPoint.py → multipoint/multiPoint.py b/multiPoint.py → multipoint/multiPoint.py
diff --git a/multiPointSparse.py → multipoint/multiPointSparse.py b/multiPointSparse.py → multipoint/multiPointSparse.py
diff --git a/testMP.py → multipoint/testMP.py b/testMP.py → multipoint/testMP.py
diff --git a/setup.py b/setup.py
@@ -0,0 +1,35 @@
+from setuptools import setup
+import re
+
+__version__ = re.findall(
+    r"""__version__ = ["']+([0-9\.]*)["']+""",
+    open('multipoint/__init__.py').read(),
+)[0]
+
+setup(name='multipoint',
+      version=__version__,
+
+
+      description="Provides utilities to facilitates distributed multipoint optimization with the MACH framework.",
+      long_description="""Please see the [documentation](https://mdolab-multipoint.readthedocs-hosted.com) for API documentation.
+
+      To locally build the documentation, enter the `doc` folder and enter `make html` in terminal.
+      You can then view the built documentation in the `_build` folder.
+      """,
+      long_description_content_type="text/markdown",
+      keywords='multi-point optimization',
+      author='',
+      author_email='',
+      url='https://github.com/mdolab/multipoint',
+      license='Apache License Version 2.0',
+      packages=[
+          'multipoint',
+      ],
+      install_requires=[
+            'numpy>=1.16.4',
+            'mpi4py>=3.0.2'
+      ],
+      classifiers=[
+        "Operating System :: OS Independent",
+        "Programming Language :: Python"]
+      )
diff --git a/testMPSparse.py → tests/testMPSparse.py b/testMPSparse.py → tests/testMPSparse.py