EISFitpython requires Python 3.9 or newer. Its runtime dependencies are NumPy, SciPy, Matplotlib, and pandas.
git clone https://github.com/Sheyigold/EISFitpython.git
cd EISFitpython
python -m pip install -e .Verify the import:
python -c "import EISFitpython; print(EISFitpython.__version__)"The expected version for this documentation is 0.5.1.
python -m pip install -e ".[test]"
pytestInstall the documentation dependencies declared by the docs extra:
python -m pip install -e ".[docs]"
mkdocs serveOpen the local address printed by MkDocs. To create the deployable static site:
mkdocs build --strictThe generated HTML is written to site/ and is not required at runtime.
Plot and report functions call matplotlib.pyplot.show(). On a server or in CI,
select the Agg backend before importing Matplotlib:
MPLBACKEND=Agg pytestOn Windows PowerShell, the equivalent is:
$env:MPLBACKEND = "Agg"
pytestSimulation, report, and plotting functions write output files to the process's current working directory. Create and enter a dedicated results directory to keep each run organized.