Docs not Updated

[umair991]

I am trying to run the master (main.cpp) and the information in the docs does not relate to the current main.cpp. For instance, I want to run the function "CalendarAgeing" as per the doc and I am not able to locate it or call that function. I can see it in the previous version. Should I run that?

[mohammadrezwankhan]

The documentation and the current master branch are out of sync here, but CalendarAgeing has not been removed. It is still declared in src/procedures/degradation.hpp and implemented in src/procedures/degradation.cpp. The current declaration takes five arguments, including verbose:

void CalendarAgeing(const Model_SPM &M,
                    std::string pref,
                    const DEG_ID &degid,
                    int cellType,
                    int verbose);

For the current branch, add a call explicitly in main() after constructing/configuring the same inputs:

slide::Model_SPM M;
slide::DEG_ID deg;

// Select the degradation submodels required for your study.
deg.SEI_id.add_model(2);
deg.SEI_porosity = 0;
deg.CS_id.add_model(0);
deg.CS_diffusion = 0;
deg.LAM_id.add_model(2);
deg.LAM_id.add_model(3);
deg.pl_id = 1;

const int cellType = slide::cellType::KokamNMC;
const int verbose = 1;
slide::CalendarAgeing(M, pref, deg, cellType, verbose);

Use degradation-model IDs appropriate to your experiment; the values above reproduce the model-selection example currently commented in main.cpp. The temperature, storage SOC/voltage cases, duration, check-up interval, and output cadence are configured inside CalendarAgeing in degradation.cpp, so edit those there before launching a long run.

If your purpose is to reproduce the old documentation exactly, use the SLIDE_v2 branch. Current main.cpp explicitly directs users to that branch for the previous interface. For new work, I would stay on master and use the current five-argument call above.