-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathfeed.xml
More file actions
1407 lines (1083 loc) · 90.9 KB
/
feed.xml
File metadata and controls
1407 lines (1083 loc) · 90.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>RTXI</title>
<description>RTXI is a fast, open-source system for hard real-time, closed-loop data acquisition and stimulation for electrophysiology experiments.</description>
<link>http://rtxi.org</link>
<atom:link href="http://rtxi.org/feed.xml" rel="self" type="application/rss+xml" />
<item>
<title>RTXI 3.0.0 Released!</title>
<description><p>RTXI v3.0.0 is now available</p>
<p>This release modernizes RTXI architecture and leverages newer techniques on performance and maintainability patterns.</p>
<p>The need for these updates originates primarily from the difficulty of updating RTXI 2.4 to the new Xenomai API, as well as the unfortunate news that the Analogy drivers used for hardware access would not be supported any longer under Xenomai. These and other architectural issues made it necessary to apply the lessons learned from years of use to improve software architecture and flexibility. This update relies on proven methods, and uses existing code to create a modern RTXI application. Some of the changes introduced:
New Functionality</p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>- New abstractions that reduces user and developer cognitive load
- Introduces a new scheduler and connector classes for faster and more accurate plugin real-time scheduling
- A redesign of the event system to have stronger typing and safer abstractions
- Support for the newest Xenomai framework now called EVL
- Introduction of new DAQ driver model to support non Analogy devices
- Support for National Instruments DAQ PCIe devices
- Introduction of the Real-Time Platform Abstraction Layer (RTPAL) for non Xenomai real-time support
- Automatic driver and real-time platform detection scheme for ease of use
- Central logging system to capture events fired by RTXI components and plugins
- Retire the DefaultGuiModel classes and introduction of the widget classes (plugin, component, and panel)
- Migration from autotools build system to cmake
- Update to installation instructions for both main RTXI components and DSO plugins
- Major updates to the builtin plugins such as data recorder and oscilloscope
- and many more
</code></pre></div></div>
<p>You can download the new version at the repository and run the install_rtxi.sh script. Test it out and let us know what you think.</p>
<p>Happy sciencing!</p>
</description>
<pubDate>Thu, 30 Nov 2023 00:00:00 -0500</pubDate>
<link>http://rtxi.org//news/2023/11/30/rtxi-300-released/</link>
<guid isPermaLink="true">http://rtxi.org//news/2023/11/30/rtxi-300-released/</guid>
</item>
<item>
<title>RTXI 2.3 Release</title>
<description><p>A new version of RTXI is now available!</p>
<p>New features include:</p>
<ol>
<li><strong>Support for New Linux LTS Base</strong>: Now RTXI 2.3 runs on Ubuntu 20.04 LTS.</li>
<li><strong>Support for Xenomai 3.1</strong>: RTXI can now be installed with Xenomai 3.1; A newer version of the real-time framework.</li>
<li><strong>Minor Bug fixes</strong>: for improved stability and long term maintenance</li>
</ol>
<p>Along with the newer version of rtxi there are also updated installation steps and website contact
information. Let us know if you have any issues installing RTXI by emailing us at <a href="mailto:help@rtxi.org">help@rtxi.org</a></p>
</description>
<pubDate>Thu, 22 Jul 2021 00:00:00 -0400</pubDate>
<link>http://rtxi.org//news/2021/07/22/rtxi-v23-release/</link>
<guid isPermaLink="true">http://rtxi.org//news/2021/07/22/rtxi-v23-release/</guid>
</item>
<item>
<title>Getting Started</title>
<description><p>To get started with RTXI for your experiments, there are some hardware
requirements you need to satisfy. They’re pretty easy to meet, and they’ll get
you set up with a properly performing RTXI installation.</p>
<p>If you are not familiar with RTXI or what it can do, we recommend looking
through the <a href="/manual">manual</a> first.</p>
<p>You will need:</p>
<ol>
<li>Computer</li>
<li>Data acquisition card (DAQ)</li>
<li>Graphics card (may come with computer)</li>
</ol>
<h4 id="computer">Computer</h4>
<p>Most computers built in the last few years will run Linux, but some will
perform better for real-time applications. Here are some points to consider
when buying new hardware:</p>
<ol>
<li><strong>What is the CPU type?</strong> We recommend using Intel processors, though AMD
ones work, too.</li>
<li><strong>How many PCI/PCIe slots are there?</strong> Most computers now come with only PCIe
slots, so make sure to get a PCIe compatible DAQ card. Currently RTXI only
supports National Instrument DAQ cards.</li>
</ol>
<p>Also, you should have a machine with at least <strong>4 GB of RAM</strong>. While Linux can
run with less, you will see degraded performance. Over the past few years,
operating systems have been built under the assumption of increasingly capable
hardware, and Linux has been no exception.</p>
<h4 id="daq">DAQ</h4>
<p>RTXI is tested and developed on systems using National Instruments (NI) cards.
The Xenomai project may still support PCI cards, but not PCIe, and we
do not test them so we cannot give you a recommendation to use them. Instead we
advice downloading and installing the NIDAQmx library, which supports a wide
range of National Instruments DAQ cards and is the interface used by RTXI. Here are
a list of resources for downloading and installing NIDAQmx:</p>
<ul>
<li><a href="https://www.ni.com/en/support/downloads/drivers/download.ni-daq-mx.html"><strong>Download NIDAQmx</strong></a></li>
<li><a href="https://www.ni.com/docs/en-US/bundle/ni-platform-on-linux-desktop/page/installing-ni-drivers-and-software-on-linux-desktop.html"><strong>Installation Instructions for NIDAQmx in Linux</strong></a></li>
<li><a href="https://www.ni.com/en/support/documentation/compatibility/21/ni-hardware-and-operating-system-compatibility.html"><strong>DAQ driver and operating system compatibility</strong></a></li>
</ul>
<h4 id="graphics-card">Graphics Card</h4>
<p><strong>NOTE:</strong> The information in this section was compiled over a decade ago, and a
lot has changed since then. Nvidia now provides better support for linux drivers.
Research whether your graphics card has driver support for linux.</p>
<p>You should get a discrete graphics card. Using integrated graphics will cause
UI computation to be offloaded to the CPU, which at the same time has to handle
real-time processes. Based on the systems we’ve benchmarked so far, you’re
better off using an AMD card than an Nvidia one. You are also recommended to
use open-source drivers instead of their proprietary counterparts.</p>
<p>What this means for you is that when buying/acquiring a computer, you need to
check the type of graphics card it has. You also need to check whether it is
supported by open-source drivers. (Often, newer hardware needs some time for
the people who code the drivers to extend support for them.)</p>
<p>Here is a list of graphics card supported by the Nvidia open-source driver
(nouveau) and the AMD one (radeon):</p>
<ul>
<li><a href="https://help.ubuntu.com/community/RadeonDriver#Fully_Supported"><strong>AMD driver (radeon)</strong></a></li>
<li><a href="https://wiki.freedesktop.org/nouveau/FAQ/#index14h3"><strong>Nvidia driver (nouveau)</strong></a></li>
</ul>
<h3 id="installing-rtxi">Installing RTXI</h3>
<p>Look through our <a href="/install">installation instructions</a> to see how to install
RTXI 3.0.0. If you run into issues, look through our
available <a href="/docs">documentation</a>, and if it doesn’t help, email us or
<a href="https://github.com/rtxi/rtxi/issues">submit an issue on GitHub</a>. We recommend
you do the latter.</p>
<h4 id="note">Note</h4>
<p><a href="https://github.com/rtxi/rtxi.github.io/issues/">Let us know</a> if any links are
broken. They are all supposed to point directly to lists of hardware
compatible with drivers. If they don’t, something went terribly wrong, and we
need to fix the links.</p>
</description>
<pubDate>Wed, 01 Jan 2020 00:00:00 -0500</pubDate>
<link>http://rtxi.org//docs/tutorials/2020/01/01/getting-started/</link>
<guid isPermaLink="true">http://rtxi.org//docs/tutorials/2020/01/01/getting-started/</guid>
</item>
<item>
<title>RTXI 2.2 Released</title>
<description><p>New version with long-term support and a new real-time kernel!</p>
<p>New features:</p>
<ol>
<li><strong>New Linux Base</strong>: RTXI 2.2 runs on Ubuntu GNOME 16.04 LTS - with it, you’ll get a stable desktop with hardware and software support for the next few years through Ubuntu and the RTXI team.</li>
<li><strong>Enhanced Performance</strong>: We’ve upgraded to the latest version of Xenomai - which includes a number of under-the-hood updates to the real-time system, but still the same robust performance.</li>
</ol>
<p>Try out v2.2. You can use the live CD to demo RTXI and later install it, or you can install a generic Linux distribution of your choice and use our installation scripts. We’ve included two different live CDs - one for Core 2/Newer Xeon processors and one for generic x64 processors.</p>
<p>Look through all the documentation on the website to find installation instructions, notes on hardware configurations, RTXI modules, documentation, and more. Let us know if you have issues or questions.</p>
</description>
<pubDate>Tue, 09 Jan 2018 00:00:00 -0500</pubDate>
<link>http://rtxi.org//news/2018/01/09/rtxi-v22-released/</link>
<guid isPermaLink="true">http://rtxi.org//news/2018/01/09/rtxi-v22-released/</guid>
</item>
<item>
<title>Technical overview of RTXI</title>
<description><p>Ever been curious about how RTXI works? Check out the new paper recently published in PLOS Computational Biology:</p>
<p><a href="http://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005430">Patel, Y.A., George, A., Dorval, A.D., White, J.A., Christini, D.J. and Butera, R.J., 2017. Hard real-time closed-loop electrophysiology with the Real-Time eXperiment Interface (RTXI). PLOS Computational Biology, 13(5), p.e1005430.</a></p>
</description>
<pubDate>Thu, 01 Jun 2017 00:00:00 -0400</pubDate>
<link>http://rtxi.org//news/2017/06/01/paper-published/</link>
<guid isPermaLink="true">http://rtxi.org//news/2017/06/01/paper-published/</guid>
</item>
<item>
<title>Kilohertz frequency nerve block enhances anti-inflammatory effects of vagus nerve stimulation</title>
<description><p>Efferent activation of the cervical vagus nerve (cVN) dampens systemic inflammatory processes, potentially modulating a wide-range of inflammatory pathological conditions. In contrast, afferent cVN activation amplifies systemic inflammatory processes, leading to activation of the hypothalamic-pituitary-adrenal (HPA) axis, the sympathetic nervous system through the greater splanchnic nerve (GSN), and elevation of pro-inflammatory cytokines. Ideally, to clinically implement anti-inflammatory therapy via cervical vagus nerve stimulation (cVNS) one should selectively activate the efferent pathway. Unfortunately, current implementations, in animal and clinical investigations, activate both afferent and efferent pathways. We paired cVNS with kilohertz electrical stimulation (KES) nerve block to preferentially activate efferent pathways while blocking afferent pathways. Selective efferent cVNS enhanced the anti-inflammatory effects of cVNS. Our results demonstrate that: (i) afferent, but not efferent, cVNS synchronously activates the GSN in a dose-dependent manner; (ii) efferent cVNS enabled by complete afferent KES nerve block enhances the anti-inflammatory benefits of cVNS; and (iii) incomplete afferent KES nerve block exacerbates systemic inflammation. Overall, these data demonstrate the utility of paired efferent cVNS and afferent KES nerve block for achieving selective efferent cVNS, specifically as it relates to neuromodulation of systemic inflammation.</p>
</description>
<pubDate>Thu, 05 Jan 2017 00:00:00 -0500</pubDate>
<link>http://rtxi.org//papers/2017/01/05/kilohertz-frequency-nerve-block-enhances-anti-inflammatory-effects-of-vagus-nerve-stimulation/</link>
<guid isPermaLink="true">http://rtxi.org//papers/2017/01/05/kilohertz-frequency-nerve-block-enhances-anti-inflammatory-effects-of-vagus-nerve-stimulation/</guid>
</item>
<item>
<title>Illuminating Myocyte-Fibroblast Homotypic and Heterotypic Gap Junction Dynamics Using Dynamic Clamp</title>
<description><p>Fibroblasts play a significant role in the development of electrical and mechanical dysfunction of the heart; however, the underlying mechanisms are only partially understood. One widely studied mechanism suggests that fibroblasts produce excess extracellular matrix, resulting in collagenous septa that slow propagation, cause zig-zag conduction paths, and decouple cardiomyocytes, resulting in a substrate for cardiac arrhythmia. An emerging mechanism suggests that fibroblasts promote arrhythmogenesis through direct electrical interactions with cardiomyocytes via gap junction (GJ) channels. In the heart, three major connexin (Cx) isoforms, Cx40, Cx43, and Cx45, form GJ channels in cell-type-specific combinations. Because each Cx is characterized by a unique time- and transjunctional voltage-dependent profile, we investigated whether the electrophysiological contributions of fibroblasts would vary with the specific composition of the myocyte-fibroblast (M-F) GJ channel. Due to the challenges of systematically modifying Cxs in vitro, we coupled native cardiomyocytes with in silico fibroblast and GJ channel electrophysiology models using the dynamic-clamp technique. We found that there is a reduction in the early peak of the junctional current during the upstroke of the action potential (AP) due to GJ channel gating. However, effects on the cardiomyocyte AP morphology were similar regardless of the specific type of GJ channel (homotypic Cx43 and Cx45, and heterotypic Cx43/Cx45 and Cx45/Cx43). To illuminate effects at the tissue level, we performed multiscale simulations of M-F coupling. First, we developed a cell-specific model of our dynamic-clamp experiments and investigated changes in the underlying membrane currents during M-F coupling. Second, we performed two-dimensional tissue sheet simulations of cardiac fibrosis and incorporated GJ channels in a cell type-specific manner. We determined that although GJ channel gating reduces junctional current, it does not significantly alter conduction velocity during cardiac fibrosis relative to static GJ coupling. These findings shed more light on the complex electrophysiological interplay between cardiac fibroblasts and myocytes.</p>
</description>
<pubDate>Tue, 23 Aug 2016 00:00:00 -0400</pubDate>
<link>http://rtxi.org//papers/2016/08/23/illuminating-myocyte-fibroblast-homotypic-and-heterotypic-gap-junction-dynamics-using-dynamic-clamp/</link>
<guid isPermaLink="true">http://rtxi.org//papers/2016/08/23/illuminating-myocyte-fibroblast-homotypic-and-heterotypic-gap-junction-dynamics-using-dynamic-clamp/</guid>
</item>
<item>
<title>Cell-specific Dynamic Clamp analysis of the role of funny I f current in cardiac pacemaking</title>
<description><p>We used the Dynamic Clamp technique for i) comparative validation of conflicting computational models of the hyperpolarization-activated funny current, If, and ii) quantification of the role of If in mediating autonomic modulation of heart rate. Experimental protocols based on the injection of a real-time recalculated synthetic If current in sinoatrial rabbit cells were developed.</p>
<p>Preliminary results of experiments mimicking the autonomic modulation of If demonstrated the need for a customization procedure to compensate for cellular heterogeneity. For this reason, we used a cell-specific approach, scaling the maximal conductance of the injected current based on the cell’s spontaneous firing rate. The pacemaking rate, which was significantly reduced after application of Ivabradine, was restored by the injection of synthetic current based on the Severi-DiFrancesco formulation, while the injection of synthetic current based on the Maltsev-Lakatta formulation did not produce any significant variation. A positive virtual shift of the If activation curve, mimicking the Isoprenaline effects, led to a significant increase in pacemaking rate (+17.3 ± 6.7%, p &lt; 0.01), although of lower magnitude than that induced by real Isoprenaline (+45.0 ± 26.1%). Similarly, a negative virtual shift of the activation curve significantly lowered the pacemaking rate (−11.8 ± 1.9%, p &lt; 0.001), as did the application of real Acetylcholine (−20.5 ± 5.1%).</p>
<p>The Dynamic Clamp approach, applied to the If study in cardiomyocytes for the first time and rate-adapted to manage intercellular variability, indicated that: i) the quantitative description of the If current in the Severi-DiFrancesco model accurately reproduces the effects of the real current on rabbit sinoatrial cell pacemaking rate and ii) a significant portion (50–60%) of the physiological autonomic rate modulation is due to the shift of the If activation curve.fferent activation of the cervical vagus nerve (cVN) dampens systemic inflammatory processes, potentially modulating a wide-range of inflammatory pathological conditions. In contrast, afferent cVN activation amplifies systemic inflammatory processes, leading to activation of the hypothalamic-pituitary-adrenal (HPA) axis, the sympathetic nervous system through the greater splanchnic nerve (GSN), and elevation of pro-inflammatory cytokines. Ideally, to clinically implement anti-inflammatory therapy via cervical vagus nerve stimulation (cVNS) one should selectively activate the efferent pathway. Unfortunately, current implementations, in animal and clinical investigations, activate both afferent and efferent pathways. We paired cVNS with kilohertz electrical stimulation (KES) nerve block to preferentially activate efferent pathways while blocking afferent pathways. Selective efferent cVNS enhanced the anti-inflammatory effects of cVNS. Our results demonstrate that: (i) afferent, but not efferent, cVNS synchronously activates the GSN in a dose-dependent manner; (ii) efferent cVNS enabled by complete afferent KES nerve block enhances the anti-inflammatory benefits of cVNS; and (iii) incomplete afferent KES nerve block exacerbates systemic inflammation. Overall, these data demonstrate the utility of paired efferent cVNS and afferent KES nerve block for achieving selective efferent cVNS, specifically as it relates to neuromodulation of systemic inflammation.</p>
</description>
<pubDate>Mon, 21 Dec 2015 00:00:00 -0500</pubDate>
<link>http://rtxi.org//papers/2015/12/21/cell-specific-dynamic-clamp-analysis-of-the-role-of-funny-if-current-in-cardiac-pacemaking/</link>
<guid isPermaLink="true">http://rtxi.org//papers/2015/12/21/cell-specific-dynamic-clamp-analysis-of-the-role-of-funny-if-current-in-cardiac-pacemaking/</guid>
</item>
<item>
<title>RTXI Fall Newsletter</title>
<description><p>There have been lots of new developments in RTXI over the past few months. Look
forward to the upcoming release of RTXI 2.1, and we encourage those of you
attending SfN 2015 to check out our poster!</p>
<h4 id="upcoming-features-in-rtxi-21">Upcoming Features in RTXI 2.1</h4>
<ul>
<li>
<p><strong>New Plotting Tools</strong> - We’ve created a new analysis-tools module that will
directly plot HDF data saved by the data recorder.</p>
</li>
<li>
<p><strong>UI Upgrades</strong> - We’ve upgraded RTXI’s UI framework from Qt4 to Qt5, the
most up-to-date version available.</p>
</li>
<li>
<p><strong>Bugfixes and Tweaks</strong> - RTXI is continually improving under the hood, and
for 2.1, we bundled in lots of bugfixes, UI tweaks, and performance
enhancements.</p>
</li>
<li>
<p><strong>Improved User-friendliness</strong> - RTXI now checks for updates, and the new
module-installer makes finding and installing the modules you need easier
than ever.</p>
</li>
<li>
<p><strong>Arduino Support</strong> - The new Arduino module provides an interface between
RTXI and Arduino computers. Note that this is non-RT.</p>
</li>
<li>
<p><strong>New Module Installer</strong> - A new Module Installer allows you to find and
install modules within RTXI itself.</p>
</li>
</ul>
<h4 id="check-us-out-at-sfn">Check us out at SfN:</h4>
<p>We’ll be presenting a poster at this year’s Society for Neuroscience
Conference. If you’re also attending, feel free to stop by. Look out for poster
267.23 / BB66 during the 1:00 -5 :00 PM session on October 18. We’ll be in Hall
A.</p>
<h4 id="contact-us">Contact Us:</h4>
<p>You can reach out to us via email and through GitHub. Let us know if you have
any questions or issues. We’re around 24/7, and we’ll do whatever we can to get
RTXI working for you. We’ll even come to you in person.</p>
</description>
<pubDate>Fri, 09 Oct 2015 00:00:00 -0400</pubDate>
<link>http://rtxi.org//news/2015/10/09/fall-newsletter/</link>
<guid isPermaLink="true">http://rtxi.org//news/2015/10/09/fall-newsletter/</guid>
</item>
<item>
<title>IKr Impact on Repolarization and Its Variability Assessed by Dynamic-Clamp</title>
<description><p>Repolarization and its stability are exquisitely sensitive to IKr features. Information on the relative importance of specific IKr abnormalities is missing and would assist in the evaluation of arrhythmogenic risk.</p>
<p>In single guinea-pig myocytes, endogenous IKr was replaced by modelled IKr (mIKr) by Dynamic-Clamp (DC) at a cycle length of 1 s. mIKr parameters were systematically modified and the resulting changes in action potential duration (APD) and its short term variability (SD1) were measured. We observed that: 1) IKr blockade increased SD1 more than expected by its dependency on APD; 2) mIKr completely reversed APD and SD1 changes caused by IKr blockade; 3) repolarization was most sensitive to inactivation shifts, which affected APD and SD1 concordantly; 4) activation shifts of the same magnitude had marginal impact on APD but, only when reducing mIKr, they significantly increased SD1; 5) changes in maximal conductance resulted in a pattern similar to that of activation shifts.</p>
<p>The largest effect on repolarization and its stability are expected from changes in IKr inactivation. APD is less sensitive to changes in other IKr gating parameters, which are better revealed by SD1 changes. SD1 may be more sensitive than APD in detecting IKr-dependent repolarization abnormalities.</p>
</description>
<pubDate>Tue, 23 Jun 2015 00:00:00 -0400</pubDate>
<link>http://rtxi.org//papers/2015/06/23/ikr-impact-on-repolarization-and-its-variability-assessed-by-dynamic-clamp/</link>
<guid isPermaLink="true">http://rtxi.org//papers/2015/06/23/ikr-impact-on-repolarization-and-its-variability-assessed-by-dynamic-clamp/</guid>
</item>
<item>
<title>RTXI 2.0 Released</title>
<description><p>We’ve been working hard over the past year to put together the new and improved
Real-Time eXperiment Interface.</p>
<p>New features:</p>
<ol>
<li><strong>Improved UI:</strong> We’ve upgraded the UI framework from Qt3 to Qt4, which
provides RTXI with many built-in performance improvements.</li>
<li><strong>New Linux Base:</strong> RTXI 2.0 runs on Ubuntu GNOME 14.04 LTS - with it,
you’ll get a stable desktop.</li>
<li><strong>Enhanced Performance:</strong> For 2.0, we’ve switched from RTAI to Xenomai, a
more versatile real-time kernel, providing a more robust and stable hard
real-time system.</li>
<li><strong>Open Development:</strong> We’ve migrated the project to GitHub, an excellent
forum for development and all our documentation. Submit an issue; make a
feature request; or watch our repository to stay up-to-date.</li>
</ol>
<p>Try out v2.0. You can use the <a href="/install">live CD</a> to demo RTXI and later
install it, or you can install a generic Linux distribution of your choice and
use our installation scripts.</p>
<p>Look through all the documentation on the website to find installation
instructions, notes on hardware configurations, RTXI modules, documentation,
and more. Let us know if you have issues or questions.</p>
</description>
<pubDate>Tue, 12 May 2015 00:00:00 -0400</pubDate>
<link>http://rtxi.org//news/2015/05/12/rtxi-v2-released/</link>
<guid isPermaLink="true">http://rtxi.org//news/2015/05/12/rtxi-v2-released/</guid>
</item>
<item>
<title>Cell-Specific Cardiac Electrophysiology Models</title>
<description><p>The traditional cardiac model-building paradigm involves constructing a composite model using data collected from many cells. Equations are derived for each relevant cellular component (e.g., ion channel, exchanger) independently. After the equations for all components are combined to form the composite model, a subset of parameters is tuned, often arbitrarily and by hand, until the model output matches a target objective, such as an action potential. Unfortunately, such models often fail to accurately simulate behavior that is dynamically dissimilar (e.g., arrhythmia) to the simple target objective to which the model was fit. In this study, we develop a new approach in which data are collected via a series of complex electrophysiology protocols from single cardiac myocytes and then used to tune model parameters via a parallel fitting method known as a genetic algorithm (GA). The dynamical complexity of the electrophysiological data, which can only be fit by an automated method such as a GA, leads to more accurately parameterized models that can simulate rich cardiac dynamics. The feasibility of the method is first validated computationally, after which it is used to develop models of isolated guinea pig ventricular myocytes that simulate the electrophysiological dynamics significantly better than does a standard guinea pig model. In addition to improving model fidelity generally, this approach can be used to generate a cell-specific model. By so doing, the approach may be useful in applications ranging from studying the implications of cell-to-cell variability to the prediction of intersubject differences in response to pharmacological treatment.</p>
</description>
<pubDate>Thu, 30 Apr 2015 00:00:00 -0400</pubDate>
<link>http://rtxi.org//papers/2015/04/30/cell-specific-cardiac-electrophysiology-models/</link>
<guid isPermaLink="true">http://rtxi.org//papers/2015/04/30/cell-specific-cardiac-electrophysiology-models/</guid>
</item>
<item>
<title>Repolarization Reserve Evolves Dynamically During the Cardiac Action Potential: Effects of Transient Outward Currents on Early Afterdepolarizations</title>
<description><p><strong>Background</strong> — Transient outward K currents (Ito) have been reported both to
suppress and facilitate early afterdepolarizations (EADs) when repolarization
reserve is reduced. Here we used the dynamic clamp technique to analyze how Ito
accounts for these paradoxical effects on EADs by influencing the dynamic
evolution of repolarization reserve during the action potential.</p>
<p><strong>Methods and Results</strong> — Isolated patch-clamped rabbit ventricular myocytes
were exposed to either oxidative stress (H2O2) or hypokalemia to induce
bradycardia-dependent EADs at a long pacing cycle length (PCL) of 6 s, when
native rabbit Ito is substantial. EADs disappeared when the PCL was shortened
to 1 s, when Ito becomes negligible due to incomplete recovery from
inactivation. During 6-s PCL, EADs were blocked by the Ito blocker
4-aminopyridine, but reappeared when a virtual current with appropriate
Ito-like properties was reintroduced using the dynamic clamp (n=141 trials).
During 1-s PCL in the absence of 4-aminopyridine, adding a virtual Ito-like
current (n=1,113 trials) caused EADs to reappear over a wide range of Ito
conductance (0.005-0.15 nS/pF), particularly when inactivation kinetics were
slow (τinact≥20 ms) and the pedestal (non-inactivating component) was small
(&lt;25% of peak Ito). Faster inactivation or larger pedestals tended to suppress
EADs.</p>
<p><strong>Conclusions</strong> — Repolarization reserve evolves dynamically during the cardiac
action potential. Whereas sufficiently large Ito can suppress EADs, a wide
range of intermediate Ito properties can promote EADs by influencing the
temporal evolution of other currents affecting late repolarization reserve.
These findings raise caution in targeting Ito as an antiarrhythmic strategy.</p>
</description>
<pubDate>Mon, 20 Apr 2015 00:00:00 -0400</pubDate>
<link>http://rtxi.org//papers/2015/04/20/repolarization-reserve-evolves-dynamically-during-cardiac-action-potential/</link>
<guid isPermaLink="true">http://rtxi.org//papers/2015/04/20/repolarization-reserve-evolves-dynamically-during-cardiac-action-potential/</guid>
</item>
<item>
<title>List of Resources</title>
<description><p>There are a lot of things you need to know to be able to fully use RTXI.
Fortunately, these things aren’t hard to learn, and there is already plenty of
documentation online to help you learn it. This is a non-exhaustive list of
some good resources to learn what you need. They aren’t listed in any specific
order.</p>
<h4 id="using-the-command-line">Using the Command Line</h4>
<ol>
<li><a href="http://ryanstutorials.net/linuxtutorial/">http://ryanstutorials.net/linuxtutorial/</a> (see sections on how to navigate around the filesystem and manipulate files)</li>
</ol>
<h4 id="using-git">Using Git</h4>
<ol>
<li><a href="http://git-scm.com/book/en/v2">http://git-scm.com/book/en/v2</a></li>
<li><a href="http://rogerdudler.github.io/git-guide/">http://rogerdudler.github.io/git-guide/</a></li>
<li><a href="https://www.atlassian.com/git/tutorials/">https://www.atlassian.com/git/tutorials/</a></li>
</ol>
<h4 id="using-github">Using GitHub</h4>
<ol>
<li><a href="https://guides.github.com/">https://guides.github.com/</a></li>
</ol>
<h4 id="learning-programming-and-c">Learning Programming and C++</h4>
<ol>
<li><a href="http://www.cplusplus.com/doc/tutorial/">http://www.cplusplus.com/doc/tutorial/</a> (prior programming experience helps)</li>
<li><a href="http://www.penguinprogrammer.co.uk/c-beginners-tutorial/">http://www.penguinprogrammer.co.uk/c-beginners-tutorial/</a></li>
</ol>
<h4 id="qt-and-gui-creation">Qt and GUI Creation</h4>
<ol>
<li><a href="http://doc.qt.io/qt-4.8/]">http://doc.qt.io/qt-4.8/</a><br />
<strong>Note:</strong> Be careful with some of the Qt tutorials. You don’t need to
instatiate things like QApplication objects, create qmake.pro files, etc.
because RTXI takes care of that. Pay attention to what the UI classes are and
how to use the signal/slot API.</li>
</ol>
<p>Again, this is a non-exhaustive list of a tiny subset of all that’s available
online and in print. It takes some time to learn these things, just as it does
with anything else. It also wouldn’t hurt to learn these things in general, Qt
excepted. Unix-like environments are very common on clusters for computational
research; Git and GitHub are widely used for coding projects; and C++ very fast
and good to learn, especially given that other languages often use it as a
backend to speed up loops and other heavy sections of code.</p>
</description>
<pubDate>Thu, 16 Apr 2015 00:00:00 -0400</pubDate>
<link>http://rtxi.org//docs/tutorials/2015/04/16/resource-list/</link>
<guid isPermaLink="true">http://rtxi.org//docs/tutorials/2015/04/16/resource-list/</guid>
</item>
<item>
<title>Making New Modules in RTXI</title>
<description><p>Outlined here is the development process for making new RTXI modules. For
simplicity, we provide a shell script, called create_template_plugin.sh, for users to
customize without needing to writing everything from scratch. You can access
this script under the scripts folder in RTXI’s root directory. When run, it will create
a source directory with source files and cmake build file in the current directory.</p>
<h3 id="to-create-rtxi-modules">To create RTXI modules:</h3>
<h4 id="1-generate-the-rtxi-plugin-project">1. Generate the RTXI plugin project.</h4>
<p>Enter or create the directory where you wish to create the plugin, then run the following
command:</p>
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>RTXI_SOURCE_LOCATION/scripts/create_template_plugin.sh </code></pre></figure>
<p>where RTXI_SOURCE_LOCATION is the full directory path to RTXI’s source code. Once you
run the script, the program will ask for a name and a description of your plugin. Afterwards
it will use this information to generate a widgets.hpp, widgets.cpp, and CMakeLists.txt.</p>
<p>The name of the directory created is the same as the name of the plugin.
An explanation of the header and source files is available in our
<a href="http://rtxi.org/docs/manual/#customizing_gui">user manual</a>.</p>
<h4 id="2-modify-files">2. Modify files.</h4>
<p>Modify the RTXI files to run the code you want. The CMakeLists.txt file generated
will automatically search for the RTXI library, but you should modify it if there
are additional dependencies to your plugins. Check CMake and your library’s documentation
on how to find and link the depenency.</p>
<p>Additionally, it’s good practice to document your code. As a general rule,
document it so that you’re confident that anyone with programming experience
will be able to understand what your code and overall module do.</p>
<h4 id="3-configure-compile-and-install">3. Configure, Compile, and install.</h4>
<p>Once you’re ready to compile and install your module, go to the base of your
module directory and execute:</p>
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>cmake <span class="nt">-S</span> <span class="nb">.</span> <span class="nt">-B</span> build
<span class="nv">$ </span>cmake <span class="nt">--build</span> ./build
<span class="nv">$ </span><span class="nb">sudo </span>cmake <span class="nt">--install</span> ./build</code></pre></figure>
</description>
<pubDate>Fri, 10 Apr 2015 00:00:00 -0400</pubDate>
<link>http://rtxi.org//docs/tutorials/2015/04/10/making-new-rtxi-modules/</link>
<guid isPermaLink="true">http://rtxi.org//docs/tutorials/2015/04/10/making-new-rtxi-modules/</guid>
</item>
<item>
<title>Posting Bugs and Issues on GitHub</title>
<description><p>RTXI is in active development, and our work depends heavily on user feedback.
This tutorial provides instructions for creating bug reports, posting questions
about issues, making feature requests, etc. through GitHub. Though email will
also work, we strongly encourage using GitHub so that users can see existing
issues and contribute to overall discussion. To use GitHub, you will need to
create a <a href="https://github.com/join">GitHub account</a>.</p>
<p><strong>Note:</strong> For the sake of absolute clarity, please do not actually create an
issue in the process of going though this tutorial.</p>
<h4 id="1-navigate-to-the-repository">1. Navigate to the repository.</h4>
<div class="row">
<div class="col-md-8 col-xs-12">
Go to our GitHub page (
<a href="https://github.com/rtxi">https://github.com/rtxi</a>). On the page,
use the search bar or scroll down until you find the software you want to
report. If you experience a bug within RTXI and its built-in modules, look
for the <code>rtxi</code> repository. If it's a module you have problems
with, find the repository that correponds to the module name. Also, if
you have questions about anything on this website, go to the
<code>rtxi.github.io</code> repository.
<div>&nbsp;</div>
</div>
<div class="col-md-4 col-xs-12">
<div class="row">
<div class="col-xs-10 col-xs-offset-1 col-md-12 col-md-offset-0">
<a href="/assets/img/tutorials/rtxi-github-main-page.png">
<img src="/assets/img/tutorials/rtxi-github-main-page.png" class="img-responsive" />
</a>
</div>
</div>
</div>
</div>
<h4 id="2-open-an-issue-on-the-repository-page">2. Open an issue on the repository page.</h4>
<p>Each module has an issue page where you can view, submit, and comment on
current development issues. Pictured is the repository page for <code class="language-plaintext highlighter-rouge">rtxi</code>. To
navigate to its issues page, click on <code class="language-plaintext highlighter-rouge">Issues</code> on the right sidebar.</p>
<p>Click on <code class="language-plaintext highlighter-rouge">Issues</code>. It’s on the sidebar to the right. If you haven’t logged in
to GitHub already, you will be prompted to now. This will open up a new page
that shows all the issues posted to the repository. Look through them to see if
the issue you are having is related to something someone else posted. If it is,
you can add to the existing discussion. If not, then open up a new issue.</p>
<div class="row">
<div class="col-xs-12 col-sm-6 col-md-5 col-md-offset-1">
<a href="/assets/img/tutorials/rtxi-github-rtxi-page.png">
<img src="/assets/img/tutorials/rtxi-github-rtxi-page.png" class="img-responsive" />
</a>
</div>
<div class="col-sm-6 col-xs-12 col-md-5">
<a href="/assets/img/tutorials/rtxi-github-rtxi-issues.png"><figure>
<img src="/assets/img/tutorials/rtxi-github-rtxi-issues.png" class="img-responsive" />
</figure></a>
</div>
</div>
<h4 id="3-write-up-your-issue">3. Write up your issue.</h4>
<p>Click the appropriate button for whether you’re opening a new issue or joining
an existing thread. Please be as clear and detailed as possible in your
comments, as only posting things like “RTXI is crashing” or “X isn’t working”
doesn’t help us figure out what the issue is.</p>
<p>For your posts, we ask (but don’t require) you do provide the following
information when appropriate:</p>
<ol>
<li><strong>The version of RTXI you are using.</strong> If you used a live CD to install
RTXI, just say that. If you compiled from source, go to your clone of the
RTXI repository and run <code class="language-plaintext highlighter-rouge">git log</code>. The most recent commit will have a string
associated with it that looks like a random list of letters. Give us the
string.</li>
<li><strong>Error messages from RTXI in the terminal.</strong> If there are no error
messages, no problem. If RTXI is crashing, it would be incredibly helpful if
you used <code class="language-plaintext highlighter-rouge">gdb</code> to provide a backtrace.</li>
<li><strong>A clear description of the bug.</strong> Describe the behavior you expect, the
behavior that is happening, and the set of steps that trigger the error.</li>
</ol>
<p>Clear issue postings are incredibly helpful for us to start debugging your
issues, and it also helps anyone else fully understand the issues you have.</p>
</description>
<pubDate>Thu, 09 Apr 2015 00:00:00 -0400</pubDate>
<link>http://rtxi.org//docs/troubleshoot/2015/04/09/posting-bugs-and-issues/</link>
<guid isPermaLink="true">http://rtxi.org//docs/troubleshoot/2015/04/09/posting-bugs-and-issues/</guid>
</item>
<item>
<title>How to Use Git</title>
<description><p>Below are instructions for installing and using Git. Git is a version control
tool that enables users to track revisions and changes in files and coordinate
with collaborators. It is often used for software development.</p>
<p>Unlike many applications, such as Microsoft Word, editing and saving files
overwrites data. This makes it difficult to track changes without creating
different file names, a process that can get messy very quickly.</p>
<p>Git takes snapshots of files a user wants to track and maintains a history of
changes that have occurred. This makes backtracking and checking revisions a
simple process, which is especially helpful for large projects with many
developers. It also functions as a collaborative tool by enabling users to make
local copies of a common project and modify them as needed. Users track their
own changes and those of others, and Git incorporates tools that enable
branching and merging of whatever changes people make.</p>
<p><a href="http://www.phdcomics.com/comics/archive/phd101212s.gif">
<img src="http://www.phdcomics.com/comics/archive/phd101212s.gif" class="img-responsive" style="max-height:400px;float:right;margin:10px;" />
</a></p>
<p><strong>Note:</strong> Installing git is not the same as using GitHub. GitHub uses git, but
it is a remote server that users can use as a central location for storing
data. See the instructions for <a href="https://github.com/join">opening a GitHub
account</a>.</p>
<h4 id="installing-git-on-linux">Installing Git on Linux</h4>
<p>Open the terminal. You can do this from within the Applications menu in GNOME
or by using the <code class="language-plaintext highlighter-rouge">CTRL+Alt+t</code> shortcut. Enter:</p>
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span><span class="nb">sudo </span>apt-get <span class="nb">install </span>git</code></pre></figure>
<p><strong>Note:</strong> When telling people to enter commands, it is common practice to use
<code class="language-plaintext highlighter-rouge">$</code> at the start of each line to signify that it is to be entered in the
terminal. Also, <code class="language-plaintext highlighter-rouge">#</code> is used to signify root permissions rather than having
people enter <code class="language-plaintext highlighter-rouge">sudo</code>. In either case, you DO NOT have to enter <code class="language-plaintext highlighter-rouge">$</code> or <code class="language-plaintext highlighter-rouge">#</code> in the
terminal. For example, in the above command. just enter the text <code class="language-plaintext highlighter-rouge">sudo apt-get
install git</code> and hit <code class="language-plaintext highlighter-rouge">ENTER</code>.</p>
<p>Once Git is installed, configure it with your username and/or email address.
This is preferred in development scenarios so that everyone can identify what
modifications were made by which user. GitHub also maps Git user email
addresses to GitHub accounts. Note that you do not have to give your real name.
Any name will do, as all that is needed is a way to identify who has done what.
Technically, Git does not check email address validity, either, but for
collaborate work, it is best to provide some address so that people can ask
each other questions about changes.</p>
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git config <span class="nt">--global</span> user.name <span class="s1">'Your name here'</span>
<span class="nv">$ </span>git config <span class="nt">--global</span> user.email your@address.here</code></pre></figure>
<p>The <code class="language-plaintext highlighter-rouge">git</code> part of each command specifies that the script that follows contains
Git commands. Git provides a library of functions for executing version
control. Rather than have them directly incorporated into system libraries,
they are made accessible by preceding the command with <code class="language-plaintext highlighter-rouge">git</code>. Therefore, these
commands and all other git commands we will use start with <code class="language-plaintext highlighter-rouge">git</code>.</p>
<p>The second part, <code class="language-plaintext highlighter-rouge">config</code>, is used to configure information, which is stored in
a hidden file. The tag <code class="language-plaintext highlighter-rouge">--global</code> means that the changes to the user
configuration are to affect all user repositories. The details are saved in a
hidden file called .gitconfig stored at the base of the user’s home directory
(<code class="language-plaintext highlighter-rouge">~/.gitconfig</code>). Other options allow for different scopes of the effects of
configuration changes. <code class="language-plaintext highlighter-rouge">--local</code> is the default behavior and specifies that
changes be written to hidden file in the working directory called
<code class="language-plaintext highlighter-rouge">.git/config</code>. You can see what has been set in the config files by running
<code class="language-plaintext highlighter-rouge">git config --list</code>.</p>
<p><strong>Note:</strong> Should you ever need help with a Git command, you can use `git help</p>
<commandname>` to check the Git documentation in the terminal. For example, if
unsure about `config`, run `git help config`.
### Using Local Repositories
#### Initialization
Git enables users to track local changes and development paths. First, go the
base of your home directory and create some new directories:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span><span class="nb">cd</span> ~/
<span class="nv">$ </span><span class="nb">mkdir </span>plugins
<span class="nv">$ </span><span class="nb">cd </span>plugins
<span class="nv">$ </span><span class="nb">mkdir </span>practice
<span class="nv">$ </span><span class="nb">cd </span>practice
<span class="nv">$ </span><span class="nb">cd</span> ..</code></pre></figure>
Now, from within the plugins directory, run:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git init</code></pre></figure>
<!--
<a href="/assets/img/tutorials/git-tutorial-1.png">
<img src="/assets/img/tutorials/git-tutorial-1.png" class="img-responsive">
</a>
-->
This command specifies that the directory is to be treated as a Git repository.
By default, Git does not track *any* files. User must enable it in a directory
of their choosing. Once executed, this function creates a hidden directory
called `.git/` that stores information regarding the repository contained in
the directory.
<!--
<a href="/assets/img/tutorials/git-tutorial-2.png">
<img src="/assets/img/tutorials/git-tutorial-2.png" class="img-responsive">
</a>
-->
**Note:** Git exists as a version control system. It is not advisable to use it for backing up big files, such as videos, binaries, etc. The entire process gets encumbered quickly.
#### <a name="add"></a>Adding Files to the Staging Area
The directory is currently empty, so create some files:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span><span class="nb">touch </span>file1.txt
<span class="nv">$ </span><span class="nb">touch </span>file2.txt
<span class="nv">$ </span><span class="nb">touch </span>file3.txt</code></pre></figure>
These files have been added to the repository, or in Git terminology, the
**working tree**. The working tree refers to all of the files that originate
from the base of the directory, which in this case is `~/plugins`.
By default, Git does not track files that are added to the directory. Users
have to specify that they be tracked. This is done by the `add` command. Git
does, though tell what files are and are not being tracked. Simply use `git
status`
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git add file1.txt file2.txt file3.txt</code></pre></figure>
`git add` adds the files to what is called the **staging area**. Basically,
this command generates a snapshot of the files and stores them without adding
them to the permanent version history. In other words, Git is aware of the
files, but it has not added them to the permanent version history. Basically,
git has a 2-stage revision process. The first is to send modified or new files
to the staging area, and the second is to commit them to the permanent version
history. This has its advantages in that it enables users to add files to a
repository as a group that together functions properly. Reverting from one set
of changes to another is simply a process of switching to another snapshot in
the permanent history. This process is explained later.
To show what files are in the stating area, use:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git status</code></pre></figure>
<!--
<a href="/assets/img/tutorials/git-tutorial-3.png">
<img src="/assets/img/tutorials/git-tutorial-3.png" class="img-responsive">
</a>
-->
If needed, it is possible to unstage files that were added with `git add`. Git
gives the user the command `git rm --cached <filename>`. Try it on one of the
files and see the changes made to the staging area.
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git <span class="nb">rm</span> <span class="nt">--cached</span> file1.txt
<span class="nv">$ </span>git status</code></pre></figure>
<!--
<a href="/assets/img/tutorials/git-tutorial-4.png">
<img src="/assets/img/tutorials/git-tutorial-4.png" class="img-responsive">
</a>
-->
The following assumes that all three files are added to the staging area. You
can add all files to the staging area by running `git add -A`.
#### <a name="commit"></a>Commiting Files
With the files added to the staging area, the next step is to add them to the
permanent version history. In Git, this process is called a **commit**. Use the
`commit` command.
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git commit file1.txt file2.txt file3.txt <span class="nt">-m</span> <span class="s2">"First commit"</span></code></pre></figure>
The `commit` command adds files in the staging area to the repository. Each
commit requires a message that is intended to describe the changes that took
place. This can be done in the command line by using `-m` followed by the
message in quotation marks. If this is omitted, Git defaults to a text editor
where users can type the message. The `commit` command is completed when the
user saves the message and exits the editor.
If you opt to not specify the filenames for the commit, git will commit all the
files in the staging area.
Because all the files in the staging area were committed in the last command,
there are all removed from the staging area. You can check with `git status`.
The version history is in essence a list of commits. To view the complete
history of the project, use:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git log</code></pre></figure>
This outputs a list of all the commits, when they were made, the author, the
commit messages, and other information. The string at the top of seemingly
random letters is an encrypted hash of the changes that were made. A hash is a
string that encodes data and is produced by a hash function. Ideally, a hash
function is implemented such that a small change in the data it encodes results
in a large, unpredictable change in the hash. This enables users to check the
file's integrity and makes it exceedingly difficult to alter the commit
history.
<!--
<a href="/assets/img/tutorials/git-tutorial-5.png">
<img src="/assets/img/tutorials/git-tutorial-5.png" class="img-responsive">
</a>
-->
#### <a name="undo"></a>(Optional) Undo a Commit
If you ever commit something and wish to revert your changes, use the `reset`
command. There are several options. The first is:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git reset <span class="nt">--hard</span> HEAD~1</code></pre></figure>
This command erases **everything** that was altered after the previous commit
and sets the working tree to the previous commit. The `--hard` induces the
erasure, and `HEAD~1` moves to the previous commit. `HEAD` is a pointer that
Git uses to point to a specific commit in a branch. `HEAD` by default points to
the latest commit, so to access previous ones, use `~X` where X is the number
of commits ago you want to go.
Be very careful when using `--hard`.
The second option:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git reset <span class="nt">--mixed</span> HEAD~1</code></pre></figure>
-OR-
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git reset HEAD~1</code></pre></figure>
This file preserves the changes made but reverts the HEAD pointer back one
commit. The changes are unstaged, so the working directory matches the previous
commit.
The last option:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git reset <span class="nt">--soft</span> HEAD~1</code></pre></figure>
The only change is that the most recent commit is reversed. The staging area is
the same; it reflects the changes that have been made between the commit to be
erased and its predecessor. This option exactly reverses the effects of a `git
commit` command.
The following assumes that the commit has not been reversed. All three files
are committed in the repository.
#### <a name="branch"></a>Branching Repositories
Now that a commit has been made, branch off and create a new working tree.
Currently, HEAD points to the last commit of the original branch, called
`master`. This is the default name for a new git repository. It is generally
best practice to branch off of master to make changes and then merge changes
back to master once they have been thoroughly audited. That way, whatever code
is in the master branch is guaranteed to work.
Create a branch called `testing`:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git branch testing</code></pre></figure>
This creates a new branch called `testing`. By default, it copies the state
pointed to by HEAD, but it is possible to branch off of previous commits. To
list the available branches, use `git branch`. To switch to the newly created
branch, use:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git checkout testing</code></pre></figure>
Now, HEAD is pointing to `testing` instead of `master`. Any commits made will
be applied to `testing` as long as it is checked out.
<!--
<a href="/assets/img/tutorials/git-tutorial-6.png">
<img src="/assets/img/tutorials/git-tutorial-6.png" class="img-responsive">
</a>
-->
#### <a name="commitbranch"></a>Commiting Branches
Change the current files. This command will add text to the files saying, "This
is <filename>". You can use `more <filename>` or `cat <filename>` to output the
contents of a file into the terminal.
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>find <span class="nb">.</span> <span class="nt">-maxdepth</span> 1 <span class="nt">-type</span> f | xargs <span class="nt">-I</span> <span class="o">{}</span> bash <span class="nt">-c</span> <span class="s2">"echo 'This is '{} &gt; {}"</span></code></pre></figure>
Now that the files have been altered, run `git status` to see what Git has
noticed. Stage the changes and commit them:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git add <span class="nb">.</span>
<span class="nv">$ </span>git commit <span class="nb">.</span> <span class="nt">-m</span> <span class="s2">"First Branch Commit"</span></code></pre></figure>
The `.` operator causes commands to affect all files in a directory. Using it
is easier than typing individual file names.
<!--
<a href="/assets/img/tutorials/git-tutorial-7.png">
<img src="/assets/img/tutorials/git-tutorial-7.png" class="img-responsive">
</a>
-->
#### <a name="compare"></a>Comparing Branches
Now that `master` and `testing` differ with one another, switch between them to
see the differences.
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span><span class="nb">ls</span> | xargs <span class="nb">cat</span>
<span class="nv">$ </span>git checkout master
<span class="nv">$ </span><span class="nb">ls</span> | xargs <span class="nb">cat</span></code></pre></figure>
Individually looking through files in different branches can be cumbersome. To
output the differences directly, use the `diff` command.
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git diff master testing</code></pre></figure>
The output should look like:
<!--
<a href="/assets/img/tutorials/git-tutorial-8.png">
<img src="/assets/img/tutorials/git-tutorial-8.png" class="img-responsive">
</a>
-->
#### <a name="merge"></a>Merging Branches
Now, merge the changes in `testing` to `master`. Check out the `master` branch
and use the `merge` command.
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git checkout master
<span class="nv">$ </span>git merge testing</code></pre></figure>
You will see an output that summarizes the changes. The `merge` command creates
a new commit that follows the previous version of `master`.
<!--
<a href="/assets/img/tutorials/git-tutorial-9.png">
<img src="/assets/img/tutorials/git-tutorial-9.png" class="img-responsive">
</a>
-->
If the merge is successful, there is no need for the `testing` branch. Delete
it. Make sure that the `testing` branch isn't currently checked out.
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git branch <span class="nt">-d</span> testing</code></pre></figure>
### <a name="rrepos"></a>Using Remote Repositories
Remote repositories refer to storage locations outside a user's local
repository. The remote in this example is GitHub, and the repository we'll be
using is for the <a href="https://github.com/rtxi/plugin-template">plugin
template</a>. If you want to have your own remote repository on GitHub, you
will need to create an account with them and using their website to initialize
the repository.
#### <a name="clone"></a>Cloning a GitHub Repository
The format for cloning repositories from GitHub is:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git clone https://github.com/&lt;username&gt;/&lt;repository-name&gt;.git</code></pre></figure>
To clone from our repositories, the username is `rtxi` and the repositories are
all listed on https://github.com/rtxi. To install the plugin template:
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span><span class="nb">cd</span> ~/ <span class="c"># this line isn't really needed</span>
<span class="nv">$ </span>git clone https://github.com/rtxi/plugin-template.git
<span class="nv">$ </span><span class="nb">cd </span>plugin-template</code></pre></figure>
In addition to the files copied from GitHub, Git stores the address of the
remote repository. By default, the name is `origin`. See details on remote
repositories with `git remote -v`.
#### <a name="push"></a>Pushing to a Remote
Make some changes to the directory. Add some files, edit them, etc. Then, stage
and commit them.
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span><span class="nb">touch </span>file1 file2 file3
<span class="nv">$ </span>git add <span class="nb">.</span>
<span class="nv">$ </span>git commit <span class="nb">.</span> <span class="s2">"Local commit to push to remote repository"</span></code></pre></figure>
**Note:** You will not actually be able to execute the command below
successfully. We don't allow everyone to push to our repositories. This is what
you'd do, though, if you could.
Now, send these changes to the remote. The command Git uses for this is `push`.
<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git push https://github.com/&lt;username&gt;/plugin-template.git master <span class="c"># will fail</span></code></pre></figure>
Git pushes the changes to the master branch of the remote repository referenced
by the URL. Git also supports aliases for remote URLs. By default, the URL from
which you clone a repository is saved as `origin`. You can view the remotes
tracked by a repository by running `git remote -v`.
#### <a name="pull"></a>Pulling Changes from a Remote
Just as one can push changes from a local machine to a remote, it is possible
to 'pull' changes back from the remote to the local machine. This comes into
play when modifying the same project on several machines or by several people.
To pull the code and automatically merge the differences, use: