Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.94 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.94 KB

AITW_microstructures

Port of the AITW microstructure generation code from Matlab to Python.

Install

cd <PATH to folder with pyproject.toml>
pip install .

Usage

Progamatically

Example for birch microstructure generation.

from wood_microstructure import BirchMicrostructure, BirchParams

params = BirchParams.from_json('FILE_PATH.json')

for param in params:
    birch = BirchMicrostructure(param)
    birch.generate()

CLI

The installation will make available a wood_ms command line interface.

  • Run wood_ms --help to see the available commands.
  • Run wood_ms generate --help to see all available options for generating microstructures.
  • Run wood_ms generate WOOD_TYPE JSON_FILE to generate a microstructure of type WOOD_TYPE using the parameters in JSON_FILE.
    • WOOD_TYPE can be one of: birch, spruce.
    • JSON_FILE is a path to a json file with the parameters for the microstructure generation.
  • Run wood_ms postproc --help flag to see all available commands for postprocessing.

Example for birch microstructure generation:

wood_ms generate birch examples/example_birch.json

Tab autocompletion

Enabling tab autocompletion https://click.palletsprojects.com/en/stable/shell-completion/

E.G for bash run the command

eval "$(_WOOD_MS_COMPLETE=bash_source wood_ms)"

You can also add it to either ~/.bashrc or, if you are using a virtual environment, to bin/activate of the virtual environment to avoid running the command for every new shell.

NOTE

  • W.R.T the matlab code, saveSlice in the json file can be a list[int] instead of just an int or "all" to work-on/save all slices.
  • Most functions have been optimized to have the loop over the Z slices as the outermost one. Since the Z slices are almost always treated independently, we can than run the loops over only the slices of interest.