Porespy manual

[hmuhamme]

Hello everyone,

1. I wonder if the PDF manual of the Porespy library is available!
2. I would appreciate it if there were any documents and tutorials on using the Porespy library other than the main online Porespy documentation on the official website.
3. I would like to use the Porespy library to process and analyse 3D µCT images of soulless substrates (such as peat moss, coco fibre, perlite, etc.).

Best regards
Hadi

[jgostick]

There is no pdf option, sorry. I wouldn't be surprised if there was a webscraping tool that did it though.

The examples tab on the website has examples for using each function but also some tutorials. This is all we have. I wouldn't be surprized if an LLM could spit out some custom examples for you.

Dealing with xCT images is what porespy is for. You will need to use additional tools though like imageio, skimage, numpy etc.

[hmuhamme]

Hello Gostick,
Many thanks for your response.
You are right, the functions are generally explained in the documentation.
I looked up the online documentation. However, I could not find the specific functions used for 3D µCT metadata. The image I use has dimensions in pixels (Depth=1755, Height=434, Width=435). The second problem is that I have four replications for one sample. Simultaneously processing four big images is a challenge.

Best,
Hadi

[jgostick]

It depends on what sort of measurements you want to apply. That size is reasonable for everything except tortuosity_fd. If you want tortuosity of such a big image, then use TauFactor2.

[ma-sadeghi]

You can get sphinx to generate PDF for you, but need to modify conf.py and add these bits:

# Add this for a cleaner LaTeX output
latex_engine = 'pdflatex'  # or 'xelatex' if using Unicode-heavy content

latex_elements = {
    'papersize': 'letter',
    'pointsize': '11pt',
    'preamble': r'''
\usepackage{graphicx}
\usepackage{amsmath}
''',
}

# Optional: set the LaTeX document structure
latex_documents = [
    ('index', 'PoreSpy.tex', 'PoreSpy Documentation',
     'PoreSpy Developers', 'manual'),
]

Then, cd to the docs folder and run make latexpdf. You should be able to find online tutorials on how to do this, here's a YouTube video.

[hmuhamme]

Hello Sadeghi,
I appreciate your clarification. Your code may help me a little bit.
I wonder if you could inform me on how I can simultaneously process four big images, as I have four replications for one sample.
The image has dimensions in pixels (Depth=1755, Height=434, Width=435).
Any suggestions or recommendations are highly appreciated.
I asked Gostick the same question.

Best,
Hadi