Skip to content

Commit 96a945c

Browse files
Remove rendering feature.
1 parent d13e40b commit 96a945c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+205
-43044
lines changed

README.md

Lines changed: 25 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -2,79 +2,50 @@
22

33
![logo](docs/src/_static/images/logo.svg)
44

5-
The **SSD** project provides Python3 tools allowing users to easily develop **data storage** and **visualization**
6-
strategies for their **numerical simulations** with a minimal lines of code.
5+
The **SSD** project provides Python3 tools to easily develop a **storage** management system for **any synthetic data**
6+
from **numerical simulations** with a minimal lines of code.
77

8-
This project has two main objectives:
9-
* Easy **storage** management system for **any data** from a numerical simulation;
10-
* Easy **storage** & **rendering** management systems for **visual data** from a numerical simulation.
11-
12-
The **SSD** project is mainly using the [Peewee](http://docs.peewee-orm.com/en/latest/) Python3 library and was mostly
13-
designed to fit the [**DeepPhysX**](https://github.com/mimesis-inria/DeepPhysX) and
14-
[**SOFA**](https://www.sofa-framework.org/) frameworks.
8+
The project is mainly using the [Peewee](http://docs.peewee-orm.com/en/latest/) Python3 library and was mostly designed
9+
to fit the [**DeepPhysX**](https://github.com/mimesis-inria/DeepPhysX) and [**SOFA**](https://www.sofa-framework.org/)
10+
frameworks.
1511

1612
Discover more about the project on the dedicated
1713
[**Documentation**](https://simulationsimpledatabase.readthedocs.io/en/latest/).
1814

15+
16+
## Gallery
17+
18+
| **examples/SOFA/rendering-offscreen/replay.py** |
19+
|:---------------------------------------------------------:|
20+
| ![caduceus](docs/src/_static/images/gallery_caduceus.png) |
21+
22+
| **examples/SOFA/rendering/replay.py** |
23+
|:---------------------------------------------------:|
24+
| ![liver](docs/src/_static/images/gallery_liver.png) |
25+
26+
1927
## Features
2028

21-
The **SSD** project provides the following `Core` packages:
22-
* `SSD.Core.Storage`
29+
The **SSD** project provides the following `Core` features:
2330
* Automatic management of Database file for any data;
2431
* Creation of highly customizable Tables in the Database;
2532
* Easy writing and reading user interface;
2633
* Event management system;
2734
* Tools such as merging and exporting data in other formats.
28-
* `SSD.Core.Rendering`
29-
* Automatic management of Database file for visualization data;
30-
* Live rendering of numerical simulations;
31-
* Replay of stored numerical simulation steps;
32-
* Various object types and highly customizable rendering styles;
33-
* Several Python libraries available: [Vedo](https://vedo.embl.es/), [Open3D](http://www.open3d.org/)
3435

3536
The **SSD** project also provides a `SOFA` compatible package with additional features:
36-
* `SSD.SOFA.Storage`
37-
* Callbacks to automatically record any Data field of SOFA objects.
37+
* Callbacks to automatically record any Data field of SOFA objects;
3838
* Recording can be done whether the simulation is running with *runSofa* or with a *python* interpreter.
39-
* `SSD.SOFA.Rendering`
40-
* Callbacks to automatically record visual Data fields of SOFA objects.
41-
* Recording can be done whether the simulation is running with *runSofa* or with a *python* interpreter.
42-
* Rendering is available when a simulation is driven with a *python* interpreter.
4339

4440

4541
## Install
4642

47-
### Install with pip
48-
49-
The **SSD** project is registered on [PyPi]('https://pypi.org/project/SimulationSimpleDatabase/), thus it can easily
50-
be installed using `pip`:
51-
5243
``` bash
53-
$ pip3 install SimulationSimpleDatabase
54-
```
44+
# Option 1 (USERS): install with pip
45+
$ pip install git+https://github.com/mimesis-inria/SimulationSimpleDatabase.git
5546

56-
### Install from sources
57-
58-
You can also easily install the **SSD** project from sources using the following instructions:
59-
60-
``` bash
61-
$ git clone https://github.com/RobinEnjalbert/SimulationSimpleDatabase.git
62-
$ cd SimpleSimulationDatabase
63-
64-
# Option 1: Install as non-editable (users)
65-
$ pip3 install .
66-
67-
# Option 2: Install as editable (developers)
68-
$ python3 setup_dev.py set
47+
# Option 2 (DEVS): install as editable
48+
$ git clone https://github.com/mimesis-inria/SimulationSimpleDatabase.git
49+
$ cd SimRender
50+
$ pip install -e .
6951
```
70-
71-
72-
## Gallery
73-
74-
| **examples/SOFA/rendering-offscreen/replay.py** |
75-
|:---------------------------------------------------------:|
76-
| ![caduceus](docs/src/_static/images/gallery_caduceus.png) |
77-
78-
| **examples/SOFA/rendering/replay.py** |
79-
|:---------------------------------------------------:|
80-
| ![liver](docs/src/_static/images/gallery_liver.png) |

docs/src/Core/Rendering/api.rst

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)