Commit 31393fed authored by MOMMESSIN Clement's avatar MOMMESSIN Clement

[doc] Fix typos and stuff

parent 06f3c598
......@@ -12,7 +12,7 @@ Decision process.
# Keys Prefix #
Since several Batsim instances can be run at the same time, all the keys
explained in this document must be prefixed by some instance-spefific prefix.
explained in this document must be prefixed by some instance-specific prefix.
At the moment, this prefix is set to the absolute filename of the socket used
in [the Batsim protocol](proto_description.md), followed by a colon ':'.
......
......@@ -56,11 +56,11 @@ The simulation results are in subdirectories:
- out_schedule.csv contains aggregated information about the execution schedule
- out_schedule.trace is the Pajé trace of the execution
These output files can be visualized thanks to [Evalys](https://github.com/oar-team/evalys) or analized individually.
These output files can be visualized thanks to [Evalys](https://github.com/oar-team/evalys) or analyzed individually.
## Visualize results with Evalys
Evalys can be used to display different informations. For example the gantt charts of the two instances:
Evalys can be used to display different information. For example the gantt charts of the two instances:
```{python}
from evalys import *
from evalys.jobset import *
......
......@@ -18,14 +18,14 @@ nix-shell /path/to/datamovepkgs -A batsim_dev
```
This command will open a new Bash shell with all the environment variable set
correctly to find all de dependencies and build batsim.
correctly to find all the dependencies and build batsim.
**NOTE**: You can use `nix-shell --pure` to avoid the conflict with already
installed tools.
**WARNING**: The environment created by the `nix-shell` command is heavily
based on environment variables injected in the provided Bash shell. Do NOT
switch to an other shell (zsh, fish, ...) because environment variableswill not
switch to an other shell (zsh, fish, ...) because environment variables will not
be present and the build will fail.
Then you can configure build batsim with these commands:
......
Batsim Developer Documentation
==============================
Welcome on Batsim's internal documentation !
Welcome to Batsim's internal documentation !
These pages describe the different functions and types used by Batsim.<br/>
If you are more interested about how to use Batsim or how it works,
you should visit [our Github page](https://github.com/oar-team/batsim).
Additionally, you should give a look on
[Batsim's build status](https://travis-ci.org/oar-team/batsim) before chosing
[Batsim's build status](https://travis-ci.org/oar-team/batsim) before choosing
a Batsim version to work with.<br/>
An automatically updated version of the present documentation can be found on
[this page](http://batsim.gforge.inria.fr).
......@@ -6,7 +6,7 @@ profile can be associated to multiple jobs.
Each profile is defined in the workload JSON file in the ``profiles`` section.
The only common field on the profile is the ``type``. Here is a list of all the
profile types supported by Batsim, with an explaination on how they work and how
profile types supported by Batsim, with an explanation on how they work and how
to use it.
**Note**: You can use scientific notation to represent big numbers, e.g.
......@@ -37,7 +37,7 @@ allocated to the job.
- ``cpu``: a vector containing the amount of flops to be compute on
each nodes.
- ``com``: a vector containing the amount of bytes to be transfered between
- ``com``: a vector containing the amount of bytes to be transferred between
nodes. You can see this vector as matrix where host in row is sending to the
host in column. When row equals column it is intranode communication using
local loopback interface.
......@@ -146,7 +146,7 @@ centralized storage tier. The storage tier is represented by one node.
This profile represents an IO transfer between two storage tiers.
### Parameters
- ``nb_bytes``: the amount of bytes to be transfered.
- ``nb_bytes``: the amount of bytes to be transferred.
- ``from``: The name of the storage that send. It will be map to a specific node at the job execution time.
- ``to``: The name of the storage that receive. It will be map to a specific node at the job execution time.
......
......@@ -165,7 +165,7 @@ For now, Batsim **queries** the following requests:
Arguments: a job description, similar to those sent in
[JOB_SUBMITTED](#job_submitted) messages when redis is disabled.
- **data**: a dictionnary of requests.
- **data**: a dictionary of requests.
- **example**:
```json
{
......@@ -265,12 +265,12 @@ metainformation from Batsim to any scheduler at runtime.
- **nb_storage_resources**: the number of storage resources
- **allow_time_sharing**: whether time sharing is enabled or not
- **config**: the Batsim configuration
- **compute_resources**: informations about the compute resources
- **compute_resources**: information about the compute resources
- **id**: unique resource number
- **name**: resource name
- **state**: resource state in {sleeping, idle, computing, switching_on, switching_off}
- **properties**: the properties specified in the SimGrid platform for the corresponding host
- **storage_resources**: informations about the storage resources
- **storage_resources**: information's about the storage resources
- **workloads**: the map of workloads given to Batsim. The key is the unique id of the workload
and the value is the absolute path of the workload.
Note that this unique id prefixes each job (before the ``!``).
......
......@@ -58,7 +58,7 @@ To make it more understandable, here is the command decomposition:
find the platform file and so on: Batsim is running inside docker in the
``/data`` folder.
- ``oarteam/batsim`` image name (you can add a tag to get a specific version like ``oarteam/batsim:1.2.0``
- ``--platfom plt.xml --workload wl.json ...`` add batsim parameters
- ``--platform plt.xml --workload wl.json ...`` add batsim parameters
Then you can run your own scheduler to make the simulation begins.
......
......@@ -128,7 +128,7 @@ This mechanism ensures that scheduler calls are consistent in time:
## What if something happened during the scheduler call?
Please remark that this mechanism implies that schedulers (that wish to take
scheduling time into account) may receive messages from the *past* when they are
called. Indeed, Batsim can send messages whose events occured between the last
called. Indeed, Batsim can send messages whose events occurred between the last
call time (``now`` field of the previous request message sent by Batsim) and the
current one (``now`` field of the current request message).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment