[feature] Python bindings/scripts documentation cleanup

lcpp-org / RustBCA

A free, open-source Binary Collision Approximation (BCA) code for ion-material interactions including sputtering, implantation, and reflection

https://github.com/lcpp-org/RustBCA/wiki

GNU General Public License v3.0

42 stars 15 forks source link

[feature] Python bindings/scripts documentation cleanup #175

Closed drobnyjt closed 2 years ago

drobnyjt commented 2 years ago

Documentation for Python bindings and scripts is poor; this issue will cover rewriting them. Additionally, making the rustbca.py scripts work on systems other than Linux should be done at some point.

Tasks:

[x] Clean up Python bindings documentation
[x] Clean up Python scripts documentation
[x] Add docstrings to Python scripts
[x] Ensure Python scripts work on multiple systems (e.g., Linux, Windows)
[x] Add docstrings to Python bindings (so calling help(simple_bca_py) works)

drobnyjt commented 2 years ago

Issue #174 is related.

drobnyjt commented 2 years ago

All of these are in a much better state. They probably need another pass, but I will open up specific issues for these problems. I am considering deprecating rustbca.py, so the documentation is not complete there.