The default behavior for adding and solving with noisemodels has changed from Pastas 1.5. Find more information here

Fixing parameters while fitting#

Developed by Mark Bakker, TU Delft

Required files to run this notebook (all available from the data subdirectory):

  • Head files: head_nb1.csv

  • Pricipitation files: rain_nb1.csv

  • Evaporation files: evap_nb1.csv

Pastas#

Pastas is a computer program for hydrological time series analysis and is available from the Pastas Github . Pastas makes heavy use of pandas timeseries. An introduction to pandas timeseries can be found, for example, here. The Pastas documentation is available here.

import pandas as pd
import pastas as ps
import matplotlib.pyplot as plt

ps.set_log_level("ERROR")
ps.show_versions()
Python version: 3.11.6
NumPy version: 1.26.4
Pandas version: 2.2.2
SciPy version: 1.13.0
Matplotlib version: 3.8.4
Numba version: 0.59.1
LMfit version: 1.3.1
Latexify version: Not Installed
Pastas version: 1.5.0

Load the head observations#

The first step in time series analysis is to load a time series of head observations. The time series needs to be stored as a pandas.Series object where the index is the date (and time, if desired). pandas provides many options to load time series data, depending on the format of the file that contains the time series. In this example, measured heads are stored in the csv file head_nb1.csv. The heads are read from a csv file with the read_csv function of pandas and are then squeezed to create a pandas Series object. To check if you have the correct data type, use the type command as shown below.

ho = pd.read_csv("data/head_nb1.csv", parse_dates=["date"], index_col="date").squeeze()
print("The data type of the oseries is:", type(ho))
The data type of the oseries is: <class 'pandas.core.series.Series'>

The variable ho is now a pandas Series object. To see the first five lines, type ho.head().

ho.head()
date
1985-11-14    27.61
1985-11-28    27.73
1985-12-14    27.91
1985-12-28    28.13
1986-01-13    28.32
Name: head, dtype: float64

The series can be plotted as follows

ho.plot(style=".", figsize=(12, 4))
plt.ylabel("Head [m]")
plt.xlabel("Time [years]");
../_images/33d864b4adf15b54a0c7d687d4d4c8464243b6c9aa8572322e05d64135488497.png

Load the stresses#

The head variation shown above is believed to be caused by two stresses: rainfall and evaporation. Measured rainfall is stored in the file rain_nb1.csv and measured potential evaporation is stored in the file evap_nb1.csv. The rainfall and potential evaporation are loaded and plotted.

rain = pd.read_csv(
    "data/rain_nb1.csv", parse_dates=["date"], index_col="date"
).squeeze()
print("The data type of the rain series is:", type(rain))

evap = pd.read_csv(
    "data/evap_nb1.csv", parse_dates=["date"], index_col="date"
).squeeze()
print("The data type of the evap series is", type(evap))

plt.figure(figsize=(12, 4))
rain.plot(label="rain")
evap.plot(label="evap")
plt.xlabel("Time [years]")
plt.ylabel("Rainfall/Evaporation (m/d)")
plt.legend(loc="best");
The data type of the rain series is: <class 'pandas.core.series.Series'>
The data type of the evap series is <class 'pandas.core.series.Series'>
../_images/79cb2c4d2080cf6b72433a00bb02445d77333a5df05ca2c0001aff6562a0095e.png

Recharge#

As a first simple model, the recharge is approximated as the measured rainfall minus the measured potential evaporation.

recharge = rain - evap
plt.figure(figsize=(12, 4))
recharge.plot()
plt.xlabel("Time [years]")
plt.ylabel("Recharge (m/d)");
../_images/ff6921a2389cef16d3507bde9fff830d88e7579a3957d0697012f255bfb34b81.png

First time series model#

Once the time series are read from the data files, a time series model can be constructed by going through the following three steps:

  1. Create a Model object by passing it the observed head series. Store your model in a variable so that you can use it later on.

  2. Add the stresses that are expected to cause the observed head variation to the model. In this example, this is only the recharge series. For each stess, a StressModel object needs to be created. Each StressModel object needs three input arguments: the time series of the stress, the response function that is used to simulate the effect of the stress, and a name. In addition, it is recommended to specified the kind of series, which is used to perform a number of checks on the series and fix problems when needed. This checking and fixing of problems (for example, what to substitute for a missing value) depends on the kind of series. In this case, the time series of the stress is stored in the variable recharge, the Gamma function is used to simulate the response, the series will be called 'recharge', and the kind is prec which stands for precipitation. One of the other keyword arguments of the StressModel class is up, which means that a positive stress results in an increase (up) of the head. The default value is True, which we use in this case as a positive recharge will result in the heads going up. Each StressModel object needs to be stored in a variable, after which it can be added to the model.

  3. When everything is added, the model can be solved. The default option is to minimize the sum of the squares of the errors between the observed and modeled heads.

ml = ps.Model(ho)
ml.add_noisemodel(ps.ArNoiseModel())
sm1 = ps.StressModel(recharge, ps.Gamma(), name="recharge", settings="prec")
ml.add_stressmodel(sm1)
ml.solve(tmin="1985", tmax="2010")
Fit report head                   Fit Statistics
================================================
nfev    10                     EVP         92.02
nobs    518                    R2           0.92
noise   True                   RMSE         0.13
tmin    1985-11-14 00:00:00    AICc     -2592.15
tmax    2010-01-01 00:00:00    BIC      -2571.01
freq    D                      Obj          1.70
warmup  3650 days 00:00:00     ___              
solver  LeastSquares           Interp.        No

Parameters (5 optimized)
================================================
                optimal     initial  vary
recharge_A   749.008043  215.674528  True
recharge_n     1.049138    1.000000  True
recharge_a   134.483024   10.000000  True
constant_d    27.547666   27.900078  True
noise_alpha   58.973405   15.000000  True

The solve function has a number of default options that can be specified with keyword arguments. One of these options is that by default a fit report is printed to the screen. The fit report includes a summary of the fitting procedure, the optimal values obtained by the fitting routine, and some basic statistics. The model contains five parameters: the parameters \(A\), \(n\), and \(a\) of the Gamma function used as the response function for the recharge, the parameter \(d\), which is a constant base level, and the parameter \(\alpha\) of the noise model, which will be explained a little later on in this notebook. The results of the model are plotted below.

ml.plot(figsize=(12, 4));
../_images/f074b44661b28e810eec26a02ccac5d97f16ae5ad13e91112c379541a5e6253d.png
ml = ps.Model(ho)
ml.add_noisemodel(ps.ArNoiseModel())
sm1 = ps.StressModel(recharge, ps.Gamma(), name="recharge", settings="prec")
ml.add_stressmodel(sm1)
ml.solve(tmin="1985", tmax="2010", solver=ps.LeastSquares())
Fit report head                   Fit Statistics
================================================
nfev    10                     EVP         92.02
nobs    518                    R2           0.92
noise   True                   RMSE         0.13
tmin    1985-11-14 00:00:00    AICc     -2592.15
tmax    2010-01-01 00:00:00    BIC      -2571.01
freq    D                      Obj          1.70
warmup  3650 days 00:00:00     ___              
solver  LeastSquares           Interp.        No

Parameters (5 optimized)
================================================
                optimal     initial  vary
recharge_A   749.008043  215.674528  True
recharge_n     1.049138    1.000000  True
recharge_a   134.483024   10.000000  True
constant_d    27.547666   27.900078  True
noise_alpha   58.973405   15.000000  True

Fixing a parameter#

Now let’s fix the parameter recharge\(_n\) and solve the model again. We can do this by using the Model.set_parameter method and setting vary=False. For the sake of this example, we also fix the parameter to a value of 1.0, such that the Gamma response function becomes an Exponential function.

ml = ps.Model(ho)
ml.add_noisemodel(ps.ArNoiseModel())
sm1 = ps.StressModel(recharge, ps.Gamma(), name="recharge", settings="prec")
ml.add_stressmodel(sm1)
ml.set_parameter("recharge_n", vary=False, initial=1)
ml.solve(tmin="1985", tmax="2010", solver=ps.LeastSquares())
Fit report head                   Fit Statistics
================================================
nfev    22                     EVP         91.52
nobs    518                    R2           0.92
noise   True                   RMSE         0.13
tmin    1985-11-14 00:00:00    AICc     -2584.55
tmax    2010-01-01 00:00:00    BIC      -2567.62
freq    D                      Obj          1.74
warmup  3650 days 00:00:00     ___              
solver  LeastSquares           Interp.        No

Parameters (4 optimized)
================================================
                optimal     initial   vary
recharge_A   776.739330  215.674528   True
recharge_n     1.000000    1.000000  False
recharge_a   153.740246   10.000000   True
constant_d    27.534802   27.900078   True
noise_alpha   64.122503   15.000000   True

In the fit report, you will see that the parameter recharge\(_n\) is now not varied anymore and kept to the value of one.

ml.plot(figsize=(10, 4));
../_images/2c7a5eb723629b38ec8a8131f8263cdcf876377b451dab8d364d0713ebd7e32a.png