Make a package

Author: Amund211

README.md

@@ -15,7 +15,7 @@ Alternatively you may remove it as a dependency, as it isn't used explicitly, bu
 Do note that during testing I had some issues with memory usage using the default solvers from scipy, while the umfpack solvers didn't seem to have that issue.
 
 ## Configuring the project
-[`settings.py`](./settings.py) contains some variables that are read by the rest of the project that may be changed to alter the behaviour of the code.
+[`numdiff/settings.py`](./numdiff/settings.py) contains some variables that are read by the rest of the project that may be changed to alter the behaviour of the code.
 These are documented in the file itself.
 The most important of these may be `FINE_PARAMETERS` which toggles whether the tasks will use parameters that are easy to run (< 1 min), or that give the most detailed plots (>> 5 min).
 

main.py

@@ -11,7 +11,7 @@
 
 import matplotlib.pyplot as plt
 
-from settings import IMAGES_FOLDER, TASK_KWARGS, USE_MULTIPROCESSING
+from numdiff.settings import IMAGES_FOLDER, TASK_KWARGS, USE_MULTIPROCESSING
 from tasks.advection_diffusion import (
     task_6_solution,
     task_6b_asymptotic,

numdiff/__init__.py

@@ -1,8 +1,8 @@
 import numpy as np
 import scipy.sparse.linalg
 
-from cache import cache, cached_property
-from helpers import central_difference
+from .cache import cache, cached_property
+from .helpers import central_difference
 
 
 class Equation:

cache.py renamed to numdiff/cache.py

@@ -1,13 +1,13 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-from conditions import Dirichlet, Neumann
-from equations import HeatEquation, InviscidBurgers, InviscidBurgers2, PeriodicKdV
-from plotting import solve_and_plot
-from poisson import amr, poisson
-from refine import refine_mesh
-from refinement_utilities import calculate_relative_l2_error, make_scheme_solver
-from schemes import RK4, Euler, ThetaMethod
+from .conditions import Dirichlet, Neumann
+from .equations import HeatEquation, InviscidBurgers, InviscidBurgers2, PeriodicKdV
+from .plotting import solve_and_plot
+from .poisson import amr, poisson
+from .refine import refine_mesh
+from .refinement_utilities import calculate_relative_l2_error, make_scheme_solver
+from .schemes import RK4, Euler, ThetaMethod
 
 
 class HeatEuler(Euler, HeatEquation):

conditions.py renamed to numdiff/conditions.py

@@ -2,8 +2,8 @@
 import scipy.sparse.linalg
 from scipy.interpolate import interp1d
 
-from integrate import composite, integrate
-from refine import refine_after
+from .integrate import composite, integrate
+from .refine import refine_after
 
 
 def phi_up(i, x, x_axis):

equations.py renamed to numdiff/equations.py

@@ -1,7 +1,7 @@
 import numpy as np
 import scipy.sparse
 
-from integrate import composite
+from .integrate import composite
 
 
 def central_difference(N, power=2, format="lil"):

examples.py renamed to numdiff/examples.py

@@ -1,6 +1,6 @@
 from numpy.polynomial.legendre import leggauss
 
-from cache import cache
+from .cache import cache
 
 
 @cache

fem.py renamed to numdiff/fem.py

@@ -1,6 +1,6 @@
 from scipy.interpolate import BPoly, CubicSpline
 
-from nonuniform import has_uniform_steps, liu_coefficients
+from .nonuniform import has_uniform_steps, liu_coefficients
 
 
 def interpolate(x, y, calculate_derivatives=None, bc_type="not-a-knot"):

helpers.py renamed to numdiff/helpers.py

@@ -3,12 +3,12 @@
 import numpy as np
 import scipy.sparse.linalg
 
-from conditions import Neumann
-from helpers import central_difference
-from integrate import integrate
-from interpolate import calculate_poisson_derivatives, interpolate
-from nonuniform import has_uniform_steps, liu_coefficients
-from refine import refine_after, select_max
+from .conditions import Neumann
+from .helpers import central_difference
+from .integrate import integrate
+from .interpolate import calculate_poisson_derivatives, interpolate
+from .nonuniform import has_uniform_steps, liu_coefficients
+from .refine import refine_after, select_max
 
 # https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.lsmr.html
 explain_istop = {

integrate.py renamed to numdiff/integrate.py

@@ -3,7 +3,7 @@
 
 import numpy as np
 
-from settings import INFO_PRINTING
+from .settings import INFO_PRINTING
 
 
 def refine_after(x, indicies):

interpolate.py renamed to numdiff/interpolate.py

@@ -3,11 +3,11 @@
 import numpy as np
 from scipy.interpolate import interp1d
 
-from fem import FEM_uniform
-from helpers import relative_l2_error, relative_L2_error
-from interpolate import calculate_poisson_derivatives, interpolate
-from laplace import laplace
-from poisson import amr, poisson
+from .fem import FEM_uniform
+from .helpers import relative_l2_error, relative_L2_error
+from .interpolate import calculate_poisson_derivatives, interpolate
+from .laplace import laplace
+from .poisson import amr, poisson
 
 
 def calculate_relative_l2_error(x, analytical, numerical):

laplace.py renamed to numdiff/laplace.py

@@ -2,8 +2,8 @@
 import scipy.sparse.linalg
 from scipy.sparse import eye as sparse_eye
 
-from cache import cache
-from ring_2d import Ring2D
+from .cache import cache
+from .ring_2d import Ring2D
 
 
 class Scheme:

nonuniform.py renamed to numdiff/nonuniform.py

@@ -14,12 +14,14 @@
 
 # Print info when running tasks
 INFO_PRINTING = True
+INFO_PRINTING = False
 
 # Use fine parameters that take longer to run
 FINE_PARAMETERS = False
 
 # Use multiprocessing for running multiple tasks at once
 USE_MULTIPROCESSING = False
+USE_MULTIPROCESSING = True
 
 if INFO_PRINTING and USE_MULTIPROCESSING:
     print(

plotting.py renamed to numdiff/plotting.py

@@ -4,17 +4,17 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-from conditions import Neumann
-from equations import (
+from numdiff.conditions import Neumann
+from numdiff.equations import (
     AdvectionDiffusion2ndOrder,
     PeriodicAdvectionDiffusion1stOrder,
     PeriodicAdvectionDiffusion2ndOrder,
     PeriodicAdvectionDiffusion4thOrder,
 )
-from refine import refine_mesh
-from refinement_utilities import calculate_relative_l2_error, make_scheme_solver
-from schemes import ThetaMethod
-from settings import FINE_PARAMETERS
+from numdiff.refine import refine_mesh
+from numdiff.refinement_utilities import calculate_relative_l2_error, make_scheme_solver
+from numdiff.schemes import ThetaMethod
+from numdiff.settings import FINE_PARAMETERS
 
 
 def task_6_solution():

poisson.py renamed to numdiff/poisson.py

@@ -1,10 +1,10 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-from conditions import Dirichlet
-from equations import InviscidBurgers, InviscidBurgers2
-from schemes import RK4
-from settings import FINE_PARAMETERS
+from numdiff.conditions import Dirichlet
+from numdiff.equations import InviscidBurgers, InviscidBurgers2
+from numdiff.schemes import RK4
+from numdiff.settings import FINE_PARAMETERS
 
 
 class BurgersRK4(RK4, InviscidBurgers):

refine.py renamed to numdiff/refine.py

@@ -3,9 +3,12 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-from fem import AFEM
-from refine import refine_mesh, simple_select_avg, simple_select_max
-from refinement_utilities import calculate_relative_L2_error_FEM, make_FEM_solver
+from numdiff.fem import AFEM
+from numdiff.refine import refine_mesh, simple_select_avg, simple_select_max
+from numdiff.refinement_utilities import (
+    calculate_relative_L2_error_FEM,
+    make_FEM_solver,
+)
 
 
 def _task_5_afem_solution(f, u, a, b, u_text, deg=10, tol=1e-3):

refinement_utilities.py renamed to numdiff/refinement_utilities.py

@@ -4,16 +4,16 @@
 import numpy as np
 from scipy.interpolate import interp1d
 
-from conditions import Neumann
-from equations import HeatEquation
-from refine import refine_mesh
-from refinement_utilities import (
+from numdiff.conditions import Neumann
+from numdiff.equations import HeatEquation
+from numdiff.refine import refine_mesh
+from numdiff.refinement_utilities import (
     calculate_relative_l2_error,
     make_calculate_relative_L2_error,
     make_scheme_solver,
 )
-from schemes import ThetaMethod
-from settings import FINE_PARAMETERS
+from numdiff.schemes import ThetaMethod
+from numdiff.settings import FINE_PARAMETERS
 
 
 class HeatTheta(ThetaMethod, HeatEquation):

ring_2d.py renamed to numdiff/ring_2d.py

@@ -3,12 +3,12 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-from equations import PeriodicKdV
-from helpers import l2
-from refine import refine_mesh
-from refinement_utilities import calculate_relative_l2_error, make_scheme_solver
-from schemes import ThetaMethod
-from settings import FINE_PARAMETERS
+from numdiff.equations import PeriodicKdV
+from numdiff.helpers import l2
+from numdiff.refine import refine_mesh
+from numdiff.refinement_utilities import calculate_relative_l2_error, make_scheme_solver
+from numdiff.schemes import ThetaMethod
+from numdiff.settings import FINE_PARAMETERS
 
 
 class KdVTheta(ThetaMethod, PeriodicKdV):

schemes.py renamed to numdiff/schemes.py

@@ -1,10 +1,13 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-from laplace import analytical, laplace
-from refine import refine_mesh
-from refinement_utilities import calculate_relative_l2_error, make_laplace_solver
-from settings import FINE_PARAMETERS
+from numdiff.laplace import analytical, laplace
+from numdiff.refine import refine_mesh
+from numdiff.refinement_utilities import (
+    calculate_relative_l2_error,
+    make_laplace_solver,
+)
+from numdiff.settings import FINE_PARAMETERS
 
 
 def task_3_solution():

settings.py renamed to numdiff/settings.py

@@ -1,16 +1,16 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-from conditions import Dirichlet, Neumann
-from poisson import poisson
-from refine import refine_mesh, select_avg, select_max
-from refinement_utilities import (
+from numdiff.conditions import Dirichlet, Neumann
+from numdiff.poisson import poisson
+from numdiff.refine import refine_mesh, select_avg, select_max
+from numdiff.refinement_utilities import (
     calculate_relative_l2_error,
     make_amr_poisson_solver,
     make_calculate_relative_L2_error_poisson,
     make_poisson_solver,
 )
-from settings import FINE_PARAMETERS
+from numdiff.settings import FINE_PARAMETERS
 
 
 def poisson_1D_UMR(

tasks/advection_diffusion.py

@@ -4,7 +4,7 @@
 
 import matplotlib.pyplot as plt
 
-from settings import IMAGES_FOLDER
+from numdiff.settings import IMAGES_FOLDER
 
 
 @dataclass