setup.py for local install\nrefactored vectorspace function into own file in order to test paths

Author: gamdow

.gitignore

@@ -5,3 +5,5 @@ __pycache__/
 /dist/
 /build/
 /docs/_build/
+.DS_Store
+magnics.egg-info/

magnics/__init__.py

@@ -3,4 +3,5 @@
 
 __version__ = '0.1'
 
+from .vectorspace import vectorspace
 import fenics

magnics/vectorspace.py

@@ -0,0 +1,10 @@
+import fenics as fe
+
+def vectorspace(mesh):
+    """setup"""
+    V = fe.VectorFunctionSpace(mesh, "CG", 1, dim=3)
+    v = fe.TestFunction(V)
+    u = fe.TrialFunction(V)
+    m = fe.Function(V)
+    Heff = fe.Function(V)
+    return m, Heff, u, v, V

sandbox/minexample.ipynb

@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 1,
    "metadata": {
     "collapsed": true
    },
@@ -297,7 +297,9 @@
   {
    "cell_type": "code",
    "execution_count": 21,
-   "metadata": {},
+   "metadata": {
+    "collapsed": true
+   },
    "outputs": [],
    "source": [
     "# add quick test\n",
@@ -318,21 +320,21 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 2",
+   "display_name": "Python 3",
    "language": "python",
-   "name": "python2"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
-    "version": 2
+    "version": 3
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython2",
-   "version": "2.7.12"
+   "pygments_lexer": "ipython3",
+   "version": "3.6.1"
   }
  },
  "nbformat": 4,

sandbox/minexample.py

@@ -5,17 +5,7 @@
 import fenics as fe
 import numpy as np
 import matplotlib.pyplot as plt
-
-def setup_vectorspace(mesh):
-    """setup"""
-    V = fe.VectorFunctionSpace(mesh, "CG", 1, dim=3)
-    v = fe.TestFunction(V)
-    u = fe.TrialFunction(V)
-    m = fe.Function(V)
-    Heff = fe.Function(V)
-    return m, Heff, u, v, V
-
-
+import magnics
 
 # Material parameters
 Ms = 8.6e5  # saturation magnetisation (A/m)
@@ -47,7 +37,7 @@ def setup_vectorspace(mesh):
 mesh = fe.BoxMesh(p1, p2, nx, ny, nz)
 
 
-m, Heff, u, v, V = setup_vectorspace(mesh)
+m, Heff, u, v, V = magnics.vectorspace(mesh)
 
 def effective_field(m, volume=None):
     w_Zeeman = - mu0 * Ms * fe.dot(m, H)

setup.py

@@ -0,0 +1,20 @@
+import setuptools
+
+with open("README.rst") as f:
+    readme = f.read()
+
+setuptools.setup(
+    name="magnics",
+    version="0.1",
+    description="Magnics is Python micromagnetics software using FEniCS.",
+    long_description=readme,
+    url="https://github.com/computationalmodelling/magnics",
+    author="Leoni Breth, and Hans Fangohr",
+    author_email="[email protected]",
+    packages=setuptools.find_packages(),
+    classifiers=["Development Status :: 3 - Alpha",
+                 "License :: OSI Approved :: BSD License",
+                 "Topic :: Scientific/Engineering :: Physics",
+                 "Intended Audience :: Science/Research",
+                 "Programming Language :: Python :: 3 :: Only"]
+)