diff --git a/README.rst b/README.rst index 7a563af..ec44c23 100644 --- a/README.rst +++ b/README.rst @@ -27,7 +27,7 @@ Install .. code:: bash - \$ pip install micromed-io + $ pip install micromed-io Convert a Micromed (*.trc*) file to MNE (*.fif*) format @@ -55,7 +55,7 @@ Emulate Online Micromed TCP from *.trc* file .. code:: bash - \$ mmio_emulate_trc --file=../data/sample.TRC --address=localhost --port=5123 + $ mmio_emulate_trc --file=../data/sample.TRC --address=localhost --port=5123 Emulate the online data stream of Micromed to test your real-time @@ -64,7 +64,7 @@ platform. See all the arguments and adapt them: .. code:: bash - \$ mmio_emulate_trc --help # to see all arguments + $ mmio_emulate_trc --help # to see all arguments .. note:: @@ -77,7 +77,7 @@ Read TCP and push to LSL Stream .. code:: bash - \$ mmio_tcp_to_lsl --address=localhost --port=5123 + $ mmio_tcp_to_lsl --address=localhost --port=5123 While receiving online data throug tcp, this command forward the data to 3 LSL stream outlets: @@ -93,7 +93,7 @@ You can easily change the LSL parameters: .. code:: bash - \$ mmio_tcp_to_lsl --help # to see all arguments + $ mmio_tcp_to_lsl --help # to see all arguments Read TRC file @@ -127,7 +127,7 @@ repo `__ in .. code:: bash - \$ python tcp_to_lsl.py --address=localhost --port=5123 + $ python tcp_to_lsl.py --address=localhost --port=5123 .. @@ -155,7 +155,7 @@ folder: .. code:: bash - \$ python tcp_to_epoch.py --epoch-size=5 --overlap=2.5 + $ python tcp_to_epoch.py --epoch-size=5 --overlap=2.5 .. note:: @@ -166,7 +166,7 @@ Rename TRC files with recording datetime .. code:: bash - \$ mmio_rename_trc --dirpath=./ --format=%Y%m%d-%H%M%S + $ mmio_rename_trc --dirpath=./ --format=%Y%m%d-%H%M%S Rename the TRC files of the given folder to include the recording date in the filename. Output is : ``__.TRC``. The @@ -184,9 +184,9 @@ Download the repo and: .. code:: bash - \$ conda env create -f environment.yml - \$ conda activate mmio - \$ poetry install + $ conda env create -f environment.yml + $ conda activate mmio + $ poetry install Please feel free to reach me if you want to contribute.