diff --git a/README.md b/README.md index a32b8a027b7b2a3eceebc3fde76844f340a5ceef..ab95839a952e0d7db12953d0244153c665bccc66 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ # Solarmod-code -Semi-analytical model for solar modulation in two dimensions. \ No newline at end of file +Semi-analytical model for solar modulation in two dimensions. + +A minimal test script is shown in test.py in python and test.cpp in c++. In +both cases the local interstellar spectrum is loaded from a file, the spectrum +is modulated using the parametrisation presented in arXiv:1909.01154 and given +scale factors g1 and g2 and then write the modulated spectrum to a file.