.. _File-organisation:

Organisation of the files
=========================


📁 ``examples``
---------------

Directory containing example simulations or processings. The example name **helloworld** can be a starting point.


📁 ``prepro``
-------------

Some preprocessing applications.

- 📁 ``confedit``
  Tool for editing configurations.

- 📁 ``converters``
  Conversion applications.

  - 📁 ``stl2shape``
    Converter for STL files to shape format.

  - 📁 ``tess2shape``
    Converter for tessellation files to shape format.
    
  - 📁 ``tif2rockable``
    Converter for TIF files to a format usable for rock simulations.

- 📁 ``genesis``
  Directory for data generation tools.

  - 📁 ``cpptools``
    Tools written in C++ for data generation.

  - 📁 ``SpherePacker``
    Tool for sphere packing.

  - 📁 ``TubePacker``
    Tool for tube packing.

- 📁 ``shapesurvey``
  Tool for shape analysis.



📁 ``src``
----------

Main source directory containing the source code of ``Rockable``.

- 📁 ``Apps``
  Applications of the project: ``rockable`` for computation, ``see`` for visualisation, and other tools.

- 📁 ``BodyForces``
  Classes for body forces.

- 📁 ``Boundaries``
  Classes for boundary conditions.

- 📁 ``Core``
  Core classes of the project.

- 📁 ``DataExtractors``
  Classes for data extraction.

- 📁 ``ForceLaws``
  Classes for force laws.

- 📁 ``PostProcessors``
  Classes for post-processing.

- 📁 ``PreproCommands``
  Classes for preprocessing.

- 📁 ``ProcessingTools``
  Processing tools.

📁 ``test``
-----------

Directory containing non-regression tests for the project. It would be nice to add more tests.