Merge pull request #132 from pybamm-team/camel-case

change class names to camelcase

Author: TomTranter

.gitignore

@@ -104,5 +104,8 @@ ENV/
 env.bak/
 venv.bak/
 
+# Dask files
+dask-worker-space/
+
 # Generated documentation directory
 site/

examples/drive_cycle_comparison.py

@@ -87,7 +87,7 @@
     t_liionpack -= timestep
     sol_diff = ((v_liionpack.flatten()[1:] - v_pybamm[:-1]) / v_pybamm[:-1]) * 100
 
-    with plt.rc_context(lp.lp_context):
+    with plt.rc_context(lp.lp_context()):
         fig, ((ax0, ax1), (ax2, ax3), (ax4, ax5)) = plt.subplots(
             3, 2, figsize=(12, 10), sharex=True
         )

liionpack/__init__.py

@@ -39,10 +39,10 @@
 from .definitions import ROOT_DIR
 from .definitions import MODULE_DIR
 from .definitions import CIRCUIT_DIR
-from .solvers import casadi_manager
-from .solvers import ray_manager
-from .solvers import dask_manager
-from .solvers import generic_actor
-from .solvers import ray_actor
+from .solvers import CasadiManager
+from .solvers import RayManager
+from .solvers import DaskManager
+from .solvers import GenericActor
+from .solvers import RayActor
 
 __version__ = "0.3"

liionpack/solver_utils.py

@@ -416,13 +416,13 @@ def solve(
         raise Exception("Please supply a netlist, paramater_values, and experiment")
 
     if manager == "casadi":
-        rm = lp.casadi_manager()
+        rm = lp.CasadiManager()
     elif manager == "ray":
-        rm = lp.ray_manager()
+        rm = lp.RayManager()
     elif manager == "dask":
-        rm = lp.dask_manager()
+        rm = lp.DaskManager()
     else:
-        rm = lp.casadi_manager()
+        rm = lp.CasadiManager()
         lp.logger.notice("manager instruction not supported, using default")
 
     output = rm.solve(

liionpack/solvers.py

@@ -15,7 +15,7 @@
 import pybamm
 
 
-class generic_actor:
+class GenericActor:
     def __init__(self):
         pass
 
@@ -121,12 +121,12 @@ def output(self):
 
 
 @ray.remote(num_cpus=1)
-class ray_actor(generic_actor):
+class RayActor(GenericActor):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
 
-class generic_manager:
+class GenericManager:
     def __init__(
         self,
     ):
@@ -504,7 +504,7 @@ def cleanup(self):
         pass
 
 
-class ray_manager(generic_manager):
+class RayManager(GenericManager):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         lp.logger.notice("Ray initialization started")
@@ -526,7 +526,7 @@ def setup_actors(self, nproc, inputs, initial_soc):
         # Ray setup an actor for each worker
         self.actors = []
         for i in range(nproc):
-            self.actors.append(lp.ray_actor.remote())
+            self.actors.append(lp.RayActor.remote())
         setup_futures = []
         for i, a in enumerate(self.actors):
             # Create actor on each worker containing a simulation
@@ -608,7 +608,7 @@ def cleanup(self):
         ray.shutdown()
 
 
-class casadi_manager(generic_manager):
+class CasadiManager(GenericManager):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
@@ -626,7 +626,7 @@ def setup_actors(self, nproc, inputs, initial_soc):
         # the scenes
         tic = ticker.time()
 
-        self.actors = [generic_actor()]
+        self.actors = [GenericActor()]
         for a in self.actors:
             a.setup(
                 Nspm=self.spm_per_worker,
@@ -685,7 +685,7 @@ def cleanup(self):
         pass
 
 
-class dask_manager(generic_manager):
+class DaskManager(GenericManager):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
@@ -708,7 +708,7 @@ def setup_actors(self, nproc, inputs, initial_soc):
         futures = []
         for i in range(nproc):
             # Create actor on each worker containing a simulation
-            futures.append(self.client.submit(generic_actor, actor=True, pure=False))
+            futures.append(self.client.submit(GenericActor, actor=True, pure=False))
         self.actors = [af.result() for af in futures]
         futures = []
         for i, a in enumerate(self.actors):