[skip ci] Updates

Author: scott-huberty

_sources/contributing.rst.txt

@@ -31,7 +31,7 @@ following command from the root of the package:
 
 .. code-block:: bash
 
-    $ ruff check eyelinkio
+    $ ruff check src/eyelinkio
 
 To build the docs:
 

_sources/index.rst.txt

@@ -5,8 +5,7 @@ A lightweight library to import SR Research EDF files into Python.
 
 .. important::
    **This Software is pre-alpha, meaning it is currently being developed**: Changes to the
-   API (function names, etc.) may occur without warning. This library has been tested with
-   MacOS and Linux, but not Windows.
+   API (function names, etc.) may occur without warning.
 
 About the EyeLink Data Format
 =============================
@@ -15,8 +14,10 @@ The EyeLink Data Format (EDF; not to be confused with the
 `European Data Format <https://www.edfplus.info>`_) is used for storing eyetracking data
 from EyeLink eyetrackers. It was put forward by the company
 `SR Research <https://www.sr-research.com>`_. SR Research EDF files store data in a
-binary format, and reading these files currently requires the `eyelink-edfapi` C
-library that is included in the Eyelink Software Developers Kit.
+binary format, and reading these files currently relies on the `eyelink-edfapi` C
+library that is included in the Eyelink Developers Kit. EyeLinkIO includes
+the binary files necessary to read EDF files, so the end-user does not need to install
+the Eyelink Software Developers Kit to use EyeLinkIO.
 
 Dependencies
 ============

_sources/usage.rst.txt

@@ -3,11 +3,6 @@
 User Guide
 ==========
 
-.. important::
-   - You must have the `EyeLink Software Development Kit <https://www.sr-research.com/support/forum-3.html>`_ installed on your computer
-   - You must register an account on the forum to access the download (registration is free)
-
-
 Installation
 ------------
 
@@ -44,9 +39,12 @@ For contributors to EyeLinkIO:
    pip install --editable ./eyelinkio
 
 .. important::
+
+   To install the package in editable mode, you must:
+
    - Fork the repository on GitHub first.
    - Clone your forked repository to your computer.
-   - Make sure you're in the directory *containing* the cloned ``eyelinkio`` folder when you run the command above.
+   - Make sure you're in the directory *containing* the cloned ``eyelinkio`` folder when you run the command provided above.
 
 Example Usage
 -------------
@@ -133,4 +131,31 @@ You can convert an instance of EDF to a pandas DataFrame or an MNE Raw instance
 
 .. seealso::
 
-   `Working with eyetracking data in MNE <https://mne.tools/stable/auto_tutorials/preprocessing/90_eyetracking_data.html>`_
+   `Working with eyetracking data in MNE <https://mne.tools/stable/auto_tutorials/preprocessing/90_eyetracking_data.html>`_
+
+
+Using the EDF API Library installed on your system
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you have the EDF API Library installed on your system, you can explicitly direct
+EyeLinkIO to rely on it when reading your EDF files. This can be done by setting the
+``EYELINKIO_USE_INSTALLED_EDFAPI`` parameter to ``true`` before importing EyeLinkIO.
+
+.. code:: python
+
+   import os
+   os.environ["EYELINKIO_USE_INSTALLED_EDFAPI"] = "true"
+
+   from eyelinkio.io import read_edf
+
+   fname = _get_test_fnames()[0]  # Replace this function with the path to your EDF file
+   edf_file = read_edf(fname)
+   print(edf_file)
+
+Otherwise, EyeLinkIO will rely on the EDF API Library that comes with the package.
+
+.. note::
+
+   If you want to install the EyeLink Developers Kit, you can download it from the
+   `SR Research website <https://www.sr-research.com/support/forum-3.html>`_. You will
+   need to register an account to access the download page (registration is free).

contributing.html

@@ -367,7 +367,7 @@ <h2>Running the tests<a class="headerlink" href="#running-the-tests" title="Link
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pytest
 </pre></div>
 </div>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>ruff<span class="w"> </span>check<span class="w"> </span>eyelinkio
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>ruff<span class="w"> </span>check<span class="w"> </span>src/eyelinkio
 </pre></div>
 </div>
 <p>To build the docs:</p>

index.html

@@ -318,8 +318,7 @@ <h1>EyeLinkIO<a class="headerlink" href="#eyelinkio" title="Link to this heading
 <div class="admonition important">
 <p class="admonition-title">Important</p>
 <p><strong>This Software is pre-alpha, meaning it is currently being developed</strong>: Changes to the
-API (function names, etc.) may occur without warning. This library has been tested with
-MacOS and Linux, but not Windows.</p>
+API (function names, etc.) may occur without warning.</p>
 </div>
 </section>
 <section id="about-the-eyelink-data-format">
@@ -328,8 +327,10 @@ <h1>About the EyeLink Data Format<a class="headerlink" href="#about-the-eyelink-
 <a class="reference external" href="https://www.edfplus.info">European Data Format</a>) is used for storing eyetracking data
 from EyeLink eyetrackers. It was put forward by the company
 <a class="reference external" href="https://www.sr-research.com">SR Research</a>. SR Research EDF files store data in a
-binary format, and reading these files currently requires the <cite>eyelink-edfapi</cite> C
-library that is included in the Eyelink Software Developers Kit.</p>
+binary format, and reading these files currently relies on the <cite>eyelink-edfapi</cite> C
+library that is included in the Eyelink Developers Kit. EyeLinkIO includes
+the binary files necessary to read EDF files, so the end-user does not need to install
+the Eyelink Software Developers Kit to use EyeLinkIO.</p>
 </section>
 <section id="dependencies">
 <h1>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading">#</a></h1>

searchindex.js

@@ -346,13 +346,6 @@
 
   <section id="user-guide">
 <span id="id1"></span><h1>User Guide<a class="headerlink" href="#user-guide" title="Link to this heading">#</a></h1>
-<div class="admonition important">
-<p class="admonition-title">Important</p>
-<ul class="simple">
-<li><p>You must have the <a class="reference external" href="https://www.sr-research.com/support/forum-3.html">EyeLink Software Development Kit</a> installed on your computer</p></li>
-<li><p>You must register an account on the forum to access the download (registration is free)</p></li>
-</ul>
-</div>
 <section id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">#</a></h2>
 <div class="admonition note">
@@ -381,10 +374,11 @@ <h3>3. <strong>Development Installation</strong> (Dynamic)<a class="headerlink"
 </div>
 <div class="admonition important">
 <p class="admonition-title">Important</p>
+<p>To install the package in editable mode, you must:</p>
 <ul class="simple">
 <li><p>Fork the repository on GitHub first.</p></li>
 <li><p>Clone your forked repository to your computer.</p></li>
-<li><p>Make sure you’re in the directory <em>containing</em> the cloned <code class="docutils literal notranslate"><span class="pre">eyelinkio</span></code> folder when you run the command above.</p></li>
+<li><p>Make sure you’re in the directory <em>containing</em> the cloned <code class="docutils literal notranslate"><span class="pre">eyelinkio</span></code> folder when you run the command provided above.</p></li>
 </ul>
 </div>
 </section>
@@ -456,6 +450,29 @@ <h3>Converting to a DataFrame or MNE Raw instance<a class="headerlink" href="#co
 <p><a class="reference external" href="https://mne.tools/stable/auto_tutorials/preprocessing/90_eyetracking_data.html">Working with eyetracking data in MNE</a></p>
 </div>
 </section>
+<section id="using-the-edf-api-library-installed-on-your-system">
+<h3>Using the EDF API Library installed on your system<a class="headerlink" href="#using-the-edf-api-library-installed-on-your-system" title="Link to this heading">#</a></h3>
+<p>If you have the EDF API Library installed on your system, you can explicitly direct
+EyeLinkIO to rely on it when reading your EDF files. This can be done by setting the
+<code class="docutils literal notranslate"><span class="pre">EYELINKIO_USE_INSTALLED_EDFAPI</span></code> parameter to <code class="docutils literal notranslate"><span class="pre">true</span></code> before importing EyeLinkIO.</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
+<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;EYELINKIO_USE_INSTALLED_EDFAPI&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;true&quot;</span>
+
+<span class="kn">from</span> <span class="nn">eyelinkio.io</span> <span class="kn">import</span> <span class="n">read_edf</span>
+
+<span class="n">fname</span> <span class="o">=</span> <span class="n">_get_test_fnames</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>  <span class="c1"># Replace this function with the path to your EDF file</span>
+<span class="n">edf_file</span> <span class="o">=</span> <span class="n">read_edf</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span>
+<span class="nb">print</span><span class="p">(</span><span class="n">edf_file</span><span class="p">)</span>
+</pre></div>
+</div>
+<p>Otherwise, EyeLinkIO will rely on the EDF API Library that comes with the package.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>If you want to install the EyeLink Developers Kit, you can download it from the
+<a class="reference external" href="https://www.sr-research.com/support/forum-3.html">SR Research website</a>. You will
+need to register an account to access the download page (registration is free).</p>
+</div>
+</section>
 </section>
 </section>
 
@@ -516,6 +533,7 @@ <h3>Converting to a DataFrame or MNE Raw instance<a class="headerlink" href="#co
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#reading-an-edf-file">Reading an EDF file</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#inspecting-an-edf-object">Inspecting an EDF object</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#converting-to-a-dataframe-or-mne-raw-instance">Converting to a DataFrame or MNE Raw instance</a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#using-the-edf-api-library-installed-on-your-system">Using the EDF API Library installed on your system</a></li>
 </ul>
 </li>
 </ul>