Martin-Seysen / mmgroup

Python implementation of the monster group
38 stars 4 forks source link

update README, fix few things in config and requirements #5

Closed dimpase closed 2 years ago

dimpase commented 2 years ago

README now says how to build (on Unix), and it now builds on Linux and macOS.

On Linux everything passes, on macOS some pytest errors.

dimpase commented 2 years ago

actually, using the latest numpy etc, the tests pass on macOS too. One should constrain the version of numpy in requirements, I suppose.

Martin-Seysen commented 2 years ago

Hello Dima, It appears that github does not like some kinds of formatting in README.rst. So I had to put a link into the README. Also, in my Ubuntu version I have to manipulate the enviromnent variables PYTHONPATH and LD_LIBRARY_PATH. Is the section 'Quick installation and test' in the README now ok for you? Can you tell me more about the numpy rquirements?

dimpase commented 2 years ago

oh, it's .rst, not .md, as GitHub normally does? I haven't noticed, sorry.

dimpase commented 2 years ago

On macOS (intel, I don't have acess to Arm) it works for me numpy 1.23.3, but doesn't with 1.20.

dimpase commented 2 years ago

PYTHONPATH and LD_LIBRARY_PATH are not needed in a venv.

cd mmgroup/
python3 -n venv . 
source bin/activate
pip3 install -r requirements.txt
python3 setup.py build_ext --inplace
deactivate # (optional)

should just work on any reasonable Unix system and new enough python3 and packages.

Martin-Seysen commented 2 years ago

So either my Ubuntu system is not reasonable, or I simply have too little exprience with Linux. To make the virtual environment work at all, I had to install: sudo apt install python3.10-venv.

My next question is; Does the command 'cd mmgroup/' switch to the root directory of your Git clone of the mmgroup repository? Then I can build the extensions, but running pytest (inside setup.py or from the shell) fails. Also, I cannot import the mmgroup package when invoking python3 from the shell.

When using my more primitive approch manipulating the environment variables, everything works fine on my system.

dimpase commented 2 years ago

Does the command 'cd mmgroup/' switch to the root directory of your Git clone of the mmgroup repository? yes.

Regarding pytest, could it be that you need the latest numpy on Ubuntu too?

dimpase commented 2 years ago

Also, I cannot import the mmgroup package when invoking python3 from the shell.

for this to work, you need to remain in the venv, i.e. don't run deactivate, or if you did, source bin/activate again.

venv is not Unix specific, it's "pure python", see https://docs.python.org/3/library/venv.html