Fix codacy issue and improve documentation index

README.md

@@ -16,7 +16,7 @@ transport models at different spatial and temporal scales to answer specific
 geohydrological questions. Scripting these steps, from downloading data to building
 groundwater models, makes models more reproducible and transparent.
 
-The functions in nlmod have four main objectives:
+The functions in `nlmod` have four main objectives:
 
 1. Create and adapt the temporal and spatial discretization of a MODFLOW model using an xarray Dataset (`nlmod.dims`).
 2. Download and read data from external sources, project this data on the modelgrid and add this data to an xarray Dataset (`nlmod.read`).
@@ -53,7 +53,7 @@ Install the module with pip:
 There are some optional dependecies, only needed (and imported) in a single method.
 Examples of this are `bottleneck` (used in calculate_gxg), `geocube` (used in
 add_min_ahn_to_gdf), `h5netcdf` (used for hdf5 files backend in xarray), `scikit-image`
-(used in calculate_sea). To install the nlmod with the optional dependencies use:
+(used in calculate_sea_coverage). To install `nlmod` with the optional dependencies use:
 
 `pip install nlmod[full]`
 
@@ -71,4 +71,4 @@ executables. You can easily download these executables by running this Python co
 	nlmod.download_mfbinaries()
 
 After you've downloaded the executables you can run the Jupyter Notebooks in the
-examples folder. These notebooks illustrate how to use the nlmod package.
+examples folder. These notebooks illustrate how to use the `nlmod` package.

docs/getting_started.rst

@@ -123,7 +123,7 @@ On top of that there are some optional dependecies:
 - bottleneck (used in calculate_gxg)
 - geocube (used in add_min_ahn_to_gdf)
 - h5netcdf (used for the hdf5 backend of xarray)
-- scikit-image (used in calculate_sea)
+- scikit-image (used in calculate_sea_coverage)
 
 These dependencies are only needed (and imported) in a single method or function.
 They can be installed using ``pip install nlmod[full]`` or ``pip install -e .[full]``.

docs/index.rst

@@ -1,15 +1,16 @@
 nlmod
 =====
 
-.. image:: _static/logo_10000_2.png
-  :width: 400
-  :alt: The logo of nlmod
-
 nlmod is a Python package to build, run and visualize MODFLOW 6 groundwater models in the
 Netherlands. The main focus is on building models in the Netherlands using publicly
 available datasets, though lots of functionality could be applied to groundwater models
 elsewhere.
 
+.. image:: _static/logo_10000_2.png
+  :width: 300
+  :align: center
+  :alt: The logo of nlmod
+
 nlmod relies heavily on the wonderful features of 
 `xarray <https://docs.xarray.dev>`_ and `geopandas <https://geopandas.org>`_ for
 storing and manipulating data and `flopy <https://flopy.readthedocs.io>`_ is used for

nlmod/gwf/surface_water.py

@@ -1069,7 +1069,7 @@ def add_season_timeseries(
         if time > 0:
             ts_data.append((time, 1.0, 0.0))
 
-    package.ts.initialize(
+    return package.ts.initialize(
         filename=filename,
         timeseries=ts_data,
         time_series_namerecord=[winter_name, summer_name],