AskApy directory structure

<INSTALL_DIR>

askapy

bin
This is the place of all AskApky commands.
Put this path in your PATH environment variable.
Note
This directory contains notorious AskApy commands :
ask.py : the absolute client command.
mycl.py : the AskApy client tutorial.
    This is where you start to dig to learn about Apb clients.
view.py : the AskApy Graphical client.

docs
The place of this documentation.

lib
Here are stored the AskApy libraries.
Note
There is a special library at: lib\apy\gui\uiun\widgets, where the visual plugins,
(also known as compar files) are stored and expanded.

temp
The temporary directory where the AskApy's example dump their outputs.

families
This directory stores all the AskApy families and likely all the AskApy families present on this computer.

conf
This is the required place for the AskApy families's configurations files.
There is one sub directory by family.

child0
This is the specific configuration directory for the family child0.
It contains the default preference file (preference.attrs) for the family child0.
If another preference.attrs is found in one child's configuration directory the previous will be skipped for the favor of this new one.
There is one sub directory by child.

apbs
The common apb directory.
This directory contains the Apbs packages (also known as cubes of car files) shared all over the child of the family.
By default AskApy comes with two cubes: askapy.car and mycub.car.
askapy.car : is the AskApy system cube.
mycub.car : is a demo cube with a lot of examples to explore and test all AskApy facets. This is where you start to dig to learn about Apbs.

child0
This is the specific configuration directory for the child child0.
This directory either contains a child specific preference file (preferences.attrs) or not.

child10
This is the specific configuration directory for the child child10.

apbs
The child10's specific apbs directory.
This directory contains the cubes (Apbs packages) you want to be only viewable by this child.
Note
All cubes here are always duplicated and expanded in the apbs directory of the child work directory if not present.

... (more childs)

... (more familes)

work
This is the optional place for the AskApy families's work files.
Another work directory can be stipulated in the preference file (preference.attrs).
There is one sub directory by family.
Note
The work directory and the child work directory are created at the child startup according to its preference specifications.
So it do not have to preexiste before starting a child and could be destroyed has long has there is no child running.

child0
This is the specific work directory for the family child0.
There is one sub directory by child.

child0
This is the specific work directory for the child child0.

child10
This is the specific work directory for the child child10.

apbs
The child10 specific apbs directory.
All cubes here are always duplicated and expanded from the __apbs__ directory of the child configuration directory if not already present.
By this mechanism your are free to modify as you want your cubes here, until they reach their state of readyness,
and at this time deploy them for good in the __apbs__ directory of the child configuration directory.

... (more childs)

... (more familes)

---