Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
mcencini authored Oct 6, 2024
1 parent 5dd82a9 commit 0f4bed6
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,18 @@ Features

Installation
------------
PulseClient can be installed via pip:
PulseClient can be installed via pip::

.. code-block:: bash
pip install pulseclient

As an alternative, you can incorporate this library in your Pulseq interpreter code as:
As an alternative, you can incorporate this library in your Pulseq interpreter code as::

.. code-block:: bash
git submodule add -b plugin https://github.com/INFN-MRI/pulseclient.git bin

Development
-----------
If you want to modifiy the PulseClient code base:
If you want to modifiy the PulseClient code base::

.. code-block:: bash
git clone https://github.com/INFN-MRI/pulseclient.git
pip install -e ./pulseclient

Expand All @@ -42,9 +39,8 @@ If not set, the library will search for the configuration file in the default lo

/srv/psd/usr/psd/pulseq/config/pulseclient.ini

The configuration file should contain the following sections:
The configuration file should contain the following sections::

.. code-block:: ini
[settings]
SERVER_IP = 192.168.1.100
SERVER_PORT = 8000
Expand All @@ -63,18 +59,16 @@ by the Pulseq interpreter itself.

Usage
-----
You can run the PulseClient from the command line, providing a simulation flag (``0`` for hardware, ``1`` for simulation, default is ``1``):
You can run the PulseClient from the command line, providing a simulation flag (``0`` for hardware, ``1`` for simulation, default is ``1``)::

.. code-block:: bash
start_client.py [simulate]

Replace ``[simulate]`` with ``1`` for simulation or `0` for hardware mode.

Testing
-------
To run the tests, execute the following command in the terminal:
To run the tests, execute the following command in the terminal::

.. code-block:: bash
python -m unittest discover -s tests

License
Expand Down

0 comments on commit 0f4bed6

Please sign in to comment.