Improving installation steps & docs

SciNim / flambeau

Nim bindings to libtorch

85 stars 3 forks source link

Improving installation steps & docs #12

Closed Clonkk closed 3 years ago

mratsim commented 3 years ago

I'm encoding rpath in the binary now so LD_LIBRARY_PATH might not be necessary.

Clonkk commented 3 years ago

I was also considering generating a config.nims with the correct passC, passL options at install.

Clonkk commented 3 years ago

reworked the repo structure to organize file a bit with a src/ folder (it's cleaner than having source file on top level).
devops is now in install folder since it's not directly needed for the library
I added before install and before develop, but I'm not sure if it will works (not familiar with nimble hooks).

Next possible step :

Check system dependencies
Install ibrary in /usr/local/lib or ~/.nimble/bin/lib ?

Clonkk commented 3 years ago

@mratsim @HugoGranstrom This is my proposal to make things more oroganized (easier to understand imho). What do you think ?

Clonkk commented 3 years ago

As long as nimble removes the src directory on install this is a no

Forgot nimble had this limitation.

The vendor submodule should be top-level. You are deleting the vendor/vision submodule but not recreating it btw so I don't think it would work as is.

Didn't notice you used a submodule, I'll revert the vendor change. Since they're not merge anymore, I'll move libtorch to install folder

mratsim commented 3 years ago

Is there a reason for the extra vendor/lib instead of putting things in vendor directly? What else would be at the vendor level?

Clonkk commented 3 years ago

No reason anymore since libtorch is now in install/libtorch.

Clonkk commented 3 years ago

If nimble develop is called on the package, then tests should use local modifications. At least it has been my experience so far (but my package had a simpler structure); if it breaks, I'll make a dedicated PR and change it back.