EESD x IBOIS Scanned stones dataset

This repo contains a dataset of several stones' 3d representations acquired by scanning. The dataset is made available for visualisation, filtering and selection through a web application living online at: https://ibois-epfl.github.io/eesd-ibois-scanned-stones-dataset/.

Contributing to this dataset:

Scans post-processing

The following steps come after the post-processing of the stone scans. You should have one or more Rhino files (*.3dm) containing reconstructed point clouds. Each of these reconstructed point clouds should correspond to a stone.

Required software

Rhinoceros 3D, version 7
Iris plugin for Rhinoceros 3D - Download
Cockroach plugin for Rhinoceros 3D
CatalogueExporter plugin for Rhinoceros 3D - Download and instructions
Git - Setup instructions

Overview

The proposed contributing workflow is based on git's meaning you can:

fork this repo,
getting it updated using CatalogueExport command in Rhino
and update it online with a pull request.

If you are familiar with this workflow, you can fork and clone this repo and directly hop to 2. Generating data using CatalogueExport command in Rhino section. Once locally updated, you can make a pull request to save changes to this repo.

1. Fork this repo: Getting a local copy of the catalogue

To update it with new objects, you will need to make a local copy of the catalogue. This copy will be modified when executing the CatalogueExport command from Rhinoceros 3D, adding new objects to it. Your updated local copy of the catalogue can be uploaded back to this repo (meaning it will also be live at https://ibois-epfl.github.io/eesd-ibois-scanned-stones-dataset/).

Make sure you have installed the software listed above and have a GitHub account.
Fork this repo by following instructions at https://github.com/ibois-epfl/eesd-ibois-scanned-stones-dataset/fork
Clone it on your machine:
1. Choose a directory to store the catalogue and open it
2. Right-click in it and select Git Bash Here
3. In the terminal, execute the command (replace your username):
```
git clone https://github.com/YOUR-USERNAME/eesd-ibois-scanned-stones-dataset.git
```
4. If requested, authenticate with your GitHub account

You now have a local copy of the catalogue on your machine.

Optionally, you can see the content of your local copy of the catalogue. For this you need to have Node.js installed. Then, open a terminal at directory's root and execute:

npm install
npm start

Point your browser to http://localhost:5000 to see the Catalogue Explorer web app running locally. You should see the same as: https://ibois-epfl.github.io/eesd-ibois-scanned-stones-dataset/

2. Generating data using `CatalogueExport` command in Rhino

Open your post-processed scan files on Rhino.
In Rhino, run the CatalogueExport command.
When prompted to choose the export directory, navigate to the root of the previously cloned repo.
Upon request select the point clouds to add to the catalogue (mouse drag).
Accept default processing parameters (hit Enter).
If you want to give a label to each stone, select the corresponding option in Rhino's command prompt (click on underlined LabelEachItem in the command prompt to toggle between "label + unique identifier" and "just unique identifier" options).
You are then requested to provide a "DataTree branch" which is the location you want your exported objects to be stored in the catalogue tree. You can either specify a new or an existing branch.
If you chose to label each object at step 8, you will be prompted to provide a label for each stone.
The export process starts.

Repeat the process for each scan file. New items are incrementally added each time you run the CatalogueExport command on the same directory

Optionally, you can see the updated catalogue by running the following command in a terminal at folder's root.

npm start

3. Make a pull request: Upload your updated version of the catalogue

Open the root directory of the catalogue in File Explorer
Right-click in it and select Git Bash Here

In the terminal, execute the following:

git add .
git commit -a -m "catalogue updated"
git push

Make a pull request by following instructions at (replace your username) https://github.com/YOUR-USERNAME/eesd-ibois-scanned-stones-dataset/pull/new/master
IBOIS team accepts the pull request finalising the update
The updated version of the catalogue is live at https://ibois-epfl.github.io/eesd-ibois-scanned-stones-dataset/

4. Keep your forked and local version of the catalogue up-to-date

In case you forked and cloned this repo some time ago, it might be possible that someone else made changes to it. In that case, your forked and cloned versions of this repo are outdated and need to update them before you make changes to it.

To do so :

Go to (replace your username) https://github.com/YOUR-USERNAME/eesd-ibois-scanned-stones-dataset
Click on the Fetch upstream button and select Fetch and merge
Open the root directory of the catalogue in File Explorer
Right-click in it and select Git Bash Here
In the terminal, execute the following:
```
git pull
```
Your local version is up-to-date, you can safely head to 2. Generating data section and add new objects to the catalogue.

9and3/eesd-ibois-scanned-stones-dataset