Missing user manual and comprehensive function documentation

[bofruehw]

Dear @manuvarkey,

Thank you for developing and sharing this useful library for earthing system design.
However, the repository is currently missing a comprehensive user manual. Specifically:

• There is no documentation listing all available functions or classes with clear explanations of their purpose and parameters.
• The existing Jupyter notebooks are not sufficient for new users to fully understand how to use the library in their own projects.
• There is no reference guide or API documentation to help users integrate this into larger workflows or understand the full capabilities of the package.
  Would you be so kind as to provide a detailed manual or documentation that includes:
• A complete list of available functions/classes
• Descriptions of each function's parameters and expected data types
• Return values and example outputs
• Guidance on typical workflows or use cases
  This would greatly improve usability and help others benefit from your work.

With appreciation,
bofruehw

[manuvarkey]

Hi, the documentation definitely need updating. I will try to do that when I find time.

In the meanwhile documentation generated from code using python -m pydoc earthing is attached.

Python_ package earthing.pdf