search

cmt-dtu-energy / MagTense

MagTense - a micromagnetism and magnetostatic framework
http://www.MagTense.org
GNU General Public License v3.0
28 stars 12 forks source link

Python package distribution tools #19

Closed zhucaoxiang closed 2 years ago

zhucaoxiang commented 2 years ago

Hi, thanks for helping me get started with using the code #18 .

I think the documentation in the python folder should be updated. For example, I didn't find ../venv/bin/activate as instructed in https://github.com/cmt-dtu-energy/MagTense/tree/master/python/lib_mag.

I managed to figure out how to install it. I am a fan of installing python packages such that I don't have to modify my PYTHONPATH manually. I made some modifications to the sources, so it can be directly installed using pip or python setup.py install. I am wondering if you like to update it. If so, I can create a pull request. By doing so, this code can also be distributed via PyPi. image

spollok commented 2 years ago

@zhucaoxiang Thank you very much for your comment. Yes, the documentation was a bit outdated in that folder. We have streamlined it now and moved it to the top python folder: https://github.com/cmt-dtu-energy/MagTense/tree/master/python.

The second point is also a very good idea. You are very welcome to create a pull request. We will then update the documentation once again on how to run MagTense with the Python package distributed via PyPi.

zhucaoxiang commented 2 years ago

merged in #20