Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds import linting with ruff #245

Merged
merged 4 commits into from
Mar 21, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Features

- [#245](https://github.com/pybop-team/PyBOP/pull/245) - Updates ruff config for import linting.
- [#179](https://github.com/pybop-team/PyBOP/pull/203) - Adds `asv` configuration for benchmarking and initial benchmark suite.
- [#218](https://github.com/pybop-team/PyBOP/pull/218) - Adds likelihood base class, `GaussianLogLikelihoodKnownSigma`, `GaussianLogLikelihood`, and `ProbabilityBased` cost function. As well as addition of a maximum likelihood estimation (MLE) example.
- [#185](https://github.com/pybop-team/PyBOP/pull/185) - Adds a pull request template, additional nox sessions `quick` for standard tests + docs, `pre-commit` for pre-commit, `test` to run all standard tests, `doctest` for docs.
Expand Down
4 changes: 3 additions & 1 deletion benchmarks/benchmark_model.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import pybop
import numpy as np

import pybop

from .benchmark_utils import set_random_seed


Expand Down
4 changes: 3 additions & 1 deletion benchmarks/benchmark_optim_construction.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import pybop
import numpy as np

import pybop

from .benchmark_utils import set_random_seed


Expand Down
4 changes: 3 additions & 1 deletion benchmarks/benchmark_parameterisation.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import pybop
import numpy as np

import pybop

from .benchmark_utils import set_random_seed


Expand Down
4 changes: 3 additions & 1 deletion benchmarks/benchmark_track_parameterisation.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import pybop
import numpy as np

import pybop

from .benchmark_utils import set_random_seed


Expand Down
2 changes: 1 addition & 1 deletion conftest.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import pytest
import matplotlib
import plotly
import pytest

plotly.io.renderers.default = None
matplotlib.use("Template")
Expand Down
5 changes: 3 additions & 2 deletions examples/notebooks/equivalent_circuit_identification.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@
"metadata": {},
"outputs": [],
"source": [
"import pybop\n",
"import numpy as np"
"import numpy as np\n",
"\n",
"import pybop"
]
},
{
Expand Down
5 changes: 3 additions & 2 deletions examples/notebooks/spm_Adam.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,9 @@
},
"outputs": [],
"source": [
"import pybop\n",
"import numpy as np"
"import numpy as np\n",
"\n",
"import pybop"
]
},
{
Expand Down
5 changes: 3 additions & 2 deletions examples/notebooks/spm_CMAES.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,9 @@
},
"outputs": [],
"source": [
"import pybop\n",
"import numpy as np"
"import numpy as np\n",
"\n",
"import pybop"
]
},
{
Expand Down
5 changes: 3 additions & 2 deletions examples/notebooks/spm_scipy_DifferentialEvolution.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,9 @@
},
"outputs": [],
"source": [
"import pybop\n",
"import numpy as np"
"import numpy as np\n",
"\n",
"import pybop"
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/ecm_CMAES.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop

# Import the ECM parameter set from JSON
params = pybop.ParameterSet(
json_path="examples/scripts/parameters/initial_ecm_parameters.json"
Expand Down
5 changes: 3 additions & 2 deletions examples/scripts/exp_UKF.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import pybamm
import numpy as np
import pybamm

import pybop
from examples.standalone.model import ExponentialDecay

# Parameter set and model definition
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/spm_CMAES.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop

# Define model
parameter_set = pybop.ParameterSet.pybamm("Chen2020")
model = pybop.lithium_ion.SPM(parameter_set=parameter_set)
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/spm_IRPropMin.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop

# Define model
parameter_set = pybop.ParameterSet.pybamm("Chen2020")
model = pybop.lithium_ion.SPM(parameter_set=parameter_set)
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/spm_MLE.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop

# Define model
parameter_set = pybop.ParameterSet.pybamm("Chen2020")
model = pybop.lithium_ion.SPM(parameter_set=parameter_set)
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/spm_SNES.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop

# Define model
parameter_set = pybop.ParameterSet.pybamm("Chen2020")
model = pybop.lithium_ion.SPM(parameter_set=parameter_set)
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/spm_UKF.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop

# Parameter set and model definition
parameter_set = pybop.ParameterSet.pybamm("Chen2020")
model = pybop.lithium_ion.SPM(parameter_set=parameter_set)
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/spm_XNES.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop

# Define model
parameter_set = pybop.ParameterSet.pybamm("Chen2020")
model = pybop.lithium_ion.SPM(parameter_set=parameter_set)
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/spm_adam.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop

# Parameter set and model definition
parameter_set = pybop.ParameterSet.pybamm("Chen2020")
model = pybop.lithium_ion.SPMe(parameter_set=parameter_set)
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/spm_descent.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop

# Parameter set and model definition
parameter_set = pybop.ParameterSet.pybamm("Chen2020")
model = pybop.lithium_ion.SPMe(parameter_set=parameter_set)
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/spm_pso.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop

# Define model
parameter_set = pybop.ParameterSet.pybamm("Chen2020")
model = pybop.lithium_ion.SPM(parameter_set=parameter_set)
Expand Down
3 changes: 2 additions & 1 deletion examples/scripts/spm_scipymin.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import pandas as pd

import pybop

# Form dataset
Measurements = pd.read_csv("examples/scripts/Chen_example.csv", comment="#").to_numpy()
dataset = pybop.Dataset(
Expand Down
1 change: 0 additions & 1 deletion examples/scripts/spme_max_energy.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import pybop


# A design optimisation example loosely based on work by L.D. Couto
# available at https://doi.org/10.1016/j.energy.2022.125966.

Expand Down
3 changes: 2 additions & 1 deletion examples/standalone/cost.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop


class StandaloneCost(pybop.BaseCost):
"""
Expand Down
1 change: 1 addition & 0 deletions examples/standalone/problem.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import numpy as np

from pybop._problem import BaseProblem


Expand Down
2 changes: 1 addition & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import os
import nox

import nox

# nox options
nox.options.reuse_existing_virtualenvs = True
Expand Down
8 changes: 5 additions & 3 deletions pybop/_optimisation.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import pybop
import pints
import numpy as np
import warnings

import numpy as np
import pints

import pybop


class Optimisation:
"""
Expand Down
1 change: 1 addition & 0 deletions pybop/costs/_likelihoods.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import numpy as np

from pybop.costs.base_cost import BaseCost


Expand Down
3 changes: 2 additions & 1 deletion pybop/costs/base_cost.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from pybop import BaseProblem
import numpy as np

from pybop import BaseProblem


class BaseCost:
"""
Expand Down
3 changes: 2 additions & 1 deletion pybop/costs/design_costs.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import numpy as np
import warnings

import numpy as np

from pybop.costs.base_cost import BaseCost


Expand Down
8 changes: 5 additions & 3 deletions pybop/models/base_model.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
from __future__ import annotations

import copy
from dataclasses import dataclass
from typing import Any, Dict, Optional
import pybamm
import copy
import numpy as np

import casadi
import numpy as np
import pybamm

Inputs = Dict[str, float]

Expand Down
1 change: 1 addition & 0 deletions pybop/models/empirical/ecm.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import pybamm

from .ecm_base import ECircuitModel


Expand Down
1 change: 1 addition & 0 deletions pybop/models/lithium_ion/echem.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import pybamm

from .echem_base import EChemBaseModel


Expand Down
1 change: 1 addition & 0 deletions pybop/models/lithium_ion/echem_base.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import warnings

from ..base_model import BaseModel


Expand Down
2 changes: 2 additions & 0 deletions pybop/observers/observer.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
from typing import List, Optional

import numpy as np

from pybop._problem import BaseProblem
from pybop.models.base_model import BaseModel, Inputs, TimeSeriesState
from pybop.parameters.parameter import Parameter
Expand Down
3 changes: 2 additions & 1 deletion pybop/observers/unscented_kalman.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
from dataclasses import dataclass
from typing import List, Tuple, Union

import numpy as np
import scipy.linalg as linalg
from typing import List, Tuple, Union

from pybop.models.base_model import BaseModel, Inputs
from pybop.observers.observer import Observer
Expand Down
2 changes: 1 addition & 1 deletion pybop/optimisers/pints_optimisers.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import pints
import numpy as np
import pints


class GradientDescent(pints.GradientDescent):
Expand Down
5 changes: 3 additions & 2 deletions pybop/optimisers/scipy_optimisers.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from scipy.optimize import minimize, differential_evolution
from .base_optimiser import BaseOptimiser
import numpy as np
from scipy.optimize import differential_evolution, minimize

from .base_optimiser import BaseOptimiser


class SciPyMinimize(BaseOptimiser):
Expand Down
2 changes: 2 additions & 0 deletions pybop/parameters/parameter_set.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import json
import types

import pybamm

import pybop


Expand Down
2 changes: 1 addition & 1 deletion pybop/parameters/priors.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import scipy.stats as stats
import numpy as np
import scipy.stats as stats


class Gaussian:
Expand Down
3 changes: 2 additions & 1 deletion pybop/plotting/plot_convergence.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import numpy as np

import pybop


def plot_convergence(
optim, xaxis_title="Iteration", yaxis_title="Cost", title="Convergence"
Expand Down
3 changes: 2 additions & 1 deletion pybop/plotting/plot_parameters.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import pybop
import math

import pybop


def plot_parameters(
optim, xaxis_titles="Iteration", yaxis_titles=None, title="Convergence"
Expand Down
2 changes: 1 addition & 1 deletion pybop/plotting/plotly_manager.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import subprocess
import webbrowser
import sys
import webbrowser


class PlotlyManager:
Expand Down
4 changes: 3 additions & 1 deletion pybop/plotting/quick_plot.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import numpy as np
import textwrap

import numpy as np

import pybop


Expand Down
Loading
Loading