Skip to content

Commit

Permalink
docs: Improve english
Browse files Browse the repository at this point in the history
  • Loading branch information
filimarc committed Aug 6, 2024
1 parent 592c20b commit adca741
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/getting-started/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Placement
:lines: 19-24


The :doc:`placement </placement/intro>` blocks is charge to place cells in the partitions using the cell type indications.
The :doc:`placement </placement/intro>` blocks is in charge of placing cells in the partitions using the cell type indications.
You can specify the strategy to use by setting the :guilabel:`strategy` attribute.
Here we use the strategy :guilabel:`ParticlePlacement` that considers the cells as spheres and
bumps them around as repelling particles until there is no overlap between them.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/include_morphos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ connection strategies such as :doc:`VoxelIntersection </connectivity/connection-
.. note::

If there's multiple morphologies per cell type, they'll be assigned randomly, unless you
specify a :ref:`MorphologyDistributor <MorphologiesDistributors>`.
specify a :ref:`MorphologyDistributor <MorphologyDistributors>`.


Recap
Expand Down
2 changes: 1 addition & 1 deletion docs/morphologies/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ Currently unspecified, up to the Storage and MorphologyRepository support to ret
dictionary of available metadata from
:meth:`~.storage.interfaces.MorphologyRepository.get_meta`.

.. _MorphologiesDistributors:
.. _MorphologyDistributors:

Morphology distributors
-----------------------
Expand Down
11 changes: 5 additions & 6 deletions docs/placement/intro.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
==========
Placement
==========
This is the block that fills cells into partitions.
The main object is the PlacementStrategy, a set of instructions for the definition of the positions of each cells in the partition volume.

The BSB offers some strategies out of the box (here is a :doc:`list </placement/placement-strategies>`), or you can implement your own.

The data is stored in :doc:`PlacementSets </placement/placement-set>` per cell type.
This block is responsible for placing cells into partitions. The main object is the PlacementStrategy,
which provides a set of instructions for defining the positions of each cell within the partition volume.
BSB offers several built-in strategies (here is a :doc:`list </placement/placement-strategies>`),
or you can implement your own.
The placement data is stored in :doc:`PlacementSets </placement/placement-set>` for each cell type.
2 changes: 1 addition & 1 deletion docs/placement/placement-strategies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ RandomPlacement

*Class*: :class:`bsb.placement.RandomPlacement <.placement.random.RandomPlacement>`

This class place cells in random postition without caring about overlaps. Here is an example with 10 cells.
This class places cells in random positions without considering overlaps. Below is an example with 10 cells.

.. code-block:: json
Expand Down
19 changes: 11 additions & 8 deletions docs/topology/partitions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,21 @@
Partitions
##########

Partitions contain shape descriptions used for the spatial layout of the network.
Partitions contain shape descriptions used to define the spatial layout of the network.
These descriptions can be represented as layers, meshes and voxelsets.
In BSB are implemented two different kind of partitions: :ref:`layer <layer-partition>` and :ref:`voxel based <voxel-partition>`.
In the BSB the following two partitions are implemented:
* :ref:`Layers <layer-partition>`
* :ref:`Voxelized volumes <voxel-partition>`.

.. _layer-partition:

======
Layers
======

:class:`Layer partition <.topology.partition.Layer>` is a parallelepiped shaped volume.
The size of a layer is defined by the network except for the height, therefore it is needed to
specify the thickness of the layer with the ``thickness`` attribute.
The :class:`Layer partition <.topology.partition.Layer>` represents a parallelepiped-shaped volume.
The size of a layer is defined by the network, except for its height.
Therefore, it is necessary to specify the layer's thickness using the thickness attribute.

.. tab-set-code::

Expand All @@ -29,12 +31,13 @@ specify the thickness of the layer with the ``thickness`` attribute.
}
}
Cortical Model Use Case
Build a stack of layers
-----------------------


Layers can be organized in a pile in order to separate the structure of your network according to the depth.
:ref:`Stack <stack-region>` region is used to pile up your layers, for a three layer system it will be:
Layers can be organized into a stack to structure your network based on depth.
The :ref:`Stack <stack-region>` region is used to arrange layers in this manner.
For a three-layer system, it will be organized as follows:

.. tab-set-code::

Expand Down
8 changes: 4 additions & 4 deletions docs/topology/regions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
Regions
#######

In BSB a regions is a hierarchical container of :doc:`partitions <topology/partitions>`
used to manage different areas of the network.
In BSB, a region is a hierarchical container of :doc:`partitions <topology/partitions>`,
used to manage different areas of the network.

.. _stack-region:

=======================
List of builtin regions
=======================

BSB provide an implemented :class:`stack <.topology.regions.Stack>` type region that
allow to create a pile of partitions.
BSB provides an implemented :class:`stack <.topology.regions.Stack>` type region that
allows you to create a stack of partitions.

0 comments on commit adca741

Please sign in to comment.