test editable too

WISDEM · Jan 17, 2024 · 3fa93cd · 3fa93cd
1 parent 2c46c2c
commit 3fa93cd
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 3 deletions.
diff --git a/.github/workflows/CI_pyFrame3DD.yml b/.github/workflows/CI_pyFrame3DD.yml
@@ -51,6 +51,18 @@ jobs:
             - name: Test run
               run: |
                   '${{ steps.cp.outputs.python-path }}' -m pytest test
+              
+            - name: Editable Pip Install pyFrame3DD
+              env:
+                  CC: '${{ steps.install_cc.outputs.cc }}'
+                  CXX: '${{ steps.install_cc.outputs.cxx }}'
+              run: |
+                  '${{ steps.cp.outputs.python-path }}' -m pip uninstall pyframe3dd
+                  '${{ steps.cp.outputs.python-path }}' -m pip install -e --no-build-isolation .
+
+            - name: Editable Test run
+              run: |
+                  '${{ steps.cp.outputs.python-path }}' -m pytest test
 
 
     build_conda:
@@ -93,13 +105,11 @@ jobs:
               run: |
                   conda install -y compilers
 
-            # Install 
             - name: Debug
               run: |
                   conda list
                   printenv
                     
-            # Install 
             - name: Conda Install pyFrame3DD
               env:
                   MESON_ARGS: ""
@@ -109,4 +119,15 @@ jobs:
             - name: Test run
               run: |
                   python -m pytest test
+                    
+            - name: Editable Conda Install pyFrame3DD
+              env:
+                  MESON_ARGS: ""
+              run: |
+                  python -m pip uninstall pyframe3dd
+                  python -m pip install -e --no-build-isolation . -v
+
+            - name: Editable Test run
+              run: |
+                  python -m pytest test
 
diff --git a/README.md b/README.md
@@ -16,12 +16,25 @@ There is example code that shows usage contained in ``examples/exB.py``.  This f
 
 pyFrame3DD requires a C compiler
 
-## Install
+## Install (as a library)
 
 For detailed installation instructions of WISDEM modules see <https://github.com/WISDEM/WISDEM> or to install pyFrame3DD by itself do:
 
     $ pip install WISDEM-pyFrame3DD
 
+
+## Install (from source)
+
+If you would like to build the project locally from source for easier access to the underlying methods and tests, do:
+
+    $ git clone https://github.com/WISDEM/pyFrame3DD.git
+    $ cd pyFrame3DD
+    $ pip install .
+
+If developer/editable mode, do the same `git clone` step, but on install do:
+
+    $ pip install -e --no-build-isolation .
+
 ## Unit Tests
 
     $ pytest test

diff --git a/pyframe3dd/pyframe3dd.py b/pyframe3dd/pyframe3dd.py
@@ -31,6 +31,7 @@
 lib_opt = [os.path.join(pyframe3dd_dir, libname), # pip installs (regular and editable)
             os.path.join(os.path.dirname( os.path.dirname( pyframe3dd_dir )), "local", "lib", libname), # WEIS library
             os.path.join(os.path.dirname( sysconfig.get_path('stdlib') ), libname), # conda installs
+            os.path.join(os.path.dirname( sysconfig.get_path('stdlib') ), "pyframe3dd", libname), # conda installs
             os.path.join(os.path.dirname( sysconfig.get_path('stdlib') ), "lib", libname), # conda installs
             os.path.join(os.path.dirname( sysconfig.get_path('stdlib') ), "Library", "lib", libname), # conda installs
             os.path.join( sysconfig.get_path('platlib'), "pyframe3dd", libname), # system-wide pip installs