Merge pull request #991 from compas-dev/move_data

Move data files

Author: gonzalocasas

.gitignore

@@ -127,7 +127,6 @@ src/.build/**
 data/bunny
 data/models
 data/ctralie
-*.ply
 *.tar.gz
 
 data/models

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Fixed symlink expansion for directories relative to the COMPAS installation folder, eg. `compas.DATA` when used from IronPython.
 * Fixed the result of `compas.__version__` on dev installs to properly include git hash.
+* Move `data` files inside the folder included in the source distribution (ie. non-dev installs).
 
 ### Removed
 

MANIFEST.in

@@ -1,9 +1,9 @@
 graft src
 
 prune .github
-prune data
 prune docs
 prune libs
+prune samples
 prune tests
 prune temp
 

samples/README.md

@@ -0,0 +1,6 @@
+This folder contains larger sample files that are not included in the `pip` releases
+to keep the distribution size small. Instead of being copied locally, they are intended
+to be accessed via the raw user content server of Github.
+
+The `compas.get()` function can be used to retrieve the path to them, just like other sample
+files included in the source distribution.

src/compas/__init__.py

@@ -50,13 +50,13 @@
 """str: Path to the location of the compas package."""
 
 HOME = compas._os.absjoin(HERE, '../..')
-"""str: Path to the root of the local repo."""
+"""str: Path to the root of the local installation."""
 
-DATA = compas._os.absjoin(HERE, '../../data')
-"""str: Path to the data folder of the local repo."""
+DATA = compas._os.absjoin(HERE, 'data', 'samples')
+"""str: Path to the data folder of the local installation."""
 
 TEMP = compas._os.absjoin(HERE, '../../temp')
-"""str: Path to the temp folder of the local repo."""
+"""str: Path to the temp folder of the local installation."""
 
 APPDATA = compas._os.user_data_dir('COMPAS', 'compas-dev', roaming=True)
 """str: Path to the COMPAS directory in APPDATA."""
@@ -172,27 +172,19 @@ def get(filename):
     ----------
     filename : str
         The name of the data file.
-        The following are available.
-
-        * boxes.obj
-        * faces.obj
-        * fink.obj
-        * hypar.obj
-        * lines.obj
-        * saddle.obj
 
     Returns
     -------
     str
         The full path to the specified file.
+        The path can be local or remote depending on availability.
 
     Notes
     -----
     The file name should be specified relative to the **COMPAS** sample data folder.
-    This folder is only locally available if you installed **COMPAS** from source,
-    or if you are working directly with the source.
-    In all other cases, the function will get the corresponding files directly from
-    the GitHub repo, at https://raw.githubusercontent.com/compas-dev/compas/main/data
+    If the requested file is not locally available in the sample data folder,
+    the function will get the corresponding file path from
+    the GitHub repo, at https://raw.githubusercontent.com/compas-dev/compas/main/samples
 
     Examples
     --------
@@ -217,7 +209,7 @@ def get(filename):
     if os.path.exists(localpath):
         return localpath
     else:
-        return "https://github.com/compas-dev/compas/raw/main/data/{}".format(filename)
+        return "https://github.com/compas-dev/compas/raw/main/samples/{}".format(filename)
 
 
 def get_bunny(localstorage=None):

data/boxes.obj renamed to src/compas/data/samples/boxes.obj

@@ -1,16 +1,16 @@
-OFF
-8 6 24
-0 0 0
-0 0 1
-0 1 0
-0 1 1
-1 0 0
-1 0 1
-1 1 0
-1 1 1
-4 0 1 3 2
-4 2 3 7 6
-4 4 6 7 5
-4 0 4 5 1
-4 1 5 7 3
-4 0 2 6 4
+OFF
+8 6 24
+0 0 0
+0 0 1
+0 1 0
+0 1 1
+1 0 0
+1 0 1
+1 1 0
+1 1 1
+4 0 1 3 2
+4 2 3 7 6
+4 4 6 7 5
+4 0 4 5 1
+4 1 5 7 3
+4 0 2 6 4