Requirements

• Python 3.9+
• pip (Python package manager)

Dependencies

Package	Version	Purpose
numpy	≥1.20	Numerical arrays
matplotlib	≥3.3	Plotting (image monitors)
scipy	≥1.7	Scientific computing
pydantic	≥2.0	Config validation
pyyaml	≥6.0	YAML parsing
tqdm	≥4.0	Progress bar
h5py	≥3.0	HDF5 output
imageio	≥2.0	GIF output

Installation Steps

1. Clone the Repository

git clone https://github.com/marzialetech/intsharp.git
cd intsharp

2. Create a Virtual Environment (Recommended)

python -m venv .venv
source .venv/bin/activate   # Linux/macOS
# or
.venv\Scripts\activate      # Windows

3. Install Dependencies

pip install -r requirements.txt

Or using the Makefile:

make install

4. Verify Installation

python -c "import intsharp; print('intsharp ready')"

Running Your First Simulation

python run.py unit_tests/tanh_hat_10_rev_compare.yaml

This runs a 1D comparison test (no sharpening vs PM over 5 revolutions) and produces overlay and individual GIFs in a timestamped folder.

Makefile Targets

Target	Description
make install	Install dependencies from requirements.txt
make run CONFIG=path/to/config.yaml	Run a simulation with specified config