Merge pull request #126 from easyscience/develop

New 2.0.0 release

Author: rozyczko

.github/workflows/codeql-analysis.yml

@@ -27,7 +27,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
       with:
         # We must fetch at least the immediate parents so that if this is
         # a pull request then we can checkout the head.

.github/workflows/documentation-build.yml

@@ -23,16 +23,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@master
+      uses: actions/checkout@5
       with:
         fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
     - name: Upgrade pip
       run: |
         python -m pip install --upgrade pip
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
-        python-version: '3.10'
+        python-version: '3.11'
     - name: Install Pandoc, repo and dependencies
       run: |
         sudo apt install pandoc

.github/workflows/ossar-analysis.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
       # Checkout your code repository to scan
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
       with:
         # We must fetch at least the immediate parents so that if this is
         # a pull request then we can checkout the head.

.github/workflows/python-ci.yml

@@ -18,8 +18,8 @@ jobs:
   Code_Consistency:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: chartboost/ruff-action@v1
+      - uses: actions/checkout@v5
+      - uses: astral-sh/ruff-action@v3
       - name: Suggestion to fix issues
         if: ${{ failure() }}
         run: |
@@ -30,16 +30,16 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: ['3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.11', '3.12', '3.13']
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     runs-on: ${{ matrix.os }}
     if: "!contains(github.event.head_commit.message, '[ci skip]')"
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -67,9 +67,9 @@ jobs:
     if: "!contains(github.event.head_commit.message, '[ci skip]')"
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       with:
         python-version: '3.11'
 

.github/workflows/python-package.yml

@@ -21,13 +21,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.11', '3.12', '3.13']
     if: "!contains(github.event.head_commit.message, '[ci skip]')"
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies and build

.github/workflows/python-publish.yml

@@ -24,11 +24,11 @@ jobs:
       id-token: write
       contents: read
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       with:
-        python-version: '3.10'
+        python-version: '3.11'
 
     - name: Install dependencies and build
       run: |

.github/workflows/release_drafter.yml

@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Drafts your next Release notes as Pull Requests are merged into "master"
-      - uses: release-drafter/release-drafter@v5
+      - uses: release-drafter/release-drafter@v6
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Examples/base/README.rst

@@ -3,4 +3,4 @@
 Subclassing Examples
 ------------------------
 
-This section gathers examples which correspond to subclassing the :class:`easyscience.Objects.Base.BaseObj`  class.
+This section gathers examples which correspond to subclassing the :class:`easyscience.base_classes.ObjBase`  class.

Examples/base/plot_baseclass1.py

@@ -1,8 +1,8 @@
 """
-Subclassing BaseObj - Simple Pendulum
+Subclassing ObjBase - Simple Pendulum
 =====================================
-This  example shows how to subclass :class:`easyscience.Objects.Base.BaseObj` with parameters from
-:class:`EasyScience.Objects.Base.Parameter`. For this example a simple pendulum will be modeled.
+This  example shows how to subclass :class:`easyscience.base_classes.ObjBase` with parameters from
+:class:`EasyScience.variable.Parameter`. For this example a simple pendulum will be modeled.
 
 .. math::
     y = A \sin (2 \pi f t + \phi )
@@ -17,8 +17,8 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-from easyscience.Objects.ObjectClasses import BaseObj
-from easyscience.Objects.ObjectClasses import Parameter
+from easyscience.base_classes import ObjBase
+from easyscience.variable import Parameter
 
 # %%
 # Subclassing
@@ -29,7 +29,7 @@
 # embedded rST text block:
 
 
-class Pendulum(BaseObj):
+class Pendulum(ObjBase):
     def __init__(self, A: Parameter, f: Parameter, p: Parameter):
         super(Pendulum, self).__init__('SimplePendulum', A=A, f=f, p=p)
 
@@ -41,13 +41,13 @@ def from_pars(cls, A: float = 1, f: float = 1, p: float = 0):
         return cls(A, f, p)
 
     def __call__(self, t):
-        return self.A.raw_value * np.sin(2 * np.pi * self.f.raw_value * t + self.p.raw_value)
+        return self.A.value * np.sin(2 * np.pi * self.f.value * t + self.p.value)
 
     def plot(self, time, axis=None, **kwargs):
         if axis is None:
             axis = plt
         else:
-            axis.set_title(f'A={self.A.raw_value}, F={self.f.raw_value}, P={self.p.raw_value}')
+            axis.set_title(f'A={self.A.value}, F={self.f.value}, P={self.p.value}')
         p = axis.plot(time, self(time), **kwargs)
         return p