Fixed installation bug causing Galsim libraies to not be correctly li…#27
Merged
Fixed installation bug causing Galsim libraies to not be correctly li…#27
Conversation
…nked when BATSim is built. Updated readme with conda-preferred installation instructions and added unit test to ensure linkage was successful.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
An unreliable installation route was causing improper linkage of the BATSim C++ layer to the Galsim C++ API. This was casuing BATSim C++ functions not to recognise Galsim's C++ classes when passed through Python.
To address this, I have added a new installation path using Conda which will build and install BATSim and all its dependencies through Conda forge, as the Galsim C++ library file is pre-built in the Conda version and Conda handles the linkage cleaner.
I have also updated the README.md to give more detailed instructions on how to carry out and editable install and what may go wrong in the process.
Finally, I added a unit test to verify the C++ layer is working, so issues can be identified at installation.
The regular install path should now provide a realiably working BATSim. The development install path is a bit more finicky, but hopefully the added details can help users identify what may be causing issues.
I plan to add a pip-only install path in future, but this is more complex as it requires the Galsim C++ library file to be manually built and linked.