Merge pull request #7 from mimesis-inria/sql-dataset

SQL Database

README.md

@@ -1,5 +1,7 @@
 ## DeepPhysX
 
+![logo](docs/source/_static/image/logo.png)
+
 ### Interfacing AI with simulation
 
 The **DeepPhysX** project provides Python packages allowing users to easily interface their **numerical simulations**
@@ -38,34 +40,26 @@ $ pip install DeepPhysX.Sofa        # Install simulation package
 $ pip install DeepPhysX.Torch       # Install AI package
 ```
 
-If cloning sources, create a `DeepPhysX` repository to store every package. 
-Packages must be cloned in a directory with the corresponding name as shown below:
-
-``` bash
-$ mkdir DeepPhysX
-$ cd DeepPhysX
-$ git clone https://github.com/mimesis-inria/DeepPhysX.git Core             # Clone default package
-$ git clone https://github.com/mimesis-inria/DeepPhysX.Sofa.git Sofa        # Clone simulation package
-$ git clone https://github.com/mimesis-inria/DeepPhysX.Torch.git Torch      # Clone AI package
-$ ls
-Core Sofa Torch
-```
-
 
 ### Demos
 
 **DeepPhysX** includes a set of detailed tutorials, examples and demos.
-Following this installation process to directly try the **interactive demos**:
+As these scripts are producing data, they cannot be run in the python site-packages, thus they should be run locally.
+Use the *command line interface* to get the examples or to run **interactive demos**:
 
 ``` bash
-$ mkdir DeepPhysX
-$ cd DeepPhysX
-$ git clone https://github.com/mimesis/deepphysx.git Core   # Make shure to clone this repository in 'DeepPhysX/Core'
-$ cd Core
-$ python3 config.py                                         # Answer 'yes' to install Torch package to launch examples
-$ pip install .
+$ DPX --get             # Get the full example repository locally
+$ DPX --run <demo>      # Run one of the demo scripts
 ```
 
-|     **Armadillo**<br>`python3 demo.py armadillo`      |     **Beam**<br>`python3 demo.py beam`      |     **Liver**<br>`python3 demo.py liver`      |
+|          **Armadillo**<br>`DPX -r armadillo`          |          **Beam**<br>`DPX -r beam`          |          **Liver**<br>`DPX -r liver`          |
 |:-----------------------------------------------------:|:-------------------------------------------:|:---------------------------------------------:|
 | ![armadillo](docs/source/_static/image/armadillo.png) | ![beam](docs/source/_static/image/beam.png) | ![liver](docs/source/_static/image/liver.png) |
+
+
+### References
+
+Did this project help you for your research ? Please cite us as:
+
+R. Enjalbert, A. Odot and S. Cotin, *DeepPhysX, a python framework to interface AI with numerical simulation*, 
+Zenodo, 2022, [**DOI**](https://doi.org/10.5281/zenodo.7389505)

docs/source/api/core.rst

@@ -11,25 +11,22 @@ CORE
       - :doc:`core/environment`
       - :doc:`core/manager`
 
-    * - | :ref:`asyncsocket.abstractenvironment`
-        | :ref:`asyncsocket.bytesconverter`
+    * - | :ref:`asyncsocket.bytesconverter`
         | :ref:`asyncsocket.tcpipclient`
         | :ref:`asyncsocket.tcpipobject`
         | :ref:`asyncsocket.tcpipserver`
 
-      - | :ref:`dataset.basedataset`
-        | :ref:`dataset.basedatasetconfig`
+      - | :ref:`database.databasehandler`
+        | :ref:`database.basedatabaseconfig`
 
       - | :ref:`environment.baseenvironment`
         | :ref:`environment.baseenvironmentconfig`
 
       - | :ref:`manager.datamanager`
-        | :ref:`manager.datasetmanager`
+        | :ref:`manager.databasemanager`
         | :ref:`manager.environmentmanager`
-        | :ref:`manager.manager`
         | :ref:`manager.networkmanager`
         | :ref:`manager.statsmanager`
-        | :ref:`manager.visualizermanager`
 
 
 .. list-table::
@@ -46,15 +43,13 @@ CORE
         | :ref:`network.baseoptimization`
         | :ref:`network.datatransformation`
 
-      - | :ref:`pipelines.basedatagenerator`
+      - | :ref:`pipelines.basedatageneration`
         | :ref:`pipelines.basepipeline`
-        | :ref:`pipelines.baserunner`
-        | :ref:`pipelines.basetrainer`
+        | :ref:`pipelines.baseprediction`
+        | :ref:`pipelines.basetraining`
 
-      - | :ref:`visualizer.vedoobjects`
+      - | :ref:`visualizer.vedofactory`
         | :ref:`visualizer.vedovisualizer`
-        |
-        | :ref:`Visualizer.Factories <factories>`
 
 
 .. toctree::

docs/source/api/core/asyncsocket.rst

@@ -1,14 +1,6 @@
 AsyncSocket
 ===========
 
-.. _asyncsocket.abstractenvironment:
-
-AbstractEnvironment
-___________________
-
-.. autoclass:: AbstractEnvironment.AbstractEnvironment
-    :members:
-
 .. _asyncsocket.bytesconverter:
 
 BytesConverter
@@ -23,7 +15,6 @@ TcpIpClient
 ___________
 
 Bases:
-:py:class:`AbstractEnvironment.AbstractEnvironment`
 :py:class:`TcpIpObject.TcpIpObject`
 
 .. autoclass:: TcpIpClient.TcpIpClient

docs/source/api/core/dataset.rst

@@ -1,18 +1,18 @@
 Dataset
 =======
 
-.. _dataset.basedataset:
+.. _database.databasehandler:
 
-BaseDataset
------------
+DatabaseHandler
+---------------
 
-.. autoclass:: BaseDataset.BaseDataset
+.. autoclass:: DatabaseHandler.DatabaseHandler
     :members:
 
-.. _dataset.basedatasetconfig:
+.. _database.basedatabaseconfig:
 
-BaseDatasetConfig
------------------
+BaseDatabaseConfig
+------------------
 
-.. autoclass:: BaseDatasetConfig.BaseDatasetConfig
+.. autoclass:: BaseDatabaseConfig.BaseDatabaseConfig
     :members:

docs/source/api/core/environment.rst

@@ -6,9 +6,6 @@ Environment
 BaseEnvironment
 ---------------
 
-Bases:
-:py:class:`TcpIpClient.TcpIpClient`
-
 .. autoclass:: BaseEnvironment.BaseEnvironment
     :members: