Renamed package to lilio. Deleted unneeded files

Author: BSchilperoort

.githooks/pre-commit

@@ -17,13 +17,13 @@ fi
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 echo "Starting isort analysis using configuration from setup.cfg..."
 
-# recursively run isort on s2spy/ directory, don't try to automatically fix anything
-isort --recursive --check-only s2spy
+# recursively run isort on lilio/ directory, don't try to automatically fix anything
+isort --recursive --check-only lilio
 
 if [ $? != "0" ]; then
     echo "Commit aborted."
-    echo "  Run 'isort --recursive --check-only --diff s2spy' to see what's wrong."
-    echo "  Run 'isort --recursive s2spy' to let isort fix problems automatically."
+    echo "  Run 'isort --recursive --check-only --diff lilio' to see what's wrong."
+    echo "  Run 'isort --recursive lilio' to let isort fix problems automatically."
     exit 1
 fi
 

.github/workflows/build.yml

@@ -61,4 +61,4 @@ jobs:
       - name: Check style against standards using prospector
         run: prospector
       - name: Check import order
-        run: isort --check-only s2spy --diff
+        run: isort --check-only lilio --diff

CITATION.cff

@@ -1,7 +1,7 @@
 # YAML 1.2
 ---
 cff-version: "1.1.0"
-title: "s2spy"
+title: "lilio"
 authors:
   -
     family-names: Liu
@@ -34,7 +34,7 @@ authors:
 
 date-released: 2022-09-02
 version: "0.2.1"
-repository-code: "https://github.com/AI4S2S/s2spy"
+repository-code: "https://github.com/AI4S2S/lilio"
 keywords:
   - s2s
   - ai

docs/CONTRIBUTING.md

@@ -50,10 +50,10 @@ This section is for maintainers of the package.
 5. Make sure pre-commit hooks are green for all files by running ``pre-commit run --all-files``.
 6. Commit & push changes to GitHub.
 7. Wait for [GitHub
-    actions](https://github.com/AI4S2S/s2spy/actions?query=branch%3Amain+)
+    actions](https://github.com/AI4S2S/lilio/actions?query=branch%3Amain+)
     to be completed and green.
 
-8. Create a [GitHub release](https://github.com/AI4S2S/s2spy/releases/new)
+8. Create a [GitHub release](https://github.com/AI4S2S/lilio/releases/new)
 
     - Use version as title and tag version.
     - As description use intro text from README.md (to give context to
@@ -67,9 +67,9 @@ This section is for maintainers of the package.
 
 10. Verify
 
-    1. Has [new Zenodo record](https://zenodo.org/search?page=1&size=20&q=s2spy) been created?
+    1. Has [new Zenodo record](https://zenodo.org/search?page=1&size=20&q=lilio) been created?
     2. Has [stable](https://ai4s2s.readthedocs.io/en/stable/) ReadTheDocs been updated?
     3. Can new version be installed with pip using
-        `python3 -m pip install s2spy==<new version>`?
+        `python3 -m pip install lilio==<new version>`?
 
 11. Celebrate

docs/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = s2spy
+SPHINXPROJ    = lilio
 SOURCEDIR     = .
 BUILDDIR      = _build
 

docs/conf.py

@@ -17,7 +17,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = u"s2spy"
+project = u"lilio"
 copyright = u"2022, Netherlands eScience Center"
 author = u"Yang Liu"
 
@@ -61,7 +61,7 @@
 
 # -- Use autoapi.extension to run sphinx-apidoc -------
 
-autoapi_dirs = ["../s2spy"]
+autoapi_dirs = ["../lilio"]
 
 # -- Options for HTML output ----------------------------------------------
 

docs/index.rst

@@ -1,4 +1,4 @@
-.. s2spy documentation master file, created by
+.. lilio documentation master file, created by
    sphinx-quickstart on Wed May  5 22:45:36 2021.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.

docs/make.bat

@@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
 )
 set SOURCEDIR=.
 set BUILDDIR=_build
-set SPHINXPROJ=s2spy
+set SPHINXPROJ=lilio
 
 if "%1" == "" goto help
 

s2spy/__init__.py renamed to lilio/__init__.py

@@ -7,14 +7,11 @@
 import logging
 from . import calendar_shifter
 from . import time
-from . import traintest
-from .rgdr.rgdr import RGDR
-
 
 logging.getLogger(__name__).addHandler(logging.NullHandler())
 
 __author__ = "Yang Liu"
 __email__ = "[email protected]"
 __version__ = "0.2.1"
 
-__all__ = ["time", "traintest", "RGDR", "calendar_shifter"]
+__all__ = ["time", "calendar_shifter"]

s2spy/_base_calendar.py renamed to lilio/_base_calendar.py

@@ -8,10 +8,10 @@
 
 
 if TYPE_CHECKING:
-    from s2spy.time import AdventCalendar
-    from s2spy.time import Calendar
-    from s2spy.time import MonthlyCalendar
-    from s2spy.time import WeeklyCalendar
+    from lilio.time import AdventCalendar
+    from lilio.time import Calendar
+    from lilio.time import MonthlyCalendar
+    from lilio.time import WeeklyCalendar
     Calendars = Union[Calendar, AdventCalendar, WeeklyCalendar, MonthlyCalendar]
 
 
@@ -271,15 +271,15 @@ def resample(
         Assuming the input data is pd.DataFrame containing random values with index
         from 2021-11-11 to 2021-11-01 at daily frequency.
 
-        >>> import s2spy.time
+        >>> import lilio.time
         >>> import pandas as pd
         >>> import numpy as np
-        >>> cal = s2spy.time.AdventCalendar(anchor="12-31", freq="180d")
+        >>> cal = lilio.time.AdventCalendar(anchor="12-31", freq="180d")
         >>> time_index = pd.date_range("20191201", "20211231", freq="1d")
         >>> var = np.arange(len(time_index))
         >>> input_data = pd.Series(var, index=time_index)
         >>> cal = cal.map_to_data(input_data)
-        >>> bins = s2spy.time.resample(cal, input_data)
+        >>> bins = lilio.time.resample(cal, input_data)
         >>> bins # doctest: +NORMALIZE_WHITESPACE
             anchor_year  i_interval                  interval   data  target
         0          2019          -1  [2019-07-04, 2019-12-31)   14.5   False

s2spy/_bokeh_plots.py renamed to lilio/_bokeh_plots.py

@@ -3,12 +3,12 @@
 from typing import List
 from typing import Union
 import xarray as xr
-import s2spy.time
+import lilio.time
 from . import utils
 
 
 def _gap_shift(
-    interval: s2spy.time.Interval, shift: Union[str, Dict[str, int]]
+    interval: lilio.time.Interval, shift: Union[str, Dict[str, int]]
 ) -> Dict[str, int]:
     """
     Shift a calendar interval's gap property by the given amount.
@@ -43,8 +43,8 @@ def _gap_shift(
 
 
 def calendar_shifter(
-    calendar: s2spy.time.Calendar, shift: Union[str, dict]
-) -> s2spy.time.Calendar:
+    calendar: lilio.time.Calendar, shift: Union[str, dict]
+) -> lilio.time.Calendar:
     """Shift a Calendar instance by a given time offset.
 
     Instead of shifting the anchor date, this function shifts two things in reference
@@ -57,15 +57,15 @@ def calendar_shifter(
     calendar. This is important for train-test splitting at later stages.
 
     Args:
-        calendar: a s2spy.time.Calendar instance
+        calendar: a lilio.time.Calendar instance
         shift: a pandas-like
             frequency string (e.g. "10d", "2W", or "3M"), or a pandas.DateOffset
             compatible dictionary such as {days=10}, {weeks=2}, or {months=1, weeks=2}
 
     Example:
         Shift a calendar by a given dateoffset.
-        >>> import s2spy.time
-        >>> cal = s2spy.time.Calendar(anchor='07-01')
+        >>> import lilio.time
+        >>> cal = lilio.time.Calendar(anchor='07-01')
         >>> cal.add_intervals("target", "7d")
         >>> cal.add_intervals("precursor", "7d", gap="14d")
         >>> cal.add_intervals("precursor", "7d, n=3)
@@ -92,15 +92,15 @@ def calendar_shifter(
 
 
 def staggered_calendar(
-    calendar: s2spy.time.Calendar, shift: Union[str, dict], n_shifts: int
-) -> List[s2spy.time.Calendar]:
+    calendar: lilio.time.Calendar, shift: Union[str, dict], n_shifts: int
+) -> List[lilio.time.Calendar]:
     """Shift a Calendar instance by a given time offset n times to create a list of
     shifted calendars.
 
     We call this list a staggered calendar.
 
     Args:
-        calendar: an s2spy.time.Calendar instance
+        calendar: an lilio.time.Calendar instance
         shift: a pandas-like
             frequency string (e.g. "10d", "2W", or "3M"), or a pandas.DateOffset
             compatible dictionary such as {days=10}, {weeks=2}, or {months=1, weeks=2}
@@ -109,8 +109,8 @@ def staggered_calendar(
     Example:
         Shift an input calendar n times by a given dateoffset and return a list of these
         shifted calendars.
-        >>> import s2spy.time
-        >>> cal = s2spy.time.Calendar(anchor="07-01")
+        >>> import lilio.time
+        >>> cal = lilio.time.Calendar(anchor="07-01")
         >>> cal.add_intervals("target", "7d")
         >>> cal.add_intervals("precursor", "7d", gap="14d")
         >>> cal.add_intervals("precursor", "7d", n=3)
@@ -171,7 +171,7 @@ def calendar_list_resampler(
     Returns:
         resampled xr.Dataset
     """
-    ds_r = xr.concat([s2spy.time.resample(cal, ds) for cal in cal_list], dim=dim_name)
+    ds_r = xr.concat([lilio.time.resample(cal, ds) for cal in cal_list], dim=dim_name)
     ds_r = ds_r.assign_coords({dim_name: ds_r[dim_name].values})
 
     return ds_r

s2spy/_plot.py renamed to lilio/_plot.py

@@ -1,4 +1,4 @@
-"""s2spy time utils.
+"""lilio time utils.
 
 Utilities designed to aid in seasonal-to-subseasonal prediction experiments in
 which we search for skillful predictors preceding a certain event of interest.
@@ -9,10 +9,10 @@
 between train and test sets.
 
 Example:
-    >>> import s2spy.time
+    >>> import lilio.time
     >>>
     >>> # Countdown the weeks until New Year's Eve
-    >>> calendar = s2spy.time.AdventCalendar(anchor="12-31", freq="7d")
+    >>> calendar = lilio.time.AdventCalendar(anchor="12-31", freq="7d")
     >>> calendar # doctest: +NORMALIZE_WHITESPACE
     AdventCalendar(
         anchor='12-31',
@@ -24,15 +24,15 @@
     )
 
     >>> # Get the 180-day periods leading up to New Year's eve for the year 2020
-    >>> calendar = s2spy.time.AdventCalendar(anchor="12-31", freq="180d")
+    >>> calendar = lilio.time.AdventCalendar(anchor="12-31", freq="180d")
     >>> calendar = calendar.map_years(2020, 2020)
     >>> calendar.show() # doctest: +NORMALIZE_WHITESPACE
     i_interval                         -1                         1
     anchor_year
     2020         [2020-07-04, 2020-12-31)  [2020-12-31, 2021-06-29)
 
     >>> # Get the 180-day periods leading up to New Year's eve for 2020 - 2022 inclusive.
-    >>> calendar = s2spy.time.AdventCalendar(anchor="12-31", freq="180d")
+    >>> calendar = lilio.time.AdventCalendar(anchor="12-31", freq="180d")
     >>> calendar = calendar.map_years(2020, 2022)
     >>> # note the leap year:
     >>> calendar.show() # doctest: +NORMALIZE_WHITESPACE
@@ -124,8 +124,8 @@ def __init__(
             Instantiate a calendar counting down the weeks until new-year's
             eve.
 
-            >>> import s2spy.time
-            >>> calendar = s2spy.time.AdventCalendar(anchor="12-31", freq="7d")
+            >>> import lilio.time
+            >>> calendar = lilio.time.AdventCalendar(anchor="12-31", freq="7d")
             >>> calendar
             AdventCalendar(
                 anchor='12-31',
@@ -271,8 +271,8 @@ def __init__(
             Instantiate a calendar counting down the quarters (3 month periods) from
             december.
 
-            >>> import s2spy.time
-            >>> calendar = s2spy.time.MonthlyCalendar(anchor='Dec', freq="3M")
+            >>> import lilio.time
+            >>> calendar = lilio.time.MonthlyCalendar(anchor='Dec', freq="3M")
             >>> calendar
             MonthlyCalendar(
                 anchor='12',
@@ -393,8 +393,8 @@ def __init__(
         Example:
             Instantiate a calendar counting down the weeks from week number 40.
 
-            >>> import s2spy.time
-            >>> calendar = s2spy.time.WeeklyCalendar(anchor="W40", freq="1W")
+            >>> import lilio.time
+            >>> calendar = lilio.time.WeeklyCalendar(anchor="W40", freq="1W")
             >>> calendar
             WeeklyCalendar(
                 anchor='W40-1',
@@ -484,8 +484,8 @@ def __init__(
         Example:
             Instantiate a custom calendar and appending target/precursor periods.
 
-            >>> import s2spy.time
-            >>> calendar = s2spy.time.CustomCalendar(anchor="12-31")
+            >>> import lilio.time
+            >>> calendar = lilio.time.CustomCalendar(anchor="12-31")
             >>> calendar
             CustomCalendar(
                 anchor='12-31',