Merge pull request #63 from arokem/docs_popylar

DOC: Document the fact that we are using popylar/GA for usage tracking.

Author: oesteban

dmriprep/cli/run.py

@@ -221,16 +221,11 @@ def main():
 
     exec_env = os.name
 
-    # special variable set in the container
-    if os.getenv('IS_DOCKER_8395080871'):
-        exec_env = 'singularity'
-        cgroup = Path('/proc/1/cgroup')
-        if cgroup.exists() and 'docker' in cgroup.read_text():
-            exec_env = 'docker'
-            if os.getenv('DOCKER_VERSION_8395080871'):
-                exec_env = 'dmriprep-docker'
-
     if not opts.notrack:
+        logger.info(
+            "Your usage of dmriprep is being recorded using popylar (https://popylar.github.io/). ",  # noqa
+            "For details, see https://nipreps.github.io/dmriprep/usage.html. ",
+            "To opt out, call dmriprep with a `--notrack` flag")
         import popylar
         popylar.track_event(__ga_id__, 'run', 'cli_run')
 

docs/usage.rst

@@ -41,10 +41,10 @@ The FreeSurfer license
 To obtain a FreeSurfer license, simply register for free at
 https://surfer.nmr.mgh.harvard.edu/registration.html.
 
-When using manually-prepared environments or Singularity, FreeSurfer will search 
-for a license key file first using the ``$FS_LICENSE`` environment variable and then 
-in the default path to the license key file (``$FREESURFER_HOME/license.txt``). 
-If using the ``--cleanenv`` flag and ``$FS_LICENSE`` is set, use ``--fs-license-file $FS_LICENSE`` 
+When using manually-prepared environments or Singularity, FreeSurfer will search
+for a license key file first using the ``$FS_LICENSE`` environment variable and then
+in the default path to the license key file (``$FREESURFER_HOME/license.txt``).
+If using the ``--cleanenv`` flag and ``$FS_LICENSE`` is set, use ``--fs-license-file $FS_LICENSE``
 to pass the license file location to *dMRIPrep*.
 
 It is possible to run the Docker container pointing the image to a local path
@@ -60,3 +60,24 @@ file on the host system: ::
         /data /out/out \
         participant \
         --ignore fieldmaps
+
+
+Usage tracking with Google Analytics
+------------------------------------
+To be able to assess usage of the software, we are recording each use of the
+:abbr:`CLI (command-line interface)` as an event in Google Analytics,
+using `popylar <https://popylar.github.io>`__.
+``
+
+For now, the only information that we are recording is the fact that the CLI was
+called and whether the call completed successfully. In addition, through Google
+Analytics, we will have access to very general information, such as the country
+and city in which the computer using the CLI was located and the time that it
+was used. At this time, we do not record any additional information, although in
+the future we may want to record statistics on the computational environment in
+which the CLI was called, such as the operating system.
+
+Opting out of this usage tracking can be done by calling the CLI with the
+``--notrack`` flag::
+
+    dmriprep data/bids_root/ out/ participant -w work/ --notrack