Permeability Calculator for Woven Material

Calculate the permeability of woven materials using ellipsoids. Tailored for the requirements of PuK and developed in Python 3.

Table of Contents

• Dependencies
• Building from Source
• Usage
• License

Dependencies

To see the list of required packages, refer to: Requirements

Building from Source

1. Set up your environment:

   • Use Powershell (Avoid using CMD unless paths in the provided commands are adjusted).
   • install python 3.10 and pip if not installed

2. Clone the repository:

   • git clone https://github.com/emrexcem/sponge_perm
   • cd sponge_perm

3. Create a virtual environment and activate it:

   • python -m venv venv
   • OR & _SPONGE_DIR/.venv/Scripts/Activate.ps1
   • OR source ./venv/bin/activate

4. Install dependencies:

• pip install -r requirements.txt

Usage

Once the dependencies are installed and the environment is set up, run:

• python ./source/main.py