Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.36 KB

installation.md

File metadata and controls

66 lines (45 loc) · 1.36 KB

Installation

EISFitpython requires Python 3.9 or newer. Its runtime dependencies are NumPy, SciPy, Matplotlib, and pandas.

📥 Install from a checkout

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.

🧪 Install test dependencies

python -m pip install -e ".[test]"
pytest

📖 Build the documentation

Install the documentation dependencies declared by the docs extra:

python -m pip install -e ".[docs]"
mkdocs serve

Open the local address printed by MkDocs. To create the deployable static site:

mkdocs build --strict

The generated HTML is written to site/ and is not required at runtime.

🖥️ Non-interactive environments

Plot and report functions call matplotlib.pyplot.show(). On a server or in CI, select the Agg backend before importing Matplotlib:

MPLBACKEND=Agg pytest

On Windows PowerShell, the equivalent is:

$env:MPLBACKEND = "Agg"
pytest

📁 Working-directory advice

Simulation, 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.