ViennaFit

A Python package for fitting ViennaPS simulation models to experimental data.

Installing

Installing into a clean virtual environment is recommended. Does not work with older ViennaPS versions.

# Clone the repository
git clone https://github.com/ViennaTools/ViennaFit
cd Fit

# Install the package and dependencies
pip install .

Requirements (will be installed automatically)

• ViennaPS 3.5.1+
• dlib 19.24.0+
• nevergrad 1.0.12+
• NumPy 1.26.4
• cma 3.2.2
• SALib >= 1.5.1+

Python version

• Python 3.10+

To do:

• Add postprocessing
• Add further optimizers
• Custom range + presets for localSensStudy
• Objective function options
• 3D implementation
• Add custom objective function