/paper_water_penetration

Code for measuring the penetration behavior of water through paper

Primary LanguageJupyter NotebookMIT LicenseMIT

Paper-Water-Penetration

Code for measuring the penetration behavior of water through paper.

For visualization we use jupiter notebook.

Setup

Requirements

Python >=3.9
Poetry

Download

Download zip and extract files or simply use git clone.

Install

This python repository use poetry for dependency management and packaging.

All the following commands must be executed in the command line.

1. Setup poetry

Execute the following command based on your OS.

For osx / linux / bashonwindows:

curl -sSL https://install.python-poetry.org | python3 -

For Windows powershell:

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

! If you have installed Python through the Microsoft Store, replace py with python in the command above.

2. Setup dependencies

Execute the following command in the working directory.

poetry install # only once to install the project
# everytime you reopen the commandline and goto directory
poetry shell

After install, close and reopen commandline to append poetry install path.

Usage

You can either use the jupyter notebook for visual code presentation or simply execute the batch process.

1. Variant: Run Notebook: 2 Subvariants

  1. Variant
  • Install VS Code.
  • Import project directory.
  • Click on the notebook.ipynb and select our previously installed virtualenv in the top right corner (interpreters).
  1. Variant
  • Open commandline after install process (see steps 1-2).
  • Goto the working directory.
poetry shell
jupyter notebook

See also starting the notebook server

  • Search for your project directory
  • Click on the notebook.ipynb

2. Variant: Commandline usage

  • Goto the working directory.
  • Options can be changes in options.py

Enable project Virtualenv

poetry shell

You can execute the following commands:

  • Execute capturing and data image creation
poetry run script
  • Same as above, but waits on pressed key before capturing
poetry run wait_script
  • Execute capturing only
poetry run capture
  • Same as above, but waits on pressed key before capturing
poetry run wait_capture

Authors

Anne-Marie Kröher
Luisa Schueller
Peter Krutzke
Ralph Mückstein
Coding support by Robert Unger

License

This repository is released under the terms of the MIT license. Full details in LICENSE file.