Read this before submitting a new question

[ma-sadeghi]

The PMEAL team is very small (like 1 professor and 1-2 graduate students) and we all have many time-consuming obligations outside of PoreSpy and OpenPNM. Properly maintaining (i.e. bug fixes) and developing (i.e. new algorithms) is already quite challenging in the time we have available. Providing technical support to users is really more than we can manage.

On the other hand, we are very glad that so many people use our packages to accelerate their research and make the world a better place. So we have been thinking of ways to provide users with help while not overload ourselves, and we have two plans:

Firstly, we have created an "FAQ" category on the discussions tab. There are many questions that get asked repeatedly in various forms, and there is often a preexisting example in the docs. We will be populating this FAQ category with answers that point to relevant examples or documentation.

Secondly, thanks to the recent advancements in the machine learning world, most basic questions (even some OpenPNM/PoreSpy-specific ones) can be answered by large language models (e.g., ChatGPT). We urge you to ask ChatGPT your question, and if you're not satisfied with the answer, then post your question here.

To get the best out of ChatGPT, it is necessary to "prompt" it so it has an idea of the subject you're interested in. Use the following prompt:

---

The following is a question a user has asked on the GitHub Discussions forum for the Python package OpenPNM/PoreSpy. Assume you're part of the developer team for these packages, and answer the question to the best of your knowledge. If you need any clarification from the user, ask them so you provide a more refined answer. Here's the question:

<REPLACE THIS TEXT WITH YOUR QUESTION. BE SPECIFIC AND PROVIDE AS MUCH DETAILS AS POSSIBLE. IF YOU'RE GETTING AN ERROR MESSAGE, ALSO INCLUDE THE FULL TRACEBACK. THE MORE YOU PROVIDE, THE MORE CHATGPT CAN ASSIST YOU.>

---

Note that since ChatGPT has memory of past conversations (but in the same session), you can ask follow up questions if you're unsure about part of the answer.

Of course, ChatGPT is not god, and so eventually you might end up posting your question here!